From 7d67614fdc5c645054afd09a3ea216d32252366d Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Tue, 30 Apr 2024 18:08:11 +0000 Subject: [PATCH] Update models for release --- .changes/3.305.6 | 57 + CHANGELOG.md | 14 + .../PinpointSMSVoiceV2Client.php | 26 + src/QuickSight/QuickSightClient.php | 2 + .../chime-sdk-voice/2022-08-03/api-2.json | 8 +- .../chime-sdk-voice/2022-08-03/api-2.json.php | 2 +- .../chime-sdk-voice/2022-08-03/docs-2.json | 12 +- .../2022-08-03/docs-2.json.php | 2 +- .../2022-08-03/endpoint-rule-set-1.json | 64 +- .../2022-08-03/endpoint-rule-set-1.json.php | 2 +- src/data/codeartifact/2018-09-22/api-2.json | 1 + .../codeartifact/2018-09-22/api-2.json.php | 2 +- src/data/codeartifact/2018-09-22/docs-2.json | 52 +- .../codeartifact/2018-09-22/docs-2.json.php | 2 +- src/data/fms/2018-01-01/api-2.json | 12 +- src/data/fms/2018-01-01/api-2.json.php | 2 +- src/data/fms/2018-01-01/docs-2.json | 12 +- src/data/fms/2018-01-01/docs-2.json.php | 2 +- src/data/omics/2022-11-28/api-2.json | 51 +- src/data/omics/2022-11-28/api-2.json.php | 2 +- src/data/omics/2022-11-28/docs-2.json | 125 +- src/data/omics/2022-11-28/docs-2.json.php | 2 +- src/data/opensearch/2021-01-01/api-2.json | 2 + src/data/opensearch/2021-01-01/api-2.json.php | 2 +- src/data/opensearch/2021-01-01/docs-2.json | 10 +- .../opensearch/2021-01-01/docs-2.json.php | 2 +- .../2022-03-31/api-2.json | 668 +- .../2022-03-31/api-2.json.php | 2 +- .../2022-03-31/docs-2.json | 321 +- .../2022-03-31/docs-2.json.php | 2 +- .../2022-03-31/paginators-1.json | 6 + .../2022-03-31/paginators-1.json.php | 2 +- src/data/qbusiness/2023-11-27/api-2.json | 11605 ++++++++++------ src/data/qbusiness/2023-11-27/api-2.json.php | 2 +- src/data/qbusiness/2023-11-27/docs-2.json | 307 +- src/data/qbusiness/2023-11-27/docs-2.json.php | 2 +- src/data/qbusiness/2023-11-27/smoke.json | 6 + src/data/qbusiness/2023-11-27/smoke.json.php | 3 + src/data/qbusiness/2023-11-27/waiters-2.json | 5 + .../qbusiness/2023-11-27/waiters-2.json.php | 3 + src/data/quicksight/2018-04-01/api-2.json | 99 +- src/data/quicksight/2018-04-01/api-2.json.php | 2 +- src/data/quicksight/2018-04-01/docs-2.json | 66 +- .../quicksight/2018-04-01/docs-2.json.php | 2 +- .../route53resolver/2018-04-01/api-2.json | 17 + .../route53resolver/2018-04-01/api-2.json.php | 2 +- .../route53resolver/2018-04-01/docs-2.json | 20 +- .../2018-04-01/docs-2.json.php | 2 +- src/data/sagemaker/2017-07-24/api-2.json | 19 +- src/data/sagemaker/2017-07-24/api-2.json.php | 2 +- src/data/sagemaker/2017-07-24/docs-2.json | 12 + src/data/sagemaker/2017-07-24/docs-2.json.php | 2 +- src/data/signer/2017-08-25/api-2.json | 1 + src/data/signer/2017-08-25/api-2.json.php | 2 +- src/data/signer/2017-08-25/docs-2.json | 4 +- src/data/signer/2017-08-25/docs-2.json.php | 2 +- 56 files changed, 8835 insertions(+), 4823 deletions(-) create mode 100644 .changes/3.305.6 create mode 100644 src/data/qbusiness/2023-11-27/smoke.json create mode 100644 src/data/qbusiness/2023-11-27/smoke.json.php create mode 100644 src/data/qbusiness/2023-11-27/waiters-2.json create mode 100644 src/data/qbusiness/2023-11-27/waiters-2.json.php diff --git a/.changes/3.305.6 b/.changes/3.305.6 new file mode 100644 index 0000000000..4839189190 --- /dev/null +++ b/.changes/3.305.6 @@ -0,0 +1,57 @@ +[ + { + "type": "api-change", + "category": "QuickSight", + "description": "New Q embedding supporting Generative Q&A" + }, + { + "type": "api-change", + "category": "OpenSearchService", + "description": "This release enables customers to create Route53 A and AAAA alias record types to point custom endpoint domain to OpenSearch domain's dualstack search endpoint." + }, + { + "type": "api-change", + "category": "ChimeSDKVoice", + "description": "Due to changes made by the Amazon Alexa service, GetSipMediaApplicationAlexaSkillConfiguration and PutSipMediaApplicationAlexaSkillConfiguration APIs are no longer available for use. For more information, refer to the Alexa Smart Properties page." + }, + { + "type": "enhancement", + "category": "signer", + "description": "Documentation updates for AWS Signer. Adds cross-account signing constraint and definitions for cross-account actions." + }, + { + "type": "api-change", + "category": "PinpointSMSVoiceV2", + "description": "Amazon Pinpoint has added two new features Multimedia services (MMS) and protect configurations. Use the three new MMS APIs to send media messages to a mobile phone which includes image, audio, text, or video files. Use the ten new protect configurations APIs to block messages to specific countries." + }, + { + "type": "api-change", + "category": "Route53Resolver", + "description": "Release of FirewallDomainRedirectionAction parameter on the Route 53 DNS Firewall Rule. This allows customers to configure a DNS Firewall rule to inspect all the domains in the DNS redirection chain (default) , such as CNAME, ALIAS, DNAME, etc., or just the first domain and trust the rest." + }, + { + "type": "api-change", + "category": "QBusiness", + "description": "This is a general availability (GA) release of Amazon Q Business. Q Business enables employees in an enterprise to get comprehensive answers to complex questions and take actions through a unified, intuitive web-based chat experience - using an enterprise's existing content, data, and systems." + }, + { + "type": "api-change", + "category": "FMS", + "description": "AWS Firewall Manager now supports the network firewall service stream exception policy feature for accounts within your organization." + }, + { + "type": "api-change", + "category": "CodeArtifact", + "description": "Add support for the Ruby package format." + }, + { + "type": "api-change", + "category": "Omics", + "description": "Add support for workflow sharing and dynamic run storage" + }, + { + "type": "api-change", + "category": "SageMaker", + "description": "Amazon SageMaker Training now supports the use of attribute-based access control (ABAC) roles for training job execution roles. Amazon SageMaker Inference now supports G6 instance types." + } +] diff --git a/CHANGELOG.md b/CHANGELOG.md index f118e213dc..d329eb7de8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # CHANGELOG +## next release + +* `Aws\QuickSight` - New Q embedding supporting Generative Q&A +* `Aws\OpenSearchService` - This release enables customers to create Route53 A and AAAA alias record types to point custom endpoint domain to OpenSearch domain's dualstack search endpoint. +* `Aws\ChimeSDKVoice` - Due to changes made by the Amazon Alexa service, GetSipMediaApplicationAlexaSkillConfiguration and PutSipMediaApplicationAlexaSkillConfiguration APIs are no longer available for use. For more information, refer to the Alexa Smart Properties page. +* `Aws\signer` - Documentation updates for AWS Signer. Adds cross-account signing constraint and definitions for cross-account actions. +* `Aws\PinpointSMSVoiceV2` - Amazon Pinpoint has added two new features Multimedia services (MMS) and protect configurations. Use the three new MMS APIs to send media messages to a mobile phone which includes image, audio, text, or video files. Use the ten new protect configurations APIs to block messages to specific countries. +* `Aws\Route53Resolver` - Release of FirewallDomainRedirectionAction parameter on the Route 53 DNS Firewall Rule. This allows customers to configure a DNS Firewall rule to inspect all the domains in the DNS redirection chain (default) , such as CNAME, ALIAS, DNAME, etc., or just the first domain and trust the rest. +* `Aws\QBusiness` - This is a general availability (GA) release of Amazon Q Business. Q Business enables employees in an enterprise to get comprehensive answers to complex questions and take actions through a unified, intuitive web-based chat experience - using an enterprise's existing content, data, and systems. +* `Aws\FMS` - AWS Firewall Manager now supports the network firewall service stream exception policy feature for accounts within your organization. +* `Aws\CodeArtifact` - Add support for the Ruby package format. +* `Aws\Omics` - Add support for workflow sharing and dynamic run storage +* `Aws\SageMaker` - Amazon SageMaker Training now supports the use of attribute-based access control (ABAC) roles for training job execution roles. Amazon SageMaker Inference now supports G6 instance types. + ## 3.305.5 - 2024-04-29 * `Aws\ConnectCases` - This feature releases DeleteField, DeletedLayout, and DeleteTemplate API's diff --git a/src/PinpointSMSVoiceV2/PinpointSMSVoiceV2Client.php b/src/PinpointSMSVoiceV2/PinpointSMSVoiceV2Client.php index f594ef4f62..54090c72f0 100644 --- a/src/PinpointSMSVoiceV2/PinpointSMSVoiceV2Client.php +++ b/src/PinpointSMSVoiceV2/PinpointSMSVoiceV2Client.php @@ -7,6 +7,8 @@ * This client is used to interact with the **Amazon Pinpoint SMS Voice V2** service. * @method \Aws\Result associateOriginationIdentity(array $args = []) * @method \GuzzleHttp\Promise\Promise associateOriginationIdentityAsync(array $args = []) + * @method \Aws\Result associateProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise associateProtectConfigurationAsync(array $args = []) * @method \Aws\Result createConfigurationSet(array $args = []) * @method \GuzzleHttp\Promise\Promise createConfigurationSetAsync(array $args = []) * @method \Aws\Result createEventDestination(array $args = []) @@ -15,6 +17,8 @@ * @method \GuzzleHttp\Promise\Promise createOptOutListAsync(array $args = []) * @method \Aws\Result createPool(array $args = []) * @method \GuzzleHttp\Promise\Promise createPoolAsync(array $args = []) + * @method \Aws\Result createProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise createProtectConfigurationAsync(array $args = []) * @method \Aws\Result createRegistration(array $args = []) * @method \GuzzleHttp\Promise\Promise createRegistrationAsync(array $args = []) * @method \Aws\Result createRegistrationAssociation(array $args = []) @@ -25,6 +29,8 @@ * @method \GuzzleHttp\Promise\Promise createRegistrationVersionAsync(array $args = []) * @method \Aws\Result createVerifiedDestinationNumber(array $args = []) * @method \GuzzleHttp\Promise\Promise createVerifiedDestinationNumberAsync(array $args = []) + * @method \Aws\Result deleteAccountDefaultProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise deleteAccountDefaultProtectConfigurationAsync(array $args = []) * @method \Aws\Result deleteConfigurationSet(array $args = []) * @method \GuzzleHttp\Promise\Promise deleteConfigurationSetAsync(array $args = []) * @method \Aws\Result deleteDefaultMessageType(array $args = []) @@ -35,12 +41,16 @@ * @method \GuzzleHttp\Promise\Promise deleteEventDestinationAsync(array $args = []) * @method \Aws\Result deleteKeyword(array $args = []) * @method \GuzzleHttp\Promise\Promise deleteKeywordAsync(array $args = []) + * @method \Aws\Result deleteMediaMessageSpendLimitOverride(array $args = []) + * @method \GuzzleHttp\Promise\Promise deleteMediaMessageSpendLimitOverrideAsync(array $args = []) * @method \Aws\Result deleteOptOutList(array $args = []) * @method \GuzzleHttp\Promise\Promise deleteOptOutListAsync(array $args = []) * @method \Aws\Result deleteOptedOutNumber(array $args = []) * @method \GuzzleHttp\Promise\Promise deleteOptedOutNumberAsync(array $args = []) * @method \Aws\Result deletePool(array $args = []) * @method \GuzzleHttp\Promise\Promise deletePoolAsync(array $args = []) + * @method \Aws\Result deleteProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise deleteProtectConfigurationAsync(array $args = []) * @method \Aws\Result deleteRegistration(array $args = []) * @method \GuzzleHttp\Promise\Promise deleteRegistrationAsync(array $args = []) * @method \Aws\Result deleteRegistrationAttachment(array $args = []) @@ -69,6 +79,8 @@ * @method \GuzzleHttp\Promise\Promise describePhoneNumbersAsync(array $args = []) * @method \Aws\Result describePools(array $args = []) * @method \GuzzleHttp\Promise\Promise describePoolsAsync(array $args = []) + * @method \Aws\Result describeProtectConfigurations(array $args = []) + * @method \GuzzleHttp\Promise\Promise describeProtectConfigurationsAsync(array $args = []) * @method \Aws\Result describeRegistrationAttachments(array $args = []) * @method \GuzzleHttp\Promise\Promise describeRegistrationAttachmentsAsync(array $args = []) * @method \Aws\Result describeRegistrationFieldDefinitions(array $args = []) @@ -91,8 +103,12 @@ * @method \GuzzleHttp\Promise\Promise describeVerifiedDestinationNumbersAsync(array $args = []) * @method \Aws\Result disassociateOriginationIdentity(array $args = []) * @method \GuzzleHttp\Promise\Promise disassociateOriginationIdentityAsync(array $args = []) + * @method \Aws\Result disassociateProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise disassociateProtectConfigurationAsync(array $args = []) * @method \Aws\Result discardRegistrationVersion(array $args = []) * @method \GuzzleHttp\Promise\Promise discardRegistrationVersionAsync(array $args = []) + * @method \Aws\Result getProtectConfigurationCountryRuleSet(array $args = []) + * @method \GuzzleHttp\Promise\Promise getProtectConfigurationCountryRuleSetAsync(array $args = []) * @method \Aws\Result listPoolOriginationIdentities(array $args = []) * @method \GuzzleHttp\Promise\Promise listPoolOriginationIdentitiesAsync(array $args = []) * @method \Aws\Result listRegistrationAssociations(array $args = []) @@ -115,14 +131,20 @@ * @method \GuzzleHttp\Promise\Promise requestSenderIdAsync(array $args = []) * @method \Aws\Result sendDestinationNumberVerificationCode(array $args = []) * @method \GuzzleHttp\Promise\Promise sendDestinationNumberVerificationCodeAsync(array $args = []) + * @method \Aws\Result sendMediaMessage(array $args = []) + * @method \GuzzleHttp\Promise\Promise sendMediaMessageAsync(array $args = []) * @method \Aws\Result sendTextMessage(array $args = []) * @method \GuzzleHttp\Promise\Promise sendTextMessageAsync(array $args = []) * @method \Aws\Result sendVoiceMessage(array $args = []) * @method \GuzzleHttp\Promise\Promise sendVoiceMessageAsync(array $args = []) + * @method \Aws\Result setAccountDefaultProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise setAccountDefaultProtectConfigurationAsync(array $args = []) * @method \Aws\Result setDefaultMessageType(array $args = []) * @method \GuzzleHttp\Promise\Promise setDefaultMessageTypeAsync(array $args = []) * @method \Aws\Result setDefaultSenderId(array $args = []) * @method \GuzzleHttp\Promise\Promise setDefaultSenderIdAsync(array $args = []) + * @method \Aws\Result setMediaMessageSpendLimitOverride(array $args = []) + * @method \GuzzleHttp\Promise\Promise setMediaMessageSpendLimitOverrideAsync(array $args = []) * @method \Aws\Result setTextMessageSpendLimitOverride(array $args = []) * @method \GuzzleHttp\Promise\Promise setTextMessageSpendLimitOverrideAsync(array $args = []) * @method \Aws\Result setVoiceMessageSpendLimitOverride(array $args = []) @@ -139,6 +161,10 @@ * @method \GuzzleHttp\Promise\Promise updatePhoneNumberAsync(array $args = []) * @method \Aws\Result updatePool(array $args = []) * @method \GuzzleHttp\Promise\Promise updatePoolAsync(array $args = []) + * @method \Aws\Result updateProtectConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateProtectConfigurationAsync(array $args = []) + * @method \Aws\Result updateProtectConfigurationCountryRuleSet(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateProtectConfigurationCountryRuleSetAsync(array $args = []) * @method \Aws\Result updateSenderId(array $args = []) * @method \GuzzleHttp\Promise\Promise updateSenderIdAsync(array $args = []) * @method \Aws\Result verifyDestinationNumber(array $args = []) diff --git a/src/QuickSight/QuickSightClient.php b/src/QuickSight/QuickSightClient.php index 74dbb025c8..fb70201663 100644 --- a/src/QuickSight/QuickSightClient.php +++ b/src/QuickSight/QuickSightClient.php @@ -325,6 +325,8 @@ * @method \GuzzleHttp\Promise\Promise updateRefreshScheduleAsync(array $args = []) * @method \Aws\Result updateRoleCustomPermission(array $args = []) * @method \GuzzleHttp\Promise\Promise updateRoleCustomPermissionAsync(array $args = []) + * @method \Aws\Result updateSPICECapacityConfiguration(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateSPICECapacityConfigurationAsync(array $args = []) * @method \Aws\Result updateTemplate(array $args = []) * @method \GuzzleHttp\Promise\Promise updateTemplateAsync(array $args = []) * @method \Aws\Result updateTemplateAlias(array $args = []) diff --git a/src/data/chime-sdk-voice/2022-08-03/api-2.json b/src/data/chime-sdk-voice/2022-08-03/api-2.json index 4cf682946e..5a2945851a 100644 --- a/src/data/chime-sdk-voice/2022-08-03/api-2.json +++ b/src/data/chime-sdk-voice/2022-08-03/api-2.json @@ -698,7 +698,9 @@ {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} - ] + ], + "deprecated":true, + "deprecatedMessage":"Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties)." }, "GetSipMediaApplicationLoggingConfiguration":{ "name":"GetSipMediaApplicationLoggingConfiguration", @@ -1245,7 +1247,9 @@ {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} - ] + ], + "deprecated":true, + "deprecatedMessage":"Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties)." }, "PutSipMediaApplicationLoggingConfiguration":{ "name":"PutSipMediaApplicationLoggingConfiguration", diff --git a/src/data/chime-sdk-voice/2022-08-03/api-2.json.php b/src/data/chime-sdk-voice/2022-08-03/api-2.json.php index f9074113e9..91c2a4e31b 100644 --- a/src/data/chime-sdk-voice/2022-08-03/api-2.json.php +++ b/src/data/chime-sdk-voice/2022-08-03/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2022-08-03', 'endpointPrefix' => 'voice-chime', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon Chime SDK Voice', 'serviceId' => 'Chime SDK Voice', 'signatureVersion' => 'v4', 'signingName' => 'chime', 'uid' => 'chime-sdk-voice-2022-08-03', ], 'operations' => [ 'AssociatePhoneNumbersWithVoiceConnector' => [ 'name' => 'AssociatePhoneNumbersWithVoiceConnector', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorRequest', ], 'output' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorGroup' => [ 'name' => 'AssociatePhoneNumbersWithVoiceConnectorGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'BatchDeletePhoneNumber' => [ 'name' => 'BatchDeletePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers?operation=batch-delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchDeletePhoneNumberRequest', ], 'output' => [ 'shape' => 'BatchDeletePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'BatchUpdatePhoneNumber' => [ 'name' => 'BatchUpdatePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers?operation=batch-update', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchUpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'BatchUpdatePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreatePhoneNumberOrder' => [ 'name' => 'CreatePhoneNumberOrder', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number-orders', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreatePhoneNumberOrderRequest', ], 'output' => [ 'shape' => 'CreatePhoneNumberOrderResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateProxySession' => [ 'name' => 'CreateProxySession', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateProxySessionRequest', ], 'output' => [ 'shape' => 'CreateProxySessionResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateSipMediaApplication' => [ 'name' => 'CreateSipMediaApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-media-applications', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateSipMediaApplicationRequest', ], 'output' => [ 'shape' => 'CreateSipMediaApplicationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateSipMediaApplicationCall' => [ 'name' => 'CreateSipMediaApplicationCall', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/calls', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateSipMediaApplicationCallRequest', ], 'output' => [ 'shape' => 'CreateSipMediaApplicationCallResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateSipRule' => [ 'name' => 'CreateSipRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-rules', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateSipRuleRequest', ], 'output' => [ 'shape' => 'CreateSipRuleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceConnector' => [ 'name' => 'CreateVoiceConnector', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceConnectorRequest', ], 'output' => [ 'shape' => 'CreateVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceConnectorGroup' => [ 'name' => 'CreateVoiceConnectorGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connector-groups', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'CreateVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceProfile' => [ 'name' => 'CreateVoiceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-profiles', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceProfileRequest', ], 'output' => [ 'shape' => 'CreateVoiceProfileResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceProfileDomain' => [ 'name' => 'CreateVoiceProfileDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-profile-domains', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceProfileDomainRequest', ], 'output' => [ 'shape' => 'CreateVoiceProfileDomainResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeletePhoneNumber' => [ 'name' => 'DeletePhoneNumber', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/phone-numbers/{phoneNumberId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeletePhoneNumberRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteProxySession' => [ 'name' => 'DeleteProxySession', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteProxySessionRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteSipMediaApplication' => [ 'name' => 'DeleteSipMediaApplication', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteSipMediaApplicationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteSipRule' => [ 'name' => 'DeleteSipRule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sip-rules/{sipRuleId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteSipRuleRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnector' => [ 'name' => 'DeleteVoiceConnector', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorEmergencyCallingConfiguration' => [ 'name' => 'DeleteVoiceConnectorEmergencyCallingConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/emergency-calling-configuration', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorGroup' => [ 'name' => 'DeleteVoiceConnectorGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorGroupRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorOrigination' => [ 'name' => 'DeleteVoiceConnectorOrigination', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/origination', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorOriginationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorProxy' => [ 'name' => 'DeleteVoiceConnectorProxy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorProxyRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorStreamingConfiguration' => [ 'name' => 'DeleteVoiceConnectorStreamingConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/streaming-configuration', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorStreamingConfigurationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorTermination' => [ 'name' => 'DeleteVoiceConnectorTermination', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorTerminationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorTerminationCredentials' => [ 'name' => 'DeleteVoiceConnectorTerminationCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorTerminationCredentialsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceProfile' => [ 'name' => 'DeleteVoiceProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-profiles/{VoiceProfileId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceProfileRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceProfileDomain' => [ 'name' => 'DeleteVoiceProfileDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-profile-domains/{VoiceProfileDomainId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceProfileDomainRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnector' => [ 'name' => 'DisassociatePhoneNumbersFromVoiceConnector', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorRequest', ], 'output' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroup' => [ 'name' => 'DisassociatePhoneNumbersFromVoiceConnectorGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetGlobalSettings' => [ 'name' => 'GetGlobalSettings', 'http' => [ 'method' => 'GET', 'requestUri' => '/settings', 'responseCode' => 200, ], 'output' => [ 'shape' => 'GetGlobalSettingsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetPhoneNumber' => [ 'name' => 'GetPhoneNumber', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-numbers/{phoneNumberId}', ], 'input' => [ 'shape' => 'GetPhoneNumberRequest', ], 'output' => [ 'shape' => 'GetPhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetPhoneNumberOrder' => [ 'name' => 'GetPhoneNumberOrder', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number-orders/{phoneNumberOrderId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetPhoneNumberOrderRequest', ], 'output' => [ 'shape' => 'GetPhoneNumberOrderResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetPhoneNumberSettings' => [ 'name' => 'GetPhoneNumberSettings', 'http' => [ 'method' => 'GET', 'requestUri' => '/settings/phone-number', 'responseCode' => 200, ], 'output' => [ 'shape' => 'GetPhoneNumberSettingsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetProxySession' => [ 'name' => 'GetProxySession', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetProxySessionRequest', ], 'output' => [ 'shape' => 'GetProxySessionResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipMediaApplication' => [ 'name' => 'GetSipMediaApplication', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipMediaApplicationRequest', ], 'output' => [ 'shape' => 'GetSipMediaApplicationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipMediaApplicationAlexaSkillConfiguration' => [ 'name' => 'GetSipMediaApplicationAlexaSkillConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipMediaApplicationAlexaSkillConfigurationRequest', ], 'output' => [ 'shape' => 'GetSipMediaApplicationAlexaSkillConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipMediaApplicationLoggingConfiguration' => [ 'name' => 'GetSipMediaApplicationLoggingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipMediaApplicationLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'GetSipMediaApplicationLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipRule' => [ 'name' => 'GetSipRule', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-rules/{sipRuleId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipRuleRequest', ], 'output' => [ 'shape' => 'GetSipRuleResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSpeakerSearchTask' => [ 'name' => 'GetSpeakerSearchTask', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSpeakerSearchTaskRequest', ], 'output' => [ 'shape' => 'GetSpeakerSearchTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceFailureException', ], [ 'shape' => 'ServiceUnavailableException', ], ], ], 'GetVoiceConnector' => [ 'name' => 'GetVoiceConnector', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorEmergencyCallingConfiguration' => [ 'name' => 'GetVoiceConnectorEmergencyCallingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/emergency-calling-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorEmergencyCallingConfigurationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorEmergencyCallingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorGroup' => [ 'name' => 'GetVoiceConnectorGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorLoggingConfiguration' => [ 'name' => 'GetVoiceConnectorLoggingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorOrigination' => [ 'name' => 'GetVoiceConnectorOrigination', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/origination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorOriginationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorOriginationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorProxy' => [ 'name' => 'GetVoiceConnectorProxy', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorProxyRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorProxyResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorStreamingConfiguration' => [ 'name' => 'GetVoiceConnectorStreamingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/streaming-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorStreamingConfigurationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorStreamingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorTermination' => [ 'name' => 'GetVoiceConnectorTermination', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorTerminationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorTerminationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorTerminationHealth' => [ 'name' => 'GetVoiceConnectorTerminationHealth', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/health', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorTerminationHealthRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorTerminationHealthResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceProfile' => [ 'name' => 'GetVoiceProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profiles/{VoiceProfileId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceProfileRequest', ], 'output' => [ 'shape' => 'GetVoiceProfileResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceProfileDomain' => [ 'name' => 'GetVoiceProfileDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profile-domains/{VoiceProfileDomainId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceProfileDomainRequest', ], 'output' => [ 'shape' => 'GetVoiceProfileDomainResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceToneAnalysisTask' => [ 'name' => 'GetVoiceToneAnalysisTask', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceToneAnalysisTaskRequest', ], 'output' => [ 'shape' => 'GetVoiceToneAnalysisTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceFailureException', ], [ 'shape' => 'ServiceUnavailableException', ], ], ], 'ListAvailableVoiceConnectorRegions' => [ 'name' => 'ListAvailableVoiceConnectorRegions', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connector-regions', 'responseCode' => 200, ], 'output' => [ 'shape' => 'ListAvailableVoiceConnectorRegionsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListPhoneNumberOrders' => [ 'name' => 'ListPhoneNumberOrders', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number-orders', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListPhoneNumberOrdersRequest', ], 'output' => [ 'shape' => 'ListPhoneNumberOrdersResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListPhoneNumbers' => [ 'name' => 'ListPhoneNumbers', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-numbers', ], 'input' => [ 'shape' => 'ListPhoneNumbersRequest', ], 'output' => [ 'shape' => 'ListPhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListProxySessions' => [ 'name' => 'ListProxySessions', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListProxySessionsRequest', ], 'output' => [ 'shape' => 'ListProxySessionsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListSipMediaApplications' => [ 'name' => 'ListSipMediaApplications', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSipMediaApplicationsRequest', ], 'output' => [ 'shape' => 'ListSipMediaApplicationsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListSipRules' => [ 'name' => 'ListSipRules', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-rules', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSipRulesRequest', ], 'output' => [ 'shape' => 'ListSipRulesResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListSupportedPhoneNumberCountries' => [ 'name' => 'ListSupportedPhoneNumberCountries', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number-countries', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSupportedPhoneNumberCountriesRequest', ], 'output' => [ 'shape' => 'ListSupportedPhoneNumberCountriesResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceConnectorGroups' => [ 'name' => 'ListVoiceConnectorGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connector-groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceConnectorGroupsRequest', ], 'output' => [ 'shape' => 'ListVoiceConnectorGroupsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceConnectorTerminationCredentials' => [ 'name' => 'ListVoiceConnectorTerminationCredentials', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/credentials', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceConnectorTerminationCredentialsRequest', ], 'output' => [ 'shape' => 'ListVoiceConnectorTerminationCredentialsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceConnectors' => [ 'name' => 'ListVoiceConnectors', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceConnectorsRequest', ], 'output' => [ 'shape' => 'ListVoiceConnectorsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceProfileDomains' => [ 'name' => 'ListVoiceProfileDomains', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profile-domains', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceProfileDomainsRequest', ], 'output' => [ 'shape' => 'ListVoiceProfileDomainsResponse', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceProfiles' => [ 'name' => 'ListVoiceProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profiles', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceProfilesRequest', ], 'output' => [ 'shape' => 'ListVoiceProfilesResponse', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutSipMediaApplicationAlexaSkillConfiguration' => [ 'name' => 'PutSipMediaApplicationAlexaSkillConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutSipMediaApplicationAlexaSkillConfigurationRequest', ], 'output' => [ 'shape' => 'PutSipMediaApplicationAlexaSkillConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutSipMediaApplicationLoggingConfiguration' => [ 'name' => 'PutSipMediaApplicationLoggingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutSipMediaApplicationLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'PutSipMediaApplicationLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorEmergencyCallingConfiguration' => [ 'name' => 'PutVoiceConnectorEmergencyCallingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/emergency-calling-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorEmergencyCallingConfigurationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorEmergencyCallingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorLoggingConfiguration' => [ 'name' => 'PutVoiceConnectorLoggingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorOrigination' => [ 'name' => 'PutVoiceConnectorOrigination', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/origination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorOriginationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorOriginationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorProxy' => [ 'name' => 'PutVoiceConnectorProxy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy', ], 'input' => [ 'shape' => 'PutVoiceConnectorProxyRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorProxyResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorStreamingConfiguration' => [ 'name' => 'PutVoiceConnectorStreamingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/streaming-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorStreamingConfigurationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorStreamingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorTermination' => [ 'name' => 'PutVoiceConnectorTermination', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorTerminationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorTerminationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorTerminationCredentials' => [ 'name' => 'PutVoiceConnectorTerminationCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/credentials?operation=put', 'responseCode' => 204, ], 'input' => [ 'shape' => 'PutVoiceConnectorTerminationCredentialsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'RestorePhoneNumber' => [ 'name' => 'RestorePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers/{phoneNumberId}?operation=restore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RestorePhoneNumberRequest', ], 'output' => [ 'shape' => 'RestorePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'SearchAvailablePhoneNumbers' => [ 'name' => 'SearchAvailablePhoneNumbers', 'http' => [ 'method' => 'GET', 'requestUri' => '/search?type=phone-numbers', ], 'input' => [ 'shape' => 'SearchAvailablePhoneNumbersRequest', ], 'output' => [ 'shape' => 'SearchAvailablePhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StartSpeakerSearchTask' => [ 'name' => 'StartSpeakerSearchTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/speaker-search-tasks', 'responseCode' => 201, ], 'input' => [ 'shape' => 'StartSpeakerSearchTaskRequest', ], 'output' => [ 'shape' => 'StartSpeakerSearchTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StartVoiceToneAnalysisTask' => [ 'name' => 'StartVoiceToneAnalysisTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks', 'responseCode' => 201, ], 'input' => [ 'shape' => 'StartVoiceToneAnalysisTaskRequest', ], 'output' => [ 'shape' => 'StartVoiceToneAnalysisTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StopSpeakerSearchTask' => [ 'name' => 'StopSpeakerSearchTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}?operation=stop', 'responseCode' => 204, ], 'input' => [ 'shape' => 'StopSpeakerSearchTaskRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StopVoiceToneAnalysisTask' => [ 'name' => 'StopVoiceToneAnalysisTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}?operation=stop', 'responseCode' => 204, ], 'input' => [ 'shape' => 'StopVoiceToneAnalysisTaskRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags?operation=tag-resource', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags?operation=untag-resource', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateGlobalSettings' => [ 'name' => 'UpdateGlobalSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/settings', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UpdateGlobalSettingsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdatePhoneNumber' => [ 'name' => 'UpdatePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers/{phoneNumberId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'UpdatePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdatePhoneNumberSettings' => [ 'name' => 'UpdatePhoneNumberSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/settings/phone-number', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UpdatePhoneNumberSettingsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateProxySession' => [ 'name' => 'UpdateProxySession', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}', 'responseCode' => 201, ], 'input' => [ 'shape' => 'UpdateProxySessionRequest', ], 'output' => [ 'shape' => 'UpdateProxySessionResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateSipMediaApplication' => [ 'name' => 'UpdateSipMediaApplication', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateSipMediaApplicationRequest', ], 'output' => [ 'shape' => 'UpdateSipMediaApplicationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateSipMediaApplicationCall' => [ 'name' => 'UpdateSipMediaApplicationCall', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/calls/{transactionId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateSipMediaApplicationCallRequest', ], 'output' => [ 'shape' => 'UpdateSipMediaApplicationCallResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateSipRule' => [ 'name' => 'UpdateSipRule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-rules/{sipRuleId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateSipRuleRequest', ], 'output' => [ 'shape' => 'UpdateSipRuleResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceConnector' => [ 'name' => 'UpdateVoiceConnector', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVoiceConnectorRequest', ], 'output' => [ 'shape' => 'UpdateVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceConnectorGroup' => [ 'name' => 'UpdateVoiceConnectorGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'UpdateVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceProfile' => [ 'name' => 'UpdateVoiceProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-profiles/{VoiceProfileId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVoiceProfileRequest', ], 'output' => [ 'shape' => 'UpdateVoiceProfileResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceProfileDomain' => [ 'name' => 'UpdateVoiceProfileDomain', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-profile-domains/{VoiceProfileDomainId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVoiceProfileDomainRequest', ], 'output' => [ 'shape' => 'UpdateVoiceProfileDomainResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ValidateE911Address' => [ 'name' => 'ValidateE911Address', 'http' => [ 'method' => 'POST', 'requestUri' => '/emergency-calling/address', 'responseCode' => 202, ], 'input' => [ 'shape' => 'ValidateE911AddressRequest', ], 'output' => [ 'shape' => 'ValidateE911AddressResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'Address' => [ 'type' => 'structure', 'members' => [ 'streetName' => [ 'shape' => 'SensitiveNonEmptyString', ], 'streetSuffix' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postDirectional' => [ 'shape' => 'SensitiveNonEmptyString', ], 'preDirectional' => [ 'shape' => 'SensitiveNonEmptyString', ], 'streetNumber' => [ 'shape' => 'SensitiveNonEmptyString', ], 'city' => [ 'shape' => 'SensitiveNonEmptyString', ], 'state' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCode' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCodePlus4' => [ 'shape' => 'SensitiveNonEmptyString', ], 'country' => [ 'shape' => 'SensitiveNonEmptyString', ], ], ], 'AlexaSkillId' => [ 'type' => 'string', 'max' => 64, 'pattern' => 'amzn1\\.application-oa2-client\\.[0-9a-fA-F]{32}', 'sensitive' => true, ], 'AlexaSkillIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlexaSkillId', ], 'max' => 1, 'min' => 1, ], 'AlexaSkillStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'Alpha2CountryCode' => [ 'type' => 'string', 'pattern' => '[A-Z]{2}', ], 'AreaCode' => [ 'type' => 'string', 'pattern' => '^$|^[0-9]{3,3}$', ], 'Arn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$', 'sensitive' => true, ], 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'ForceAssociate' => [ 'shape' => 'NullableBoolean', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'ForceAssociate' => [ 'shape' => 'NullableBoolean', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'BatchDeletePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberIds', ], 'members' => [ 'PhoneNumberIds' => [ 'shape' => 'NonEmptyStringList', ], ], ], 'BatchDeletePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'BatchUpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'UpdatePhoneNumberRequestItems', ], 'members' => [ 'UpdatePhoneNumberRequestItems' => [ 'shape' => 'UpdatePhoneNumberRequestItemList', ], ], ], 'BatchUpdatePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'CallDetails' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', ], 'TransactionId' => [ 'shape' => 'NonEmptyString256', ], 'IsCaller' => [ 'shape' => 'Boolean', ], ], ], 'CallLegType' => [ 'type' => 'string', 'enum' => [ 'Caller', 'Callee', ], ], 'CallingName' => [ 'type' => 'string', 'pattern' => '^$|^[a-zA-Z0-9 ]{2,15}$', 'sensitive' => true, ], 'CallingNameStatus' => [ 'type' => 'string', 'enum' => [ 'Unassigned', 'UpdateInProgress', 'UpdateSucceeded', 'UpdateFailed', ], ], 'CallingRegion' => [ 'type' => 'string', ], 'CallingRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CallingRegion', ], ], 'CandidateAddress' => [ 'type' => 'structure', 'members' => [ 'streetInfo' => [ 'shape' => 'SensitiveNonEmptyString', ], 'streetNumber' => [ 'shape' => 'SensitiveNonEmptyString', ], 'city' => [ 'shape' => 'SensitiveNonEmptyString', ], 'state' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCode' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCodePlus4' => [ 'shape' => 'SensitiveNonEmptyString', ], 'country' => [ 'shape' => 'SensitiveNonEmptyString', ], ], ], 'CandidateAddressList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CandidateAddress', ], ], 'Capability' => [ 'type' => 'string', 'enum' => [ 'Voice', 'SMS', ], ], 'CapabilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Capability', ], ], 'ClientRequestId' => [ 'type' => 'string', 'pattern' => '^[-_a-zA-Z0-9]*${2,64}$', ], 'ConfidenceScore' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Country' => [ 'type' => 'string', 'pattern' => '^$|^[A-Z]{2,2}$', ], 'CountryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Country', ], 'max' => 100, 'min' => 1, ], 'CpsLimit' => [ 'type' => 'integer', 'min' => 1, ], 'CreatePhoneNumberOrderRequest' => [ 'type' => 'structure', 'required' => [ 'ProductType', 'E164PhoneNumbers', ], 'members' => [ 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'CreatePhoneNumberOrderResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrder' => [ 'shape' => 'PhoneNumberOrder', ], ], ], 'CreateProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'ParticipantPhoneNumbers', 'Capabilities', 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ParticipantPhoneNumbers' => [ 'shape' => 'ParticipantPhoneNumberList', ], 'Name' => [ 'shape' => 'ProxySessionNameString', ], 'ExpiryMinutes' => [ 'shape' => 'PositiveInteger', ], 'Capabilities' => [ 'shape' => 'CapabilityList', ], 'NumberSelectionBehavior' => [ 'shape' => 'NumberSelectionBehavior', ], 'GeoMatchLevel' => [ 'shape' => 'GeoMatchLevel', ], 'GeoMatchParams' => [ 'shape' => 'GeoMatchParams', ], ], ], 'CreateProxySessionResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySession' => [ 'shape' => 'ProxySession', ], ], ], 'CreateSipMediaApplicationCallRequest' => [ 'type' => 'structure', 'required' => [ 'FromPhoneNumber', 'ToPhoneNumber', 'SipMediaApplicationId', ], 'members' => [ 'FromPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'ToPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'SipHeaders' => [ 'shape' => 'SipHeadersMap', ], 'ArgumentsMap' => [ 'shape' => 'SMACreateCallArgumentsMap', ], ], ], 'CreateSipMediaApplicationCallResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationCall' => [ 'shape' => 'SipMediaApplicationCall', ], ], ], 'CreateSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsRegion', 'Name', 'Endpoints', ], 'members' => [ 'AwsRegion' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'SipMediaApplicationName', ], 'Endpoints' => [ 'shape' => 'SipMediaApplicationEndpointList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateSipMediaApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplication' => [ 'shape' => 'SipMediaApplication', ], ], ], 'CreateSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'TriggerType', 'TriggerValue', ], 'members' => [ 'Name' => [ 'shape' => 'SipRuleName', ], 'TriggerType' => [ 'shape' => 'SipRuleTriggerType', ], 'TriggerValue' => [ 'shape' => 'NonEmptyString', ], 'Disabled' => [ 'shape' => 'NullableBoolean', ], 'TargetApplications' => [ 'shape' => 'SipRuleTargetApplicationList', ], ], ], 'CreateSipRuleResponse' => [ 'type' => 'structure', 'members' => [ 'SipRule' => [ 'shape' => 'SipRule', ], ], ], 'CreateVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'VoiceConnectorGroupName', ], 'VoiceConnectorItems' => [ 'shape' => 'VoiceConnectorItemList', ], ], ], 'CreateVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroup' => [ 'shape' => 'VoiceConnectorGroup', ], ], ], 'CreateVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'RequireEncryption', ], 'members' => [ 'Name' => [ 'shape' => 'VoiceConnectorName', ], 'AwsRegion' => [ 'shape' => 'VoiceConnectorAwsRegion', ], 'RequireEncryption' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnector', ], ], ], 'CreateVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ServerSideEncryptionConfiguration', ], 'members' => [ 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'ClientRequestToken' => [ 'shape' => 'ClientRequestId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateVoiceProfileDomainResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomain' => [ 'shape' => 'VoiceProfileDomain', ], ], ], 'CreateVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SpeakerSearchTaskId', ], 'members' => [ 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', ], ], ], 'CreateVoiceProfileResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfile' => [ 'shape' => 'VoiceProfile', ], ], ], 'Credential' => [ 'type' => 'structure', 'members' => [ 'Username' => [ 'shape' => 'SensitiveString', ], 'Password' => [ 'shape' => 'SensitiveString', ], ], ], 'CredentialList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Credential', ], ], 'DNISEmergencyCallingConfiguration' => [ 'type' => 'structure', 'required' => [ 'EmergencyPhoneNumber', 'CallingCountry', ], 'members' => [ 'EmergencyPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'TestPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'CallingCountry' => [ 'shape' => 'Alpha2CountryCode', ], ], ], 'DNISEmergencyCallingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DNISEmergencyCallingConfiguration', ], ], 'DataRetentionInHours' => [ 'type' => 'integer', 'min' => 0, ], 'DeletePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], ], ], 'DeleteProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'ProxySessionId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'proxySessionId', ], ], ], 'DeleteSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'DeleteSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'SipRuleId', ], 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipRuleId', ], ], ], 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], ], ], 'DeleteVoiceConnectorOriginationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorProxyRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorStreamingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorTerminationCredentialsRequest' => [ 'type' => 'structure', 'required' => [ 'Usernames', 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Usernames' => [ 'shape' => 'SensitiveStringList', ], ], ], 'DeleteVoiceConnectorTerminationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileDomainId', ], ], ], 'DeleteVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileId', ], 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileId', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'E164PhoneNumber' => [ 'type' => 'string', 'pattern' => '^\\+?[1-9]\\d{1,14}$', 'sensitive' => true, ], 'E164PhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'E164PhoneNumber', ], ], 'EmergencyCallingConfiguration' => [ 'type' => 'structure', 'members' => [ 'DNIS' => [ 'shape' => 'DNISEmergencyCallingConfigurationList', ], ], ], 'ErrorCode' => [ 'type' => 'string', 'enum' => [ 'BadRequest', 'Conflict', 'Forbidden', 'NotFound', 'PreconditionFailed', 'ResourceLimitExceeded', 'ServiceFailure', 'AccessDenied', 'ServiceUnavailable', 'Throttled', 'Throttling', 'Unauthorized', 'Unprocessable', 'VoiceConnectorGroupAssociationsExist', 'PhoneNumberAssociationsExist', 'Gone', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'FunctionArn' => [ 'type' => 'string', 'max' => 10000, 'pattern' => 'arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?', 'sensitive' => true, ], 'GeoMatchLevel' => [ 'type' => 'string', 'enum' => [ 'Country', 'AreaCode', ], ], 'GeoMatchParams' => [ 'type' => 'structure', 'required' => [ 'Country', 'AreaCode', ], 'members' => [ 'Country' => [ 'shape' => 'Country', ], 'AreaCode' => [ 'shape' => 'AreaCode', ], ], ], 'GetGlobalSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnectorSettings', ], ], ], 'GetPhoneNumberOrderRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberOrderId', ], 'members' => [ 'PhoneNumberOrderId' => [ 'shape' => 'GuidString', 'location' => 'uri', 'locationName' => 'phoneNumberOrderId', ], ], ], 'GetPhoneNumberOrderResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrder' => [ 'shape' => 'PhoneNumberOrder', ], ], ], 'GetPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], ], ], 'GetPhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'GetPhoneNumberSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'CallingName' => [ 'shape' => 'CallingName', ], 'CallingNameUpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'GetProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'ProxySessionId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'proxySessionId', ], ], ], 'GetProxySessionResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySession' => [ 'shape' => 'ProxySession', ], ], ], 'GetSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'GetSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationAlexaSkillConfiguration' => [ 'shape' => 'SipMediaApplicationAlexaSkillConfiguration', ], ], ], 'GetSipMediaApplicationLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'GetSipMediaApplicationLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationLoggingConfiguration' => [ 'shape' => 'SipMediaApplicationLoggingConfiguration', ], ], ], 'GetSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'GetSipMediaApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplication' => [ 'shape' => 'SipMediaApplication', ], ], ], 'GetSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'SipRuleId', ], 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipRuleId', ], ], ], 'GetSipRuleResponse' => [ 'type' => 'structure', 'members' => [ 'SipRule' => [ 'shape' => 'SipRule', ], ], ], 'GetSpeakerSearchTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'SpeakerSearchTaskId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'SpeakerSearchTaskId', ], ], ], 'GetSpeakerSearchTaskResponse' => [ 'type' => 'structure', 'members' => [ 'SpeakerSearchTask' => [ 'shape' => 'SpeakerSearchTask', ], ], ], 'GetVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'EmergencyCallingConfiguration' => [ 'shape' => 'EmergencyCallingConfiguration', ], ], ], 'GetVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], ], ], 'GetVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroup' => [ 'shape' => 'VoiceConnectorGroup', ], ], ], 'GetVoiceConnectorLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'GetVoiceConnectorOriginationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorOriginationResponse' => [ 'type' => 'structure', 'members' => [ 'Origination' => [ 'shape' => 'Origination', ], ], ], 'GetVoiceConnectorProxyRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorProxyResponse' => [ 'type' => 'structure', 'members' => [ 'Proxy' => [ 'shape' => 'Proxy', ], ], ], 'GetVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnector', ], ], ], 'GetVoiceConnectorStreamingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorStreamingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'StreamingConfiguration' => [ 'shape' => 'StreamingConfiguration', ], ], ], 'GetVoiceConnectorTerminationHealthRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorTerminationHealthResponse' => [ 'type' => 'structure', 'members' => [ 'TerminationHealth' => [ 'shape' => 'TerminationHealth', ], ], ], 'GetVoiceConnectorTerminationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorTerminationResponse' => [ 'type' => 'structure', 'members' => [ 'Termination' => [ 'shape' => 'Termination', ], ], ], 'GetVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileDomainId', ], ], ], 'GetVoiceProfileDomainResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomain' => [ 'shape' => 'VoiceProfileDomain', ], ], ], 'GetVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileId', ], 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileId', ], ], ], 'GetVoiceProfileResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfile' => [ 'shape' => 'VoiceProfile', ], ], ], 'GetVoiceToneAnalysisTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'VoiceToneAnalysisTaskId', 'IsCaller', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'VoiceToneAnalysisTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceToneAnalysisTaskId', ], 'IsCaller' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'isCaller', ], ], ], 'GetVoiceToneAnalysisTaskResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceToneAnalysisTask' => [ 'shape' => 'VoiceToneAnalysisTask', ], ], ], 'GoneException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], 'GuidString' => [ 'type' => 'string', 'pattern' => '[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}', ], 'Integer' => [ 'type' => 'integer', ], 'Iso8601Timestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'LanguageCode' => [ 'type' => 'string', 'enum' => [ 'en-US', ], ], 'ListAvailableVoiceConnectorRegionsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorRegions' => [ 'shape' => 'VoiceConnectorAwsRegionList', ], ], ], 'ListPhoneNumberOrdersRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListPhoneNumberOrdersResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrders' => [ 'shape' => 'PhoneNumberOrderList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListPhoneNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'status', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', 'location' => 'querystring', 'locationName' => 'product-type', ], 'FilterName' => [ 'shape' => 'PhoneNumberAssociationName', 'location' => 'querystring', 'locationName' => 'filter-name', ], 'FilterValue' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'filter-value', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListPhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumbers' => [ 'shape' => 'PhoneNumberList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListProxySessionsRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Status' => [ 'shape' => 'ProxySessionStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'NextToken' => [ 'shape' => 'NextTokenString', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListProxySessionsResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySessions' => [ 'shape' => 'ProxySessions', ], 'NextToken' => [ 'shape' => 'NextTokenString', ], ], ], 'ListSipMediaApplicationsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'NextTokenString', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListSipMediaApplicationsResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplications' => [ 'shape' => 'SipMediaApplicationList', ], 'NextToken' => [ 'shape' => 'NextTokenString', ], ], ], 'ListSipRulesRequest' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'querystring', 'locationName' => 'sip-media-application', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'NextTokenString', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListSipRulesResponse' => [ 'type' => 'structure', 'members' => [ 'SipRules' => [ 'shape' => 'SipRuleList', ], 'NextToken' => [ 'shape' => 'NextTokenString', ], ], ], 'ListSupportedPhoneNumberCountriesRequest' => [ 'type' => 'structure', 'required' => [ 'ProductType', ], 'members' => [ 'ProductType' => [ 'shape' => 'PhoneNumberProductType', 'location' => 'querystring', 'locationName' => 'product-type', ], ], ], 'ListSupportedPhoneNumberCountriesResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberCountries' => [ 'shape' => 'PhoneNumberCountriesList', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ListVoiceConnectorGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceConnectorGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroups' => [ 'shape' => 'VoiceConnectorGroupList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListVoiceConnectorTerminationCredentialsRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'ListVoiceConnectorTerminationCredentialsResponse' => [ 'type' => 'structure', 'members' => [ 'Usernames' => [ 'shape' => 'SensitiveStringList', ], ], ], 'ListVoiceConnectorsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceConnectorsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectors' => [ 'shape' => 'VoiceConnectorList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListVoiceProfileDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceProfileDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomains' => [ 'shape' => 'VoiceProfileDomainSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListVoiceProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'querystring', 'locationName' => 'voice-profile-domain-id', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfiles' => [ 'shape' => 'VoiceProfileSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'LoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableSIPLogs' => [ 'shape' => 'Boolean', ], 'EnableMediaMetricLogs' => [ 'shape' => 'Boolean', ], ], ], 'MediaInsightsConfiguration' => [ 'type' => 'structure', 'members' => [ 'Disabled' => [ 'shape' => 'Boolean', ], 'ConfigurationArn' => [ 'shape' => 'Arn', ], ], ], 'NextTokenString' => [ 'type' => 'string', 'max' => 65535, ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NonEmptyString128' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NonEmptyString256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NonEmptyStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NotificationTarget' => [ 'type' => 'string', 'enum' => [ 'EventBridge', 'SNS', 'SQS', ], ], 'NullableBoolean' => [ 'type' => 'boolean', ], 'NumberSelectionBehavior' => [ 'type' => 'string', 'enum' => [ 'PreferSticky', 'AvoidSticky', ], ], 'OrderedPhoneNumber' => [ 'type' => 'structure', 'members' => [ 'E164PhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'Status' => [ 'shape' => 'OrderedPhoneNumberStatus', ], ], ], 'OrderedPhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderedPhoneNumber', ], ], 'OrderedPhoneNumberStatus' => [ 'type' => 'string', 'enum' => [ 'Processing', 'Acquired', 'Failed', ], ], 'Origination' => [ 'type' => 'structure', 'members' => [ 'Routes' => [ 'shape' => 'OriginationRouteList', ], 'Disabled' => [ 'shape' => 'Boolean', ], ], ], 'OriginationRoute' => [ 'type' => 'structure', 'members' => [ 'Host' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Port', ], 'Protocol' => [ 'shape' => 'OriginationRouteProtocol', ], 'Priority' => [ 'shape' => 'OriginationRoutePriority', ], 'Weight' => [ 'shape' => 'OriginationRouteWeight', ], ], ], 'OriginationRouteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OriginationRoute', ], ], 'OriginationRoutePriority' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'OriginationRouteProtocol' => [ 'type' => 'string', 'enum' => [ 'TCP', 'UDP', ], ], 'OriginationRouteWeight' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'Participant' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'ProxyPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], ], ], 'ParticipantPhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'E164PhoneNumber', ], 'max' => 2, 'min' => 2, ], 'Participants' => [ 'type' => 'list', 'member' => [ 'shape' => 'Participant', ], ], 'PhoneNumber' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', ], 'E164PhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'Country' => [ 'shape' => 'Alpha2CountryCode', ], 'Type' => [ 'shape' => 'PhoneNumberType', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'Status' => [ 'shape' => 'PhoneNumberStatus', ], 'Capabilities' => [ 'shape' => 'PhoneNumberCapabilities', ], 'Associations' => [ 'shape' => 'PhoneNumberAssociationList', ], 'CallingName' => [ 'shape' => 'CallingName', ], 'CallingNameStatus' => [ 'shape' => 'CallingNameStatus', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'DeletionTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'OrderId' => [ 'shape' => 'GuidString', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'PhoneNumberAssociation' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'PhoneNumberAssociationName', ], 'AssociatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'PhoneNumberAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberAssociation', ], ], 'PhoneNumberAssociationName' => [ 'type' => 'string', 'enum' => [ 'VoiceConnectorId', 'VoiceConnectorGroupId', 'SipRuleId', ], ], 'PhoneNumberCapabilities' => [ 'type' => 'structure', 'members' => [ 'InboundCall' => [ 'shape' => 'NullableBoolean', ], 'OutboundCall' => [ 'shape' => 'NullableBoolean', ], 'InboundSMS' => [ 'shape' => 'NullableBoolean', ], 'OutboundSMS' => [ 'shape' => 'NullableBoolean', ], 'InboundMMS' => [ 'shape' => 'NullableBoolean', ], 'OutboundMMS' => [ 'shape' => 'NullableBoolean', ], ], ], 'PhoneNumberCountriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberCountry', ], ], 'PhoneNumberCountry' => [ 'type' => 'structure', 'members' => [ 'CountryCode' => [ 'shape' => 'Alpha2CountryCode', ], 'SupportedPhoneNumberTypes' => [ 'shape' => 'PhoneNumberTypeList', ], ], ], 'PhoneNumberError' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', ], 'ErrorCode' => [ 'shape' => 'ErrorCode', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'PhoneNumberErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberError', ], ], 'PhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumber', ], ], 'PhoneNumberMaxResults' => [ 'type' => 'integer', 'max' => 500, 'min' => 1, ], 'PhoneNumberName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^$|^[a-zA-Z0-9\\,\\.\\_\\-]+(\\s+[a-zA-Z0-9\\,\\.\\_\\-]+)*$', 'sensitive' => true, ], 'PhoneNumberOrder' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrderId' => [ 'shape' => 'GuidString', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'Status' => [ 'shape' => 'PhoneNumberOrderStatus', ], 'OrderType' => [ 'shape' => 'PhoneNumberOrderType', ], 'OrderedPhoneNumbers' => [ 'shape' => 'OrderedPhoneNumberList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'PhoneNumberOrderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberOrder', ], ], 'PhoneNumberOrderStatus' => [ 'type' => 'string', 'enum' => [ 'Processing', 'Successful', 'Failed', 'Partial', 'PendingDocuments', 'Submitted', 'FOC', 'ChangeRequested', 'Exception', 'CancelRequested', 'Cancelled', ], ], 'PhoneNumberOrderType' => [ 'type' => 'string', 'enum' => [ 'New', 'Porting', ], ], 'PhoneNumberProductType' => [ 'type' => 'string', 'enum' => [ 'VoiceConnector', 'SipMediaApplicationDialIn', ], ], 'PhoneNumberStatus' => [ 'type' => 'string', 'enum' => [ 'Cancelled', 'PortinCancelRequested', 'PortinInProgress', 'AcquireInProgress', 'AcquireFailed', 'Unassigned', 'Assigned', 'ReleaseInProgress', 'DeleteInProgress', 'ReleaseFailed', 'DeleteFailed', ], ], 'PhoneNumberType' => [ 'type' => 'string', 'enum' => [ 'Local', 'TollFree', ], ], 'PhoneNumberTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberType', ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'PositiveInteger' => [ 'type' => 'integer', 'min' => 1, ], 'Proxy' => [ 'type' => 'structure', 'members' => [ 'DefaultSessionExpiryMinutes' => [ 'shape' => 'Integer', ], 'Disabled' => [ 'shape' => 'Boolean', ], 'FallBackPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'PhoneNumberCountries' => [ 'shape' => 'StringList', ], ], ], 'ProxySession' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', ], 'Name' => [ 'shape' => 'String128', ], 'Status' => [ 'shape' => 'ProxySessionStatus', ], 'ExpiryMinutes' => [ 'shape' => 'PositiveInteger', ], 'Capabilities' => [ 'shape' => 'CapabilityList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'EndedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'Participants' => [ 'shape' => 'Participants', ], 'NumberSelectionBehavior' => [ 'shape' => 'NumberSelectionBehavior', ], 'GeoMatchLevel' => [ 'shape' => 'GeoMatchLevel', ], 'GeoMatchParams' => [ 'shape' => 'GeoMatchParams', ], ], ], 'ProxySessionNameString' => [ 'type' => 'string', 'pattern' => '^$|^[a-zA-Z0-9 ]{0,30}$', 'sensitive' => true, ], 'ProxySessionStatus' => [ 'type' => 'string', 'enum' => [ 'Open', 'InProgress', 'Closed', ], ], 'ProxySessions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProxySession', ], ], 'PutSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'SipMediaApplicationAlexaSkillConfiguration' => [ 'shape' => 'SipMediaApplicationAlexaSkillConfiguration', ], ], ], 'PutSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationAlexaSkillConfiguration' => [ 'shape' => 'SipMediaApplicationAlexaSkillConfiguration', ], ], ], 'PutSipMediaApplicationLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'SipMediaApplicationLoggingConfiguration' => [ 'shape' => 'SipMediaApplicationLoggingConfiguration', ], ], ], 'PutSipMediaApplicationLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationLoggingConfiguration' => [ 'shape' => 'SipMediaApplicationLoggingConfiguration', ], ], ], 'PutVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'EmergencyCallingConfiguration', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'EmergencyCallingConfiguration' => [ 'shape' => 'EmergencyCallingConfiguration', ], ], ], 'PutVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'EmergencyCallingConfiguration' => [ 'shape' => 'EmergencyCallingConfiguration', ], ], ], 'PutVoiceConnectorLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'LoggingConfiguration', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutVoiceConnectorLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutVoiceConnectorOriginationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Origination', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Origination' => [ 'shape' => 'Origination', ], ], ], 'PutVoiceConnectorOriginationResponse' => [ 'type' => 'structure', 'members' => [ 'Origination' => [ 'shape' => 'Origination', ], ], ], 'PutVoiceConnectorProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DefaultSessionExpiryMinutes', 'PhoneNumberPoolCountries', 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'DefaultSessionExpiryMinutes' => [ 'shape' => 'Integer', ], 'PhoneNumberPoolCountries' => [ 'shape' => 'CountryList', ], 'FallBackPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'Disabled' => [ 'shape' => 'Boolean', ], ], ], 'PutVoiceConnectorProxyResponse' => [ 'type' => 'structure', 'members' => [ 'Proxy' => [ 'shape' => 'Proxy', ], ], ], 'PutVoiceConnectorStreamingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'StreamingConfiguration', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'StreamingConfiguration' => [ 'shape' => 'StreamingConfiguration', ], ], ], 'PutVoiceConnectorStreamingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'StreamingConfiguration' => [ 'shape' => 'StreamingConfiguration', ], ], ], 'PutVoiceConnectorTerminationCredentialsRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Credentials' => [ 'shape' => 'CredentialList', ], ], ], 'PutVoiceConnectorTerminationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Termination', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Termination' => [ 'shape' => 'Termination', ], ], ], 'PutVoiceConnectorTerminationResponse' => [ 'type' => 'structure', 'members' => [ 'Termination' => [ 'shape' => 'Termination', ], ], ], 'ResourceLimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'RestorePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], ], ], 'RestorePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'ResultMax' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'SMACreateCallArgumentsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'SensitiveString', ], 'value' => [ 'shape' => 'SensitiveString', ], 'max' => 20, 'min' => 0, ], 'SMAUpdateCallArgumentsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'SensitiveString', ], 'value' => [ 'shape' => 'SensitiveString', ], 'max' => 20, 'min' => 0, ], 'SearchAvailablePhoneNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'AreaCode' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'area-code', ], 'City' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'city', ], 'Country' => [ 'shape' => 'Alpha2CountryCode', 'location' => 'querystring', 'locationName' => 'country', ], 'State' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'state', ], 'TollFreePrefix' => [ 'shape' => 'TollFreePrefix', 'location' => 'querystring', 'locationName' => 'toll-free-prefix', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', 'location' => 'querystring', 'locationName' => 'phone-number-type', ], 'MaxResults' => [ 'shape' => 'PhoneNumberMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'SearchAvailablePhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'SensitiveNonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', 'sensitive' => true, ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'SensitiveStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveString', ], ], 'ServerSideEncryptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'KmsKeyArn', ], 'members' => [ 'KmsKeyArn' => [ 'shape' => 'Arn', ], ], ], 'ServiceFailureException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'SipApplicationPriority' => [ 'type' => 'integer', 'min' => 1, ], 'SipHeadersMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'SensitiveString', ], 'value' => [ 'shape' => 'SensitiveString', ], 'max' => 20, 'min' => 0, ], 'SipMediaApplication' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', ], 'AwsRegion' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'SipMediaApplicationName', ], 'Endpoints' => [ 'shape' => 'SipMediaApplicationEndpointList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'SipMediaApplicationArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'SipMediaApplicationAlexaSkillConfiguration' => [ 'type' => 'structure', 'required' => [ 'AlexaSkillStatus', 'AlexaSkillIds', ], 'members' => [ 'AlexaSkillStatus' => [ 'shape' => 'AlexaSkillStatus', ], 'AlexaSkillIds' => [ 'shape' => 'AlexaSkillIdList', ], ], ], 'SipMediaApplicationCall' => [ 'type' => 'structure', 'members' => [ 'TransactionId' => [ 'shape' => 'GuidString', ], ], ], 'SipMediaApplicationEndpoint' => [ 'type' => 'structure', 'members' => [ 'LambdaArn' => [ 'shape' => 'FunctionArn', ], ], ], 'SipMediaApplicationEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipMediaApplicationEndpoint', ], 'max' => 1, 'min' => 1, ], 'SipMediaApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipMediaApplication', ], ], 'SipMediaApplicationLoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableSipMediaApplicationMessageLogs' => [ 'shape' => 'Boolean', ], ], ], 'SipMediaApplicationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'SipRule' => [ 'type' => 'structure', 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', ], 'Name' => [ 'shape' => 'SipRuleName', ], 'Disabled' => [ 'shape' => 'Boolean', ], 'TriggerType' => [ 'shape' => 'SipRuleTriggerType', ], 'TriggerValue' => [ 'shape' => 'NonEmptyString', ], 'TargetApplications' => [ 'shape' => 'SipRuleTargetApplicationList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'SipRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipRule', ], ], 'SipRuleName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'SipRuleTargetApplication' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', ], 'Priority' => [ 'shape' => 'SipApplicationPriority', ], 'AwsRegion' => [ 'shape' => 'String', ], ], ], 'SipRuleTargetApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipRuleTargetApplication', ], 'max' => 25, 'min' => 1, ], 'SipRuleTriggerType' => [ 'type' => 'string', 'enum' => [ 'ToPhoneNumber', 'RequestUriHostname', ], ], 'SpeakerSearchDetails' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SpeakerSearchResultList', ], 'VoiceprintGenerationStatus' => [ 'shape' => 'NonEmptyString256', ], ], ], 'SpeakerSearchResult' => [ 'type' => 'structure', 'members' => [ 'ConfidenceScore' => [ 'shape' => 'ConfidenceScore', ], 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', ], ], ], 'SpeakerSearchResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpeakerSearchResult', ], ], 'SpeakerSearchTask' => [ 'type' => 'structure', 'members' => [ 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', ], 'SpeakerSearchTaskStatus' => [ 'shape' => 'NonEmptyString', ], 'CallDetails' => [ 'shape' => 'CallDetails', ], 'SpeakerSearchDetails' => [ 'shape' => 'SpeakerSearchDetails', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StartedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'StartSpeakerSearchTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'TransactionId', 'VoiceProfileDomainId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'TransactionId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'ClientRequestToken' => [ 'shape' => 'ClientRequestId', ], 'CallLeg' => [ 'shape' => 'CallLegType', ], ], ], 'StartSpeakerSearchTaskResponse' => [ 'type' => 'structure', 'members' => [ 'SpeakerSearchTask' => [ 'shape' => 'SpeakerSearchTask', ], ], ], 'StartVoiceToneAnalysisTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'TransactionId', 'LanguageCode', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'TransactionId' => [ 'shape' => 'NonEmptyString256', ], 'LanguageCode' => [ 'shape' => 'LanguageCode', ], 'ClientRequestToken' => [ 'shape' => 'ClientRequestId', ], ], ], 'StartVoiceToneAnalysisTaskResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceToneAnalysisTask' => [ 'shape' => 'VoiceToneAnalysisTask', ], ], ], 'StopSpeakerSearchTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'SpeakerSearchTaskId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'SpeakerSearchTaskId', ], ], ], 'StopVoiceToneAnalysisTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'VoiceToneAnalysisTaskId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'VoiceToneAnalysisTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceToneAnalysisTaskId', ], ], ], 'StreamingConfiguration' => [ 'type' => 'structure', 'required' => [ 'DataRetentionInHours', 'Disabled', ], 'members' => [ 'DataRetentionInHours' => [ 'shape' => 'DataRetentionInHours', ], 'Disabled' => [ 'shape' => 'Boolean', ], 'StreamingNotificationTargets' => [ 'shape' => 'StreamingNotificationTargetList', ], 'MediaInsightsConfiguration' => [ 'shape' => 'MediaInsightsConfiguration', ], ], ], 'StreamingNotificationTarget' => [ 'type' => 'structure', 'members' => [ 'NotificationTarget' => [ 'shape' => 'NotificationTarget', ], ], ], 'StreamingNotificationTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StreamingNotificationTarget', ], 'max' => 3, 'min' => 1, ], 'String' => [ 'type' => 'string', ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'sensitive' => true, ], 'Termination' => [ 'type' => 'structure', 'members' => [ 'CpsLimit' => [ 'shape' => 'CpsLimit', ], 'DefaultPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'CallingRegions' => [ 'shape' => 'CallingRegionList', ], 'CidrAllowedList' => [ 'shape' => 'StringList', ], 'Disabled' => [ 'shape' => 'Boolean', ], ], ], 'TerminationHealth' => [ 'type' => 'structure', 'members' => [ 'Timestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'Source' => [ 'shape' => 'String', ], ], ], 'ThrottledClientException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TollFreePrefix' => [ 'type' => 'string', 'max' => 3, 'min' => 3, 'pattern' => '^8(00|33|44|55|66|77|88)$', ], 'UnauthorizedClientException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'UnprocessableEntityException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 422, ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'Arn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UpdateGlobalSettingsRequest' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnectorSettings', ], ], ], 'UpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'CallingName' => [ 'shape' => 'CallingName', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'UpdatePhoneNumberRequestItem' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'CallingName' => [ 'shape' => 'CallingName', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'UpdatePhoneNumberRequestItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdatePhoneNumberRequestItem', ], ], 'UpdatePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'UpdatePhoneNumberSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'CallingName', ], 'members' => [ 'CallingName' => [ 'shape' => 'CallingName', ], ], ], 'UpdateProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'Capabilities', 'VoiceConnectorId', 'ProxySessionId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'proxySessionId', ], 'Capabilities' => [ 'shape' => 'CapabilityList', ], 'ExpiryMinutes' => [ 'shape' => 'PositiveInteger', ], ], ], 'UpdateProxySessionResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySession' => [ 'shape' => 'ProxySession', ], ], ], 'UpdateSipMediaApplicationCallRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', 'TransactionId', 'Arguments', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'TransactionId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'transactionId', ], 'Arguments' => [ 'shape' => 'SMAUpdateCallArgumentsMap', ], ], ], 'UpdateSipMediaApplicationCallResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationCall' => [ 'shape' => 'SipMediaApplicationCall', ], ], ], 'UpdateSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'Name' => [ 'shape' => 'SipMediaApplicationName', ], 'Endpoints' => [ 'shape' => 'SipMediaApplicationEndpointList', ], ], ], 'UpdateSipMediaApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplication' => [ 'shape' => 'SipMediaApplication', ], ], ], 'UpdateSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'SipRuleId', 'Name', ], 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipRuleId', ], 'Name' => [ 'shape' => 'SipRuleName', ], 'Disabled' => [ 'shape' => 'NullableBoolean', ], 'TargetApplications' => [ 'shape' => 'SipRuleTargetApplicationList', ], ], ], 'UpdateSipRuleResponse' => [ 'type' => 'structure', 'members' => [ 'SipRule' => [ 'shape' => 'SipRule', ], ], ], 'UpdateVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', 'Name', 'VoiceConnectorItems', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], 'Name' => [ 'shape' => 'VoiceConnectorGroupName', ], 'VoiceConnectorItems' => [ 'shape' => 'VoiceConnectorItemList', ], ], ], 'UpdateVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroup' => [ 'shape' => 'VoiceConnectorGroup', ], ], ], 'UpdateVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Name', 'RequireEncryption', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Name' => [ 'shape' => 'VoiceConnectorName', ], 'RequireEncryption' => [ 'shape' => 'Boolean', ], ], ], 'UpdateVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnector', ], ], ], 'UpdateVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileDomainId', ], 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], ], ], 'UpdateVoiceProfileDomainResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomain' => [ 'shape' => 'VoiceProfileDomain', ], ], ], 'UpdateVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileId', 'SpeakerSearchTaskId', ], 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileId', ], 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', ], ], ], 'UpdateVoiceProfileResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfile' => [ 'shape' => 'VoiceProfile', ], ], ], 'ValidateE911AddressRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'StreetNumber', 'StreetInfo', 'City', 'State', 'Country', 'PostalCode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'NonEmptyString', ], 'StreetNumber' => [ 'shape' => 'SensitiveNonEmptyString', ], 'StreetInfo' => [ 'shape' => 'SensitiveNonEmptyString', ], 'City' => [ 'shape' => 'SensitiveNonEmptyString', ], 'State' => [ 'shape' => 'SensitiveNonEmptyString', ], 'Country' => [ 'shape' => 'SensitiveNonEmptyString', ], 'PostalCode' => [ 'shape' => 'SensitiveNonEmptyString', ], ], ], 'ValidateE911AddressResponse' => [ 'type' => 'structure', 'members' => [ 'ValidationResult' => [ 'shape' => 'ValidationResult', ], 'AddressExternalId' => [ 'shape' => 'String', ], 'Address' => [ 'shape' => 'Address', ], 'CandidateAddressList' => [ 'shape' => 'CandidateAddressList', ], ], ], 'ValidationResult' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'VoiceConnector' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', ], 'AwsRegion' => [ 'shape' => 'VoiceConnectorAwsRegion', ], 'Name' => [ 'shape' => 'VoiceConnectorName', ], 'OutboundHostName' => [ 'shape' => 'String', ], 'RequireEncryption' => [ 'shape' => 'Boolean', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'VoiceConnectorArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'VoiceConnectorAwsRegion' => [ 'type' => 'string', 'enum' => [ 'us-east-1', 'us-west-2', 'ca-central-1', 'eu-central-1', 'eu-west-1', 'eu-west-2', 'ap-northeast-2', 'ap-northeast-1', 'ap-southeast-1', 'ap-southeast-2', ], ], 'VoiceConnectorAwsRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnectorAwsRegion', ], ], 'VoiceConnectorGroup' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', ], 'Name' => [ 'shape' => 'VoiceConnectorGroupName', ], 'VoiceConnectorItems' => [ 'shape' => 'VoiceConnectorItemList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'VoiceConnectorGroupArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'VoiceConnectorGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnectorGroup', ], ], 'VoiceConnectorGroupName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'VoiceConnectorItem' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Priority', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', ], 'Priority' => [ 'shape' => 'VoiceConnectorItemPriority', ], ], ], 'VoiceConnectorItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnectorItem', ], ], 'VoiceConnectorItemPriority' => [ 'type' => 'integer', 'max' => 99, 'min' => 1, ], 'VoiceConnectorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnector', ], ], 'VoiceConnectorName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'VoiceConnectorSettings' => [ 'type' => 'structure', 'members' => [ 'CdrBucket' => [ 'shape' => 'String', ], ], ], 'VoiceProfile' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileArn' => [ 'shape' => 'Arn', ], 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'ExpirationTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileDomain' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileDomainArn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileDomainDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'VoiceProfileDomainName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'VoiceProfileDomainSummary' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileDomainArn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileDomainSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceProfileDomainSummary', ], ], 'VoiceProfileSummary' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileArn' => [ 'shape' => 'Arn', ], 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'ExpirationTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceProfileSummary', ], ], 'VoiceToneAnalysisTask' => [ 'type' => 'structure', 'members' => [ 'VoiceToneAnalysisTaskId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceToneAnalysisTaskStatus' => [ 'shape' => 'NonEmptyString', ], 'CallDetails' => [ 'shape' => 'CallDetails', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StartedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2022-08-03', 'endpointPrefix' => 'voice-chime', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon Chime SDK Voice', 'serviceId' => 'Chime SDK Voice', 'signatureVersion' => 'v4', 'signingName' => 'chime', 'uid' => 'chime-sdk-voice-2022-08-03', ], 'operations' => [ 'AssociatePhoneNumbersWithVoiceConnector' => [ 'name' => 'AssociatePhoneNumbersWithVoiceConnector', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorRequest', ], 'output' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorGroup' => [ 'name' => 'AssociatePhoneNumbersWithVoiceConnectorGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'BatchDeletePhoneNumber' => [ 'name' => 'BatchDeletePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers?operation=batch-delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchDeletePhoneNumberRequest', ], 'output' => [ 'shape' => 'BatchDeletePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'BatchUpdatePhoneNumber' => [ 'name' => 'BatchUpdatePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers?operation=batch-update', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchUpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'BatchUpdatePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreatePhoneNumberOrder' => [ 'name' => 'CreatePhoneNumberOrder', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number-orders', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreatePhoneNumberOrderRequest', ], 'output' => [ 'shape' => 'CreatePhoneNumberOrderResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateProxySession' => [ 'name' => 'CreateProxySession', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateProxySessionRequest', ], 'output' => [ 'shape' => 'CreateProxySessionResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateSipMediaApplication' => [ 'name' => 'CreateSipMediaApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-media-applications', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateSipMediaApplicationRequest', ], 'output' => [ 'shape' => 'CreateSipMediaApplicationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateSipMediaApplicationCall' => [ 'name' => 'CreateSipMediaApplicationCall', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/calls', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateSipMediaApplicationCallRequest', ], 'output' => [ 'shape' => 'CreateSipMediaApplicationCallResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateSipRule' => [ 'name' => 'CreateSipRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-rules', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateSipRuleRequest', ], 'output' => [ 'shape' => 'CreateSipRuleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceConnector' => [ 'name' => 'CreateVoiceConnector', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceConnectorRequest', ], 'output' => [ 'shape' => 'CreateVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceConnectorGroup' => [ 'name' => 'CreateVoiceConnectorGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connector-groups', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'CreateVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceProfile' => [ 'name' => 'CreateVoiceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-profiles', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceProfileRequest', ], 'output' => [ 'shape' => 'CreateVoiceProfileResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'CreateVoiceProfileDomain' => [ 'name' => 'CreateVoiceProfileDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-profile-domains', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateVoiceProfileDomainRequest', ], 'output' => [ 'shape' => 'CreateVoiceProfileDomainResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeletePhoneNumber' => [ 'name' => 'DeletePhoneNumber', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/phone-numbers/{phoneNumberId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeletePhoneNumberRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteProxySession' => [ 'name' => 'DeleteProxySession', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteProxySessionRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteSipMediaApplication' => [ 'name' => 'DeleteSipMediaApplication', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteSipMediaApplicationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteSipRule' => [ 'name' => 'DeleteSipRule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sip-rules/{sipRuleId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteSipRuleRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnector' => [ 'name' => 'DeleteVoiceConnector', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorEmergencyCallingConfiguration' => [ 'name' => 'DeleteVoiceConnectorEmergencyCallingConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/emergency-calling-configuration', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorGroup' => [ 'name' => 'DeleteVoiceConnectorGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorGroupRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorOrigination' => [ 'name' => 'DeleteVoiceConnectorOrigination', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/origination', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorOriginationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorProxy' => [ 'name' => 'DeleteVoiceConnectorProxy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorProxyRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorStreamingConfiguration' => [ 'name' => 'DeleteVoiceConnectorStreamingConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/streaming-configuration', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorStreamingConfigurationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorTermination' => [ 'name' => 'DeleteVoiceConnectorTermination', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorTerminationRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceConnectorTerminationCredentials' => [ 'name' => 'DeleteVoiceConnectorTerminationCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceConnectorTerminationCredentialsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceProfile' => [ 'name' => 'DeleteVoiceProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-profiles/{VoiceProfileId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceProfileRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DeleteVoiceProfileDomain' => [ 'name' => 'DeleteVoiceProfileDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/voice-profile-domains/{VoiceProfileDomainId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteVoiceProfileDomainRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnector' => [ 'name' => 'DisassociatePhoneNumbersFromVoiceConnector', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorRequest', ], 'output' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroup' => [ 'name' => 'DisassociatePhoneNumbersFromVoiceConnectorGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetGlobalSettings' => [ 'name' => 'GetGlobalSettings', 'http' => [ 'method' => 'GET', 'requestUri' => '/settings', 'responseCode' => 200, ], 'output' => [ 'shape' => 'GetGlobalSettingsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetPhoneNumber' => [ 'name' => 'GetPhoneNumber', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-numbers/{phoneNumberId}', ], 'input' => [ 'shape' => 'GetPhoneNumberRequest', ], 'output' => [ 'shape' => 'GetPhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetPhoneNumberOrder' => [ 'name' => 'GetPhoneNumberOrder', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number-orders/{phoneNumberOrderId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetPhoneNumberOrderRequest', ], 'output' => [ 'shape' => 'GetPhoneNumberOrderResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetPhoneNumberSettings' => [ 'name' => 'GetPhoneNumberSettings', 'http' => [ 'method' => 'GET', 'requestUri' => '/settings/phone-number', 'responseCode' => 200, ], 'output' => [ 'shape' => 'GetPhoneNumberSettingsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetProxySession' => [ 'name' => 'GetProxySession', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetProxySessionRequest', ], 'output' => [ 'shape' => 'GetProxySessionResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipMediaApplication' => [ 'name' => 'GetSipMediaApplication', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipMediaApplicationRequest', ], 'output' => [ 'shape' => 'GetSipMediaApplicationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipMediaApplicationAlexaSkillConfiguration' => [ 'name' => 'GetSipMediaApplicationAlexaSkillConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipMediaApplicationAlexaSkillConfigurationRequest', ], 'output' => [ 'shape' => 'GetSipMediaApplicationAlexaSkillConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], 'deprecated' => true, 'deprecatedMessage' => 'Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).', ], 'GetSipMediaApplicationLoggingConfiguration' => [ 'name' => 'GetSipMediaApplicationLoggingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipMediaApplicationLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'GetSipMediaApplicationLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSipRule' => [ 'name' => 'GetSipRule', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-rules/{sipRuleId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSipRuleRequest', ], 'output' => [ 'shape' => 'GetSipRuleResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetSpeakerSearchTask' => [ 'name' => 'GetSpeakerSearchTask', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSpeakerSearchTaskRequest', ], 'output' => [ 'shape' => 'GetSpeakerSearchTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceFailureException', ], [ 'shape' => 'ServiceUnavailableException', ], ], ], 'GetVoiceConnector' => [ 'name' => 'GetVoiceConnector', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorEmergencyCallingConfiguration' => [ 'name' => 'GetVoiceConnectorEmergencyCallingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/emergency-calling-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorEmergencyCallingConfigurationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorEmergencyCallingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorGroup' => [ 'name' => 'GetVoiceConnectorGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorLoggingConfiguration' => [ 'name' => 'GetVoiceConnectorLoggingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorOrigination' => [ 'name' => 'GetVoiceConnectorOrigination', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/origination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorOriginationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorOriginationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorProxy' => [ 'name' => 'GetVoiceConnectorProxy', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorProxyRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorProxyResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorStreamingConfiguration' => [ 'name' => 'GetVoiceConnectorStreamingConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/streaming-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorStreamingConfigurationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorStreamingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorTermination' => [ 'name' => 'GetVoiceConnectorTermination', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorTerminationRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorTerminationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceConnectorTerminationHealth' => [ 'name' => 'GetVoiceConnectorTerminationHealth', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/health', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceConnectorTerminationHealthRequest', ], 'output' => [ 'shape' => 'GetVoiceConnectorTerminationHealthResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceProfile' => [ 'name' => 'GetVoiceProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profiles/{VoiceProfileId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceProfileRequest', ], 'output' => [ 'shape' => 'GetVoiceProfileResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceProfileDomain' => [ 'name' => 'GetVoiceProfileDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profile-domains/{VoiceProfileDomainId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceProfileDomainRequest', ], 'output' => [ 'shape' => 'GetVoiceProfileDomainResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'GetVoiceToneAnalysisTask' => [ 'name' => 'GetVoiceToneAnalysisTask', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVoiceToneAnalysisTaskRequest', ], 'output' => [ 'shape' => 'GetVoiceToneAnalysisTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceFailureException', ], [ 'shape' => 'ServiceUnavailableException', ], ], ], 'ListAvailableVoiceConnectorRegions' => [ 'name' => 'ListAvailableVoiceConnectorRegions', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connector-regions', 'responseCode' => 200, ], 'output' => [ 'shape' => 'ListAvailableVoiceConnectorRegionsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListPhoneNumberOrders' => [ 'name' => 'ListPhoneNumberOrders', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number-orders', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListPhoneNumberOrdersRequest', ], 'output' => [ 'shape' => 'ListPhoneNumberOrdersResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListPhoneNumbers' => [ 'name' => 'ListPhoneNumbers', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-numbers', ], 'input' => [ 'shape' => 'ListPhoneNumbersRequest', ], 'output' => [ 'shape' => 'ListPhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListProxySessions' => [ 'name' => 'ListProxySessions', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListProxySessionsRequest', ], 'output' => [ 'shape' => 'ListProxySessionsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListSipMediaApplications' => [ 'name' => 'ListSipMediaApplications', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-media-applications', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSipMediaApplicationsRequest', ], 'output' => [ 'shape' => 'ListSipMediaApplicationsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListSipRules' => [ 'name' => 'ListSipRules', 'http' => [ 'method' => 'GET', 'requestUri' => '/sip-rules', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSipRulesRequest', ], 'output' => [ 'shape' => 'ListSipRulesResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListSupportedPhoneNumberCountries' => [ 'name' => 'ListSupportedPhoneNumberCountries', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number-countries', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSupportedPhoneNumberCountriesRequest', ], 'output' => [ 'shape' => 'ListSupportedPhoneNumberCountriesResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceConnectorGroups' => [ 'name' => 'ListVoiceConnectorGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connector-groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceConnectorGroupsRequest', ], 'output' => [ 'shape' => 'ListVoiceConnectorGroupsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceConnectorTerminationCredentials' => [ 'name' => 'ListVoiceConnectorTerminationCredentials', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/credentials', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceConnectorTerminationCredentialsRequest', ], 'output' => [ 'shape' => 'ListVoiceConnectorTerminationCredentialsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceConnectors' => [ 'name' => 'ListVoiceConnectors', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-connectors', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceConnectorsRequest', ], 'output' => [ 'shape' => 'ListVoiceConnectorsResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceProfileDomains' => [ 'name' => 'ListVoiceProfileDomains', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profile-domains', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceProfileDomainsRequest', ], 'output' => [ 'shape' => 'ListVoiceProfileDomainsResponse', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ListVoiceProfiles' => [ 'name' => 'ListVoiceProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/voice-profiles', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVoiceProfilesRequest', ], 'output' => [ 'shape' => 'ListVoiceProfilesResponse', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutSipMediaApplicationAlexaSkillConfiguration' => [ 'name' => 'PutSipMediaApplicationAlexaSkillConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutSipMediaApplicationAlexaSkillConfigurationRequest', ], 'output' => [ 'shape' => 'PutSipMediaApplicationAlexaSkillConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], 'deprecated' => true, 'deprecatedMessage' => 'Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).', ], 'PutSipMediaApplicationLoggingConfiguration' => [ 'name' => 'PutSipMediaApplicationLoggingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutSipMediaApplicationLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'PutSipMediaApplicationLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorEmergencyCallingConfiguration' => [ 'name' => 'PutVoiceConnectorEmergencyCallingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/emergency-calling-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorEmergencyCallingConfigurationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorEmergencyCallingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorLoggingConfiguration' => [ 'name' => 'PutVoiceConnectorLoggingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/logging-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorOrigination' => [ 'name' => 'PutVoiceConnectorOrigination', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/origination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorOriginationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorOriginationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorProxy' => [ 'name' => 'PutVoiceConnectorProxy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy', ], 'input' => [ 'shape' => 'PutVoiceConnectorProxyRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorProxyResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorStreamingConfiguration' => [ 'name' => 'PutVoiceConnectorStreamingConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/streaming-configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorStreamingConfigurationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorStreamingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorTermination' => [ 'name' => 'PutVoiceConnectorTermination', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutVoiceConnectorTerminationRequest', ], 'output' => [ 'shape' => 'PutVoiceConnectorTerminationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'PutVoiceConnectorTerminationCredentials' => [ 'name' => 'PutVoiceConnectorTerminationCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/termination/credentials?operation=put', 'responseCode' => 204, ], 'input' => [ 'shape' => 'PutVoiceConnectorTerminationCredentialsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'RestorePhoneNumber' => [ 'name' => 'RestorePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers/{phoneNumberId}?operation=restore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RestorePhoneNumberRequest', ], 'output' => [ 'shape' => 'RestorePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'SearchAvailablePhoneNumbers' => [ 'name' => 'SearchAvailablePhoneNumbers', 'http' => [ 'method' => 'GET', 'requestUri' => '/search?type=phone-numbers', ], 'input' => [ 'shape' => 'SearchAvailablePhoneNumbersRequest', ], 'output' => [ 'shape' => 'SearchAvailablePhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StartSpeakerSearchTask' => [ 'name' => 'StartSpeakerSearchTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/speaker-search-tasks', 'responseCode' => 201, ], 'input' => [ 'shape' => 'StartSpeakerSearchTaskRequest', ], 'output' => [ 'shape' => 'StartSpeakerSearchTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StartVoiceToneAnalysisTask' => [ 'name' => 'StartVoiceToneAnalysisTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks', 'responseCode' => 201, ], 'input' => [ 'shape' => 'StartVoiceToneAnalysisTaskRequest', ], 'output' => [ 'shape' => 'StartVoiceToneAnalysisTaskResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StopSpeakerSearchTask' => [ 'name' => 'StopSpeakerSearchTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}?operation=stop', 'responseCode' => 204, ], 'input' => [ 'shape' => 'StopSpeakerSearchTaskRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'StopVoiceToneAnalysisTask' => [ 'name' => 'StopVoiceToneAnalysisTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}?operation=stop', 'responseCode' => 204, ], 'input' => [ 'shape' => 'StopVoiceToneAnalysisTaskRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags?operation=tag-resource', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags?operation=untag-resource', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateGlobalSettings' => [ 'name' => 'UpdateGlobalSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/settings', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UpdateGlobalSettingsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdatePhoneNumber' => [ 'name' => 'UpdatePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-numbers/{phoneNumberId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'UpdatePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdatePhoneNumberSettings' => [ 'name' => 'UpdatePhoneNumberSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/settings/phone-number', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UpdatePhoneNumberSettingsRequest', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateProxySession' => [ 'name' => 'UpdateProxySession', 'http' => [ 'method' => 'POST', 'requestUri' => '/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}', 'responseCode' => 201, ], 'input' => [ 'shape' => 'UpdateProxySessionRequest', ], 'output' => [ 'shape' => 'UpdateProxySessionResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateSipMediaApplication' => [ 'name' => 'UpdateSipMediaApplication', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateSipMediaApplicationRequest', ], 'output' => [ 'shape' => 'UpdateSipMediaApplicationResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateSipMediaApplicationCall' => [ 'name' => 'UpdateSipMediaApplicationCall', 'http' => [ 'method' => 'POST', 'requestUri' => '/sip-media-applications/{sipMediaApplicationId}/calls/{transactionId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateSipMediaApplicationCallRequest', ], 'output' => [ 'shape' => 'UpdateSipMediaApplicationCallResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateSipRule' => [ 'name' => 'UpdateSipRule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sip-rules/{sipRuleId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateSipRuleRequest', ], 'output' => [ 'shape' => 'UpdateSipRuleResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ResourceLimitExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceConnector' => [ 'name' => 'UpdateVoiceConnector', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connectors/{voiceConnectorId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVoiceConnectorRequest', ], 'output' => [ 'shape' => 'UpdateVoiceConnectorResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceConnectorGroup' => [ 'name' => 'UpdateVoiceConnectorGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-connector-groups/{voiceConnectorGroupId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateVoiceConnectorGroupRequest', ], 'output' => [ 'shape' => 'UpdateVoiceConnectorGroupResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceProfile' => [ 'name' => 'UpdateVoiceProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-profiles/{VoiceProfileId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVoiceProfileRequest', ], 'output' => [ 'shape' => 'UpdateVoiceProfileResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'GoneException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'UpdateVoiceProfileDomain' => [ 'name' => 'UpdateVoiceProfileDomain', 'http' => [ 'method' => 'PUT', 'requestUri' => '/voice-profile-domains/{VoiceProfileDomainId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVoiceProfileDomainRequest', ], 'output' => [ 'shape' => 'UpdateVoiceProfileDomainResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], 'ValidateE911Address' => [ 'name' => 'ValidateE911Address', 'http' => [ 'method' => 'POST', 'requestUri' => '/emergency-calling/address', 'responseCode' => 202, ], 'input' => [ 'shape' => 'ValidateE911AddressRequest', ], 'output' => [ 'shape' => 'ValidateE911AddressResponse', ], 'errors' => [ [ 'shape' => 'UnauthorizedClientException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ThrottledClientException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ServiceFailureException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'Address' => [ 'type' => 'structure', 'members' => [ 'streetName' => [ 'shape' => 'SensitiveNonEmptyString', ], 'streetSuffix' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postDirectional' => [ 'shape' => 'SensitiveNonEmptyString', ], 'preDirectional' => [ 'shape' => 'SensitiveNonEmptyString', ], 'streetNumber' => [ 'shape' => 'SensitiveNonEmptyString', ], 'city' => [ 'shape' => 'SensitiveNonEmptyString', ], 'state' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCode' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCodePlus4' => [ 'shape' => 'SensitiveNonEmptyString', ], 'country' => [ 'shape' => 'SensitiveNonEmptyString', ], ], ], 'AlexaSkillId' => [ 'type' => 'string', 'max' => 64, 'pattern' => 'amzn1\\.application-oa2-client\\.[0-9a-fA-F]{32}', 'sensitive' => true, ], 'AlexaSkillIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlexaSkillId', ], 'max' => 1, 'min' => 1, ], 'AlexaSkillStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'Alpha2CountryCode' => [ 'type' => 'string', 'pattern' => '[A-Z]{2}', ], 'AreaCode' => [ 'type' => 'string', 'pattern' => '^$|^[0-9]{3,3}$', ], 'Arn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$', 'sensitive' => true, ], 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'ForceAssociate' => [ 'shape' => 'NullableBoolean', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'ForceAssociate' => [ 'shape' => 'NullableBoolean', ], ], ], 'AssociatePhoneNumbersWithVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'BatchDeletePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberIds', ], 'members' => [ 'PhoneNumberIds' => [ 'shape' => 'NonEmptyStringList', ], ], ], 'BatchDeletePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'BatchUpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'UpdatePhoneNumberRequestItems', ], 'members' => [ 'UpdatePhoneNumberRequestItems' => [ 'shape' => 'UpdatePhoneNumberRequestItemList', ], ], ], 'BatchUpdatePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'CallDetails' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', ], 'TransactionId' => [ 'shape' => 'NonEmptyString256', ], 'IsCaller' => [ 'shape' => 'Boolean', ], ], ], 'CallLegType' => [ 'type' => 'string', 'enum' => [ 'Caller', 'Callee', ], ], 'CallingName' => [ 'type' => 'string', 'pattern' => '^$|^[a-zA-Z0-9 ]{2,15}$', 'sensitive' => true, ], 'CallingNameStatus' => [ 'type' => 'string', 'enum' => [ 'Unassigned', 'UpdateInProgress', 'UpdateSucceeded', 'UpdateFailed', ], ], 'CallingRegion' => [ 'type' => 'string', ], 'CallingRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CallingRegion', ], ], 'CandidateAddress' => [ 'type' => 'structure', 'members' => [ 'streetInfo' => [ 'shape' => 'SensitiveNonEmptyString', ], 'streetNumber' => [ 'shape' => 'SensitiveNonEmptyString', ], 'city' => [ 'shape' => 'SensitiveNonEmptyString', ], 'state' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCode' => [ 'shape' => 'SensitiveNonEmptyString', ], 'postalCodePlus4' => [ 'shape' => 'SensitiveNonEmptyString', ], 'country' => [ 'shape' => 'SensitiveNonEmptyString', ], ], ], 'CandidateAddressList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CandidateAddress', ], ], 'Capability' => [ 'type' => 'string', 'enum' => [ 'Voice', 'SMS', ], ], 'CapabilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Capability', ], ], 'ClientRequestId' => [ 'type' => 'string', 'pattern' => '^[-_a-zA-Z0-9]*${2,64}$', ], 'ConfidenceScore' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Country' => [ 'type' => 'string', 'pattern' => '^$|^[A-Z]{2,2}$', ], 'CountryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Country', ], 'max' => 100, 'min' => 1, ], 'CpsLimit' => [ 'type' => 'integer', 'min' => 1, ], 'CreatePhoneNumberOrderRequest' => [ 'type' => 'structure', 'required' => [ 'ProductType', 'E164PhoneNumbers', ], 'members' => [ 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'CreatePhoneNumberOrderResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrder' => [ 'shape' => 'PhoneNumberOrder', ], ], ], 'CreateProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'ParticipantPhoneNumbers', 'Capabilities', 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ParticipantPhoneNumbers' => [ 'shape' => 'ParticipantPhoneNumberList', ], 'Name' => [ 'shape' => 'ProxySessionNameString', ], 'ExpiryMinutes' => [ 'shape' => 'PositiveInteger', ], 'Capabilities' => [ 'shape' => 'CapabilityList', ], 'NumberSelectionBehavior' => [ 'shape' => 'NumberSelectionBehavior', ], 'GeoMatchLevel' => [ 'shape' => 'GeoMatchLevel', ], 'GeoMatchParams' => [ 'shape' => 'GeoMatchParams', ], ], ], 'CreateProxySessionResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySession' => [ 'shape' => 'ProxySession', ], ], ], 'CreateSipMediaApplicationCallRequest' => [ 'type' => 'structure', 'required' => [ 'FromPhoneNumber', 'ToPhoneNumber', 'SipMediaApplicationId', ], 'members' => [ 'FromPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'ToPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'SipHeaders' => [ 'shape' => 'SipHeadersMap', ], 'ArgumentsMap' => [ 'shape' => 'SMACreateCallArgumentsMap', ], ], ], 'CreateSipMediaApplicationCallResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationCall' => [ 'shape' => 'SipMediaApplicationCall', ], ], ], 'CreateSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsRegion', 'Name', 'Endpoints', ], 'members' => [ 'AwsRegion' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'SipMediaApplicationName', ], 'Endpoints' => [ 'shape' => 'SipMediaApplicationEndpointList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateSipMediaApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplication' => [ 'shape' => 'SipMediaApplication', ], ], ], 'CreateSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'TriggerType', 'TriggerValue', ], 'members' => [ 'Name' => [ 'shape' => 'SipRuleName', ], 'TriggerType' => [ 'shape' => 'SipRuleTriggerType', ], 'TriggerValue' => [ 'shape' => 'NonEmptyString', ], 'Disabled' => [ 'shape' => 'NullableBoolean', ], 'TargetApplications' => [ 'shape' => 'SipRuleTargetApplicationList', ], ], ], 'CreateSipRuleResponse' => [ 'type' => 'structure', 'members' => [ 'SipRule' => [ 'shape' => 'SipRule', ], ], ], 'CreateVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'VoiceConnectorGroupName', ], 'VoiceConnectorItems' => [ 'shape' => 'VoiceConnectorItemList', ], ], ], 'CreateVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroup' => [ 'shape' => 'VoiceConnectorGroup', ], ], ], 'CreateVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'RequireEncryption', ], 'members' => [ 'Name' => [ 'shape' => 'VoiceConnectorName', ], 'AwsRegion' => [ 'shape' => 'VoiceConnectorAwsRegion', ], 'RequireEncryption' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnector', ], ], ], 'CreateVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ServerSideEncryptionConfiguration', ], 'members' => [ 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'ClientRequestToken' => [ 'shape' => 'ClientRequestId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateVoiceProfileDomainResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomain' => [ 'shape' => 'VoiceProfileDomain', ], ], ], 'CreateVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SpeakerSearchTaskId', ], 'members' => [ 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', ], ], ], 'CreateVoiceProfileResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfile' => [ 'shape' => 'VoiceProfile', ], ], ], 'Credential' => [ 'type' => 'structure', 'members' => [ 'Username' => [ 'shape' => 'SensitiveString', ], 'Password' => [ 'shape' => 'SensitiveString', ], ], ], 'CredentialList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Credential', ], ], 'DNISEmergencyCallingConfiguration' => [ 'type' => 'structure', 'required' => [ 'EmergencyPhoneNumber', 'CallingCountry', ], 'members' => [ 'EmergencyPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'TestPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'CallingCountry' => [ 'shape' => 'Alpha2CountryCode', ], ], ], 'DNISEmergencyCallingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DNISEmergencyCallingConfiguration', ], ], 'DataRetentionInHours' => [ 'type' => 'integer', 'min' => 0, ], 'DeletePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], ], ], 'DeleteProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'ProxySessionId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'proxySessionId', ], ], ], 'DeleteSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'DeleteSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'SipRuleId', ], 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipRuleId', ], ], ], 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], ], ], 'DeleteVoiceConnectorOriginationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorProxyRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorStreamingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceConnectorTerminationCredentialsRequest' => [ 'type' => 'structure', 'required' => [ 'Usernames', 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Usernames' => [ 'shape' => 'SensitiveStringList', ], ], ], 'DeleteVoiceConnectorTerminationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'DeleteVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileDomainId', ], ], ], 'DeleteVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileId', ], 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileId', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'E164PhoneNumbers', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], ], ], 'DisassociatePhoneNumbersFromVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberErrors' => [ 'shape' => 'PhoneNumberErrorList', ], ], ], 'E164PhoneNumber' => [ 'type' => 'string', 'pattern' => '^\\+?[1-9]\\d{1,14}$', 'sensitive' => true, ], 'E164PhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'E164PhoneNumber', ], ], 'EmergencyCallingConfiguration' => [ 'type' => 'structure', 'members' => [ 'DNIS' => [ 'shape' => 'DNISEmergencyCallingConfigurationList', ], ], ], 'ErrorCode' => [ 'type' => 'string', 'enum' => [ 'BadRequest', 'Conflict', 'Forbidden', 'NotFound', 'PreconditionFailed', 'ResourceLimitExceeded', 'ServiceFailure', 'AccessDenied', 'ServiceUnavailable', 'Throttled', 'Throttling', 'Unauthorized', 'Unprocessable', 'VoiceConnectorGroupAssociationsExist', 'PhoneNumberAssociationsExist', 'Gone', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'FunctionArn' => [ 'type' => 'string', 'max' => 10000, 'pattern' => 'arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?', 'sensitive' => true, ], 'GeoMatchLevel' => [ 'type' => 'string', 'enum' => [ 'Country', 'AreaCode', ], ], 'GeoMatchParams' => [ 'type' => 'structure', 'required' => [ 'Country', 'AreaCode', ], 'members' => [ 'Country' => [ 'shape' => 'Country', ], 'AreaCode' => [ 'shape' => 'AreaCode', ], ], ], 'GetGlobalSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnectorSettings', ], ], ], 'GetPhoneNumberOrderRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberOrderId', ], 'members' => [ 'PhoneNumberOrderId' => [ 'shape' => 'GuidString', 'location' => 'uri', 'locationName' => 'phoneNumberOrderId', ], ], ], 'GetPhoneNumberOrderResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrder' => [ 'shape' => 'PhoneNumberOrder', ], ], ], 'GetPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], ], ], 'GetPhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'GetPhoneNumberSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'CallingName' => [ 'shape' => 'CallingName', ], 'CallingNameUpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'GetProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'ProxySessionId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'proxySessionId', ], ], ], 'GetProxySessionResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySession' => [ 'shape' => 'ProxySession', ], ], ], 'GetSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'GetSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationAlexaSkillConfiguration' => [ 'shape' => 'SipMediaApplicationAlexaSkillConfiguration', ], ], ], 'GetSipMediaApplicationLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'GetSipMediaApplicationLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationLoggingConfiguration' => [ 'shape' => 'SipMediaApplicationLoggingConfiguration', ], ], ], 'GetSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], ], ], 'GetSipMediaApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplication' => [ 'shape' => 'SipMediaApplication', ], ], ], 'GetSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'SipRuleId', ], 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipRuleId', ], ], ], 'GetSipRuleResponse' => [ 'type' => 'structure', 'members' => [ 'SipRule' => [ 'shape' => 'SipRule', ], ], ], 'GetSpeakerSearchTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'SpeakerSearchTaskId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'SpeakerSearchTaskId', ], ], ], 'GetSpeakerSearchTaskResponse' => [ 'type' => 'structure', 'members' => [ 'SpeakerSearchTask' => [ 'shape' => 'SpeakerSearchTask', ], ], ], 'GetVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'EmergencyCallingConfiguration' => [ 'shape' => 'EmergencyCallingConfiguration', ], ], ], 'GetVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], ], ], 'GetVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroup' => [ 'shape' => 'VoiceConnectorGroup', ], ], ], 'GetVoiceConnectorLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'GetVoiceConnectorOriginationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorOriginationResponse' => [ 'type' => 'structure', 'members' => [ 'Origination' => [ 'shape' => 'Origination', ], ], ], 'GetVoiceConnectorProxyRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorProxyResponse' => [ 'type' => 'structure', 'members' => [ 'Proxy' => [ 'shape' => 'Proxy', ], ], ], 'GetVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnector', ], ], ], 'GetVoiceConnectorStreamingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorStreamingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'StreamingConfiguration' => [ 'shape' => 'StreamingConfiguration', ], ], ], 'GetVoiceConnectorTerminationHealthRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorTerminationHealthResponse' => [ 'type' => 'structure', 'members' => [ 'TerminationHealth' => [ 'shape' => 'TerminationHealth', ], ], ], 'GetVoiceConnectorTerminationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'GetVoiceConnectorTerminationResponse' => [ 'type' => 'structure', 'members' => [ 'Termination' => [ 'shape' => 'Termination', ], ], ], 'GetVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileDomainId', ], ], ], 'GetVoiceProfileDomainResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomain' => [ 'shape' => 'VoiceProfileDomain', ], ], ], 'GetVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileId', ], 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileId', ], ], ], 'GetVoiceProfileResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfile' => [ 'shape' => 'VoiceProfile', ], ], ], 'GetVoiceToneAnalysisTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'VoiceToneAnalysisTaskId', 'IsCaller', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'VoiceToneAnalysisTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceToneAnalysisTaskId', ], 'IsCaller' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'isCaller', ], ], ], 'GetVoiceToneAnalysisTaskResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceToneAnalysisTask' => [ 'shape' => 'VoiceToneAnalysisTask', ], ], ], 'GoneException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], 'GuidString' => [ 'type' => 'string', 'pattern' => '[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}', ], 'Integer' => [ 'type' => 'integer', ], 'Iso8601Timestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'LanguageCode' => [ 'type' => 'string', 'enum' => [ 'en-US', ], ], 'ListAvailableVoiceConnectorRegionsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorRegions' => [ 'shape' => 'VoiceConnectorAwsRegionList', ], ], ], 'ListPhoneNumberOrdersRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListPhoneNumberOrdersResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrders' => [ 'shape' => 'PhoneNumberOrderList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListPhoneNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'status', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', 'location' => 'querystring', 'locationName' => 'product-type', ], 'FilterName' => [ 'shape' => 'PhoneNumberAssociationName', 'location' => 'querystring', 'locationName' => 'filter-name', ], 'FilterValue' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'filter-value', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListPhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumbers' => [ 'shape' => 'PhoneNumberList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListProxySessionsRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Status' => [ 'shape' => 'ProxySessionStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'NextToken' => [ 'shape' => 'NextTokenString', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListProxySessionsResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySessions' => [ 'shape' => 'ProxySessions', ], 'NextToken' => [ 'shape' => 'NextTokenString', ], ], ], 'ListSipMediaApplicationsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'NextTokenString', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListSipMediaApplicationsResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplications' => [ 'shape' => 'SipMediaApplicationList', ], 'NextToken' => [ 'shape' => 'NextTokenString', ], ], ], 'ListSipRulesRequest' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'querystring', 'locationName' => 'sip-media-application', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'NextTokenString', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListSipRulesResponse' => [ 'type' => 'structure', 'members' => [ 'SipRules' => [ 'shape' => 'SipRuleList', ], 'NextToken' => [ 'shape' => 'NextTokenString', ], ], ], 'ListSupportedPhoneNumberCountriesRequest' => [ 'type' => 'structure', 'required' => [ 'ProductType', ], 'members' => [ 'ProductType' => [ 'shape' => 'PhoneNumberProductType', 'location' => 'querystring', 'locationName' => 'product-type', ], ], ], 'ListSupportedPhoneNumberCountriesResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberCountries' => [ 'shape' => 'PhoneNumberCountriesList', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ListVoiceConnectorGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceConnectorGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroups' => [ 'shape' => 'VoiceConnectorGroupList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListVoiceConnectorTerminationCredentialsRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], ], ], 'ListVoiceConnectorTerminationCredentialsResponse' => [ 'type' => 'structure', 'members' => [ 'Usernames' => [ 'shape' => 'SensitiveStringList', ], ], ], 'ListVoiceConnectorsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceConnectorsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectors' => [ 'shape' => 'VoiceConnectorList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListVoiceProfileDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceProfileDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomains' => [ 'shape' => 'VoiceProfileDomainSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListVoiceProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'querystring', 'locationName' => 'voice-profile-domain-id', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'ResultMax', 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVoiceProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfiles' => [ 'shape' => 'VoiceProfileSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'LoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableSIPLogs' => [ 'shape' => 'Boolean', ], 'EnableMediaMetricLogs' => [ 'shape' => 'Boolean', ], ], ], 'MediaInsightsConfiguration' => [ 'type' => 'structure', 'members' => [ 'Disabled' => [ 'shape' => 'Boolean', ], 'ConfigurationArn' => [ 'shape' => 'Arn', ], ], ], 'NextTokenString' => [ 'type' => 'string', 'max' => 65535, ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NonEmptyString128' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NonEmptyString256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NonEmptyStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NotificationTarget' => [ 'type' => 'string', 'enum' => [ 'EventBridge', 'SNS', 'SQS', ], ], 'NullableBoolean' => [ 'type' => 'boolean', ], 'NumberSelectionBehavior' => [ 'type' => 'string', 'enum' => [ 'PreferSticky', 'AvoidSticky', ], ], 'OrderedPhoneNumber' => [ 'type' => 'structure', 'members' => [ 'E164PhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'Status' => [ 'shape' => 'OrderedPhoneNumberStatus', ], ], ], 'OrderedPhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderedPhoneNumber', ], ], 'OrderedPhoneNumberStatus' => [ 'type' => 'string', 'enum' => [ 'Processing', 'Acquired', 'Failed', ], ], 'Origination' => [ 'type' => 'structure', 'members' => [ 'Routes' => [ 'shape' => 'OriginationRouteList', ], 'Disabled' => [ 'shape' => 'Boolean', ], ], ], 'OriginationRoute' => [ 'type' => 'structure', 'members' => [ 'Host' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Port', ], 'Protocol' => [ 'shape' => 'OriginationRouteProtocol', ], 'Priority' => [ 'shape' => 'OriginationRoutePriority', ], 'Weight' => [ 'shape' => 'OriginationRouteWeight', ], ], ], 'OriginationRouteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OriginationRoute', ], ], 'OriginationRoutePriority' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'OriginationRouteProtocol' => [ 'type' => 'string', 'enum' => [ 'TCP', 'UDP', ], ], 'OriginationRouteWeight' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'Participant' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'ProxyPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], ], ], 'ParticipantPhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'E164PhoneNumber', ], 'max' => 2, 'min' => 2, ], 'Participants' => [ 'type' => 'list', 'member' => [ 'shape' => 'Participant', ], ], 'PhoneNumber' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', ], 'E164PhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'Country' => [ 'shape' => 'Alpha2CountryCode', ], 'Type' => [ 'shape' => 'PhoneNumberType', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'Status' => [ 'shape' => 'PhoneNumberStatus', ], 'Capabilities' => [ 'shape' => 'PhoneNumberCapabilities', ], 'Associations' => [ 'shape' => 'PhoneNumberAssociationList', ], 'CallingName' => [ 'shape' => 'CallingName', ], 'CallingNameStatus' => [ 'shape' => 'CallingNameStatus', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'DeletionTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'OrderId' => [ 'shape' => 'GuidString', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'PhoneNumberAssociation' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'PhoneNumberAssociationName', ], 'AssociatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'PhoneNumberAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberAssociation', ], ], 'PhoneNumberAssociationName' => [ 'type' => 'string', 'enum' => [ 'VoiceConnectorId', 'VoiceConnectorGroupId', 'SipRuleId', ], ], 'PhoneNumberCapabilities' => [ 'type' => 'structure', 'members' => [ 'InboundCall' => [ 'shape' => 'NullableBoolean', ], 'OutboundCall' => [ 'shape' => 'NullableBoolean', ], 'InboundSMS' => [ 'shape' => 'NullableBoolean', ], 'OutboundSMS' => [ 'shape' => 'NullableBoolean', ], 'InboundMMS' => [ 'shape' => 'NullableBoolean', ], 'OutboundMMS' => [ 'shape' => 'NullableBoolean', ], ], ], 'PhoneNumberCountriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberCountry', ], ], 'PhoneNumberCountry' => [ 'type' => 'structure', 'members' => [ 'CountryCode' => [ 'shape' => 'Alpha2CountryCode', ], 'SupportedPhoneNumberTypes' => [ 'shape' => 'PhoneNumberTypeList', ], ], ], 'PhoneNumberError' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', ], 'ErrorCode' => [ 'shape' => 'ErrorCode', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'PhoneNumberErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberError', ], ], 'PhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumber', ], ], 'PhoneNumberMaxResults' => [ 'type' => 'integer', 'max' => 500, 'min' => 1, ], 'PhoneNumberName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^$|^[a-zA-Z0-9\\,\\.\\_\\-]+(\\s+[a-zA-Z0-9\\,\\.\\_\\-]+)*$', 'sensitive' => true, ], 'PhoneNumberOrder' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberOrderId' => [ 'shape' => 'GuidString', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'Status' => [ 'shape' => 'PhoneNumberOrderStatus', ], 'OrderType' => [ 'shape' => 'PhoneNumberOrderType', ], 'OrderedPhoneNumbers' => [ 'shape' => 'OrderedPhoneNumberList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'PhoneNumberOrderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberOrder', ], ], 'PhoneNumberOrderStatus' => [ 'type' => 'string', 'enum' => [ 'Processing', 'Successful', 'Failed', 'Partial', 'PendingDocuments', 'Submitted', 'FOC', 'ChangeRequested', 'Exception', 'CancelRequested', 'Cancelled', ], ], 'PhoneNumberOrderType' => [ 'type' => 'string', 'enum' => [ 'New', 'Porting', ], ], 'PhoneNumberProductType' => [ 'type' => 'string', 'enum' => [ 'VoiceConnector', 'SipMediaApplicationDialIn', ], ], 'PhoneNumberStatus' => [ 'type' => 'string', 'enum' => [ 'Cancelled', 'PortinCancelRequested', 'PortinInProgress', 'AcquireInProgress', 'AcquireFailed', 'Unassigned', 'Assigned', 'ReleaseInProgress', 'DeleteInProgress', 'ReleaseFailed', 'DeleteFailed', ], ], 'PhoneNumberType' => [ 'type' => 'string', 'enum' => [ 'Local', 'TollFree', ], ], 'PhoneNumberTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberType', ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'PositiveInteger' => [ 'type' => 'integer', 'min' => 1, ], 'Proxy' => [ 'type' => 'structure', 'members' => [ 'DefaultSessionExpiryMinutes' => [ 'shape' => 'Integer', ], 'Disabled' => [ 'shape' => 'Boolean', ], 'FallBackPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'PhoneNumberCountries' => [ 'shape' => 'StringList', ], ], ], 'ProxySession' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', ], 'Name' => [ 'shape' => 'String128', ], 'Status' => [ 'shape' => 'ProxySessionStatus', ], 'ExpiryMinutes' => [ 'shape' => 'PositiveInteger', ], 'Capabilities' => [ 'shape' => 'CapabilityList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'EndedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'Participants' => [ 'shape' => 'Participants', ], 'NumberSelectionBehavior' => [ 'shape' => 'NumberSelectionBehavior', ], 'GeoMatchLevel' => [ 'shape' => 'GeoMatchLevel', ], 'GeoMatchParams' => [ 'shape' => 'GeoMatchParams', ], ], ], 'ProxySessionNameString' => [ 'type' => 'string', 'pattern' => '^$|^[a-zA-Z0-9 ]{0,30}$', 'sensitive' => true, ], 'ProxySessionStatus' => [ 'type' => 'string', 'enum' => [ 'Open', 'InProgress', 'Closed', ], ], 'ProxySessions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProxySession', ], ], 'PutSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'SipMediaApplicationAlexaSkillConfiguration' => [ 'shape' => 'SipMediaApplicationAlexaSkillConfiguration', ], ], ], 'PutSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationAlexaSkillConfiguration' => [ 'shape' => 'SipMediaApplicationAlexaSkillConfiguration', ], ], ], 'PutSipMediaApplicationLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'SipMediaApplicationLoggingConfiguration' => [ 'shape' => 'SipMediaApplicationLoggingConfiguration', ], ], ], 'PutSipMediaApplicationLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationLoggingConfiguration' => [ 'shape' => 'SipMediaApplicationLoggingConfiguration', ], ], ], 'PutVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'EmergencyCallingConfiguration', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'EmergencyCallingConfiguration' => [ 'shape' => 'EmergencyCallingConfiguration', ], ], ], 'PutVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'EmergencyCallingConfiguration' => [ 'shape' => 'EmergencyCallingConfiguration', ], ], ], 'PutVoiceConnectorLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'LoggingConfiguration', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutVoiceConnectorLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutVoiceConnectorOriginationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Origination', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Origination' => [ 'shape' => 'Origination', ], ], ], 'PutVoiceConnectorOriginationResponse' => [ 'type' => 'structure', 'members' => [ 'Origination' => [ 'shape' => 'Origination', ], ], ], 'PutVoiceConnectorProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DefaultSessionExpiryMinutes', 'PhoneNumberPoolCountries', 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'DefaultSessionExpiryMinutes' => [ 'shape' => 'Integer', ], 'PhoneNumberPoolCountries' => [ 'shape' => 'CountryList', ], 'FallBackPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'Disabled' => [ 'shape' => 'Boolean', ], ], ], 'PutVoiceConnectorProxyResponse' => [ 'type' => 'structure', 'members' => [ 'Proxy' => [ 'shape' => 'Proxy', ], ], ], 'PutVoiceConnectorStreamingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'StreamingConfiguration', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'StreamingConfiguration' => [ 'shape' => 'StreamingConfiguration', ], ], ], 'PutVoiceConnectorStreamingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'StreamingConfiguration' => [ 'shape' => 'StreamingConfiguration', ], ], ], 'PutVoiceConnectorTerminationCredentialsRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Credentials' => [ 'shape' => 'CredentialList', ], ], ], 'PutVoiceConnectorTerminationRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Termination', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Termination' => [ 'shape' => 'Termination', ], ], ], 'PutVoiceConnectorTerminationResponse' => [ 'type' => 'structure', 'members' => [ 'Termination' => [ 'shape' => 'Termination', ], ], ], 'ResourceLimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'RestorePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], ], ], 'RestorePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'ResultMax' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'SMACreateCallArgumentsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'SensitiveString', ], 'value' => [ 'shape' => 'SensitiveString', ], 'max' => 20, 'min' => 0, ], 'SMAUpdateCallArgumentsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'SensitiveString', ], 'value' => [ 'shape' => 'SensitiveString', ], 'max' => 20, 'min' => 0, ], 'SearchAvailablePhoneNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'AreaCode' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'area-code', ], 'City' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'city', ], 'Country' => [ 'shape' => 'Alpha2CountryCode', 'location' => 'querystring', 'locationName' => 'country', ], 'State' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'state', ], 'TollFreePrefix' => [ 'shape' => 'TollFreePrefix', 'location' => 'querystring', 'locationName' => 'toll-free-prefix', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', 'location' => 'querystring', 'locationName' => 'phone-number-type', ], 'MaxResults' => [ 'shape' => 'PhoneNumberMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'SearchAvailablePhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'E164PhoneNumbers' => [ 'shape' => 'E164PhoneNumberList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'SensitiveNonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', 'sensitive' => true, ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'SensitiveStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveString', ], ], 'ServerSideEncryptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'KmsKeyArn', ], 'members' => [ 'KmsKeyArn' => [ 'shape' => 'Arn', ], ], ], 'ServiceFailureException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'SipApplicationPriority' => [ 'type' => 'integer', 'min' => 1, ], 'SipHeadersMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'SensitiveString', ], 'value' => [ 'shape' => 'SensitiveString', ], 'max' => 20, 'min' => 0, ], 'SipMediaApplication' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', ], 'AwsRegion' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'SipMediaApplicationName', ], 'Endpoints' => [ 'shape' => 'SipMediaApplicationEndpointList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'SipMediaApplicationArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'SipMediaApplicationAlexaSkillConfiguration' => [ 'type' => 'structure', 'required' => [ 'AlexaSkillStatus', 'AlexaSkillIds', ], 'members' => [ 'AlexaSkillStatus' => [ 'shape' => 'AlexaSkillStatus', ], 'AlexaSkillIds' => [ 'shape' => 'AlexaSkillIdList', ], ], ], 'SipMediaApplicationCall' => [ 'type' => 'structure', 'members' => [ 'TransactionId' => [ 'shape' => 'GuidString', ], ], ], 'SipMediaApplicationEndpoint' => [ 'type' => 'structure', 'members' => [ 'LambdaArn' => [ 'shape' => 'FunctionArn', ], ], ], 'SipMediaApplicationEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipMediaApplicationEndpoint', ], 'max' => 1, 'min' => 1, ], 'SipMediaApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipMediaApplication', ], ], 'SipMediaApplicationLoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableSipMediaApplicationMessageLogs' => [ 'shape' => 'Boolean', ], ], ], 'SipMediaApplicationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'SipRule' => [ 'type' => 'structure', 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', ], 'Name' => [ 'shape' => 'SipRuleName', ], 'Disabled' => [ 'shape' => 'Boolean', ], 'TriggerType' => [ 'shape' => 'SipRuleTriggerType', ], 'TriggerValue' => [ 'shape' => 'NonEmptyString', ], 'TargetApplications' => [ 'shape' => 'SipRuleTargetApplicationList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'SipRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipRule', ], ], 'SipRuleName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'SipRuleTargetApplication' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', ], 'Priority' => [ 'shape' => 'SipApplicationPriority', ], 'AwsRegion' => [ 'shape' => 'String', ], ], ], 'SipRuleTargetApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SipRuleTargetApplication', ], 'max' => 25, 'min' => 1, ], 'SipRuleTriggerType' => [ 'type' => 'string', 'enum' => [ 'ToPhoneNumber', 'RequestUriHostname', ], ], 'SpeakerSearchDetails' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SpeakerSearchResultList', ], 'VoiceprintGenerationStatus' => [ 'shape' => 'NonEmptyString256', ], ], ], 'SpeakerSearchResult' => [ 'type' => 'structure', 'members' => [ 'ConfidenceScore' => [ 'shape' => 'ConfidenceScore', ], 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', ], ], ], 'SpeakerSearchResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpeakerSearchResult', ], ], 'SpeakerSearchTask' => [ 'type' => 'structure', 'members' => [ 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', ], 'SpeakerSearchTaskStatus' => [ 'shape' => 'NonEmptyString', ], 'CallDetails' => [ 'shape' => 'CallDetails', ], 'SpeakerSearchDetails' => [ 'shape' => 'SpeakerSearchDetails', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StartedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'StartSpeakerSearchTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'TransactionId', 'VoiceProfileDomainId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'TransactionId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'ClientRequestToken' => [ 'shape' => 'ClientRequestId', ], 'CallLeg' => [ 'shape' => 'CallLegType', ], ], ], 'StartSpeakerSearchTaskResponse' => [ 'type' => 'structure', 'members' => [ 'SpeakerSearchTask' => [ 'shape' => 'SpeakerSearchTask', ], ], ], 'StartVoiceToneAnalysisTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'TransactionId', 'LanguageCode', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'TransactionId' => [ 'shape' => 'NonEmptyString256', ], 'LanguageCode' => [ 'shape' => 'LanguageCode', ], 'ClientRequestToken' => [ 'shape' => 'ClientRequestId', ], ], ], 'StartVoiceToneAnalysisTaskResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceToneAnalysisTask' => [ 'shape' => 'VoiceToneAnalysisTask', ], ], ], 'StopSpeakerSearchTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'SpeakerSearchTaskId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'SpeakerSearchTaskId', ], ], ], 'StopVoiceToneAnalysisTaskRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'VoiceToneAnalysisTaskId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'VoiceConnectorId', ], 'VoiceToneAnalysisTaskId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceToneAnalysisTaskId', ], ], ], 'StreamingConfiguration' => [ 'type' => 'structure', 'required' => [ 'DataRetentionInHours', 'Disabled', ], 'members' => [ 'DataRetentionInHours' => [ 'shape' => 'DataRetentionInHours', ], 'Disabled' => [ 'shape' => 'Boolean', ], 'StreamingNotificationTargets' => [ 'shape' => 'StreamingNotificationTargetList', ], 'MediaInsightsConfiguration' => [ 'shape' => 'MediaInsightsConfiguration', ], ], ], 'StreamingNotificationTarget' => [ 'type' => 'structure', 'members' => [ 'NotificationTarget' => [ 'shape' => 'NotificationTarget', ], ], ], 'StreamingNotificationTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StreamingNotificationTarget', ], 'max' => 3, 'min' => 1, ], 'String' => [ 'type' => 'string', ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'sensitive' => true, ], 'Termination' => [ 'type' => 'structure', 'members' => [ 'CpsLimit' => [ 'shape' => 'CpsLimit', ], 'DefaultPhoneNumber' => [ 'shape' => 'E164PhoneNumber', ], 'CallingRegions' => [ 'shape' => 'CallingRegionList', ], 'CidrAllowedList' => [ 'shape' => 'StringList', ], 'Disabled' => [ 'shape' => 'Boolean', ], ], ], 'TerminationHealth' => [ 'type' => 'structure', 'members' => [ 'Timestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'Source' => [ 'shape' => 'String', ], ], ], 'ThrottledClientException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TollFreePrefix' => [ 'type' => 'string', 'max' => 3, 'min' => 3, 'pattern' => '^8(00|33|44|55|66|77|88)$', ], 'UnauthorizedClientException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'UnprocessableEntityException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 422, ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'Arn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UpdateGlobalSettingsRequest' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnectorSettings', ], ], ], 'UpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', 'location' => 'uri', 'locationName' => 'phoneNumberId', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'CallingName' => [ 'shape' => 'CallingName', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'UpdatePhoneNumberRequestItem' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'SensitiveNonEmptyString', ], 'ProductType' => [ 'shape' => 'PhoneNumberProductType', ], 'CallingName' => [ 'shape' => 'CallingName', ], 'Name' => [ 'shape' => 'PhoneNumberName', ], ], ], 'UpdatePhoneNumberRequestItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdatePhoneNumberRequestItem', ], ], 'UpdatePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'UpdatePhoneNumberSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'CallingName', ], 'members' => [ 'CallingName' => [ 'shape' => 'CallingName', ], ], ], 'UpdateProxySessionRequest' => [ 'type' => 'structure', 'required' => [ 'Capabilities', 'VoiceConnectorId', 'ProxySessionId', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'ProxySessionId' => [ 'shape' => 'NonEmptyString128', 'location' => 'uri', 'locationName' => 'proxySessionId', ], 'Capabilities' => [ 'shape' => 'CapabilityList', ], 'ExpiryMinutes' => [ 'shape' => 'PositiveInteger', ], ], ], 'UpdateProxySessionResponse' => [ 'type' => 'structure', 'members' => [ 'ProxySession' => [ 'shape' => 'ProxySession', ], ], ], 'UpdateSipMediaApplicationCallRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', 'TransactionId', 'Arguments', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'TransactionId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'transactionId', ], 'Arguments' => [ 'shape' => 'SMAUpdateCallArgumentsMap', ], ], ], 'UpdateSipMediaApplicationCallResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplicationCall' => [ 'shape' => 'SipMediaApplicationCall', ], ], ], 'UpdateSipMediaApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'SipMediaApplicationId', ], 'members' => [ 'SipMediaApplicationId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipMediaApplicationId', ], 'Name' => [ 'shape' => 'SipMediaApplicationName', ], 'Endpoints' => [ 'shape' => 'SipMediaApplicationEndpointList', ], ], ], 'UpdateSipMediaApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'SipMediaApplication' => [ 'shape' => 'SipMediaApplication', ], ], ], 'UpdateSipRuleRequest' => [ 'type' => 'structure', 'required' => [ 'SipRuleId', 'Name', ], 'members' => [ 'SipRuleId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'sipRuleId', ], 'Name' => [ 'shape' => 'SipRuleName', ], 'Disabled' => [ 'shape' => 'NullableBoolean', ], 'TargetApplications' => [ 'shape' => 'SipRuleTargetApplicationList', ], ], ], 'UpdateSipRuleResponse' => [ 'type' => 'structure', 'members' => [ 'SipRule' => [ 'shape' => 'SipRule', ], ], ], 'UpdateVoiceConnectorGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorGroupId', 'Name', 'VoiceConnectorItems', ], 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorGroupId', ], 'Name' => [ 'shape' => 'VoiceConnectorGroupName', ], 'VoiceConnectorItems' => [ 'shape' => 'VoiceConnectorItemList', ], ], ], 'UpdateVoiceConnectorGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroup' => [ 'shape' => 'VoiceConnectorGroup', ], ], ], 'UpdateVoiceConnectorRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Name', 'RequireEncryption', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', 'location' => 'uri', 'locationName' => 'voiceConnectorId', ], 'Name' => [ 'shape' => 'VoiceConnectorName', ], 'RequireEncryption' => [ 'shape' => 'Boolean', ], ], ], 'UpdateVoiceConnectorResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceConnector' => [ 'shape' => 'VoiceConnector', ], ], ], 'UpdateVoiceProfileDomainRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileDomainId', ], 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileDomainId', ], 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], ], ], 'UpdateVoiceProfileDomainResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomain' => [ 'shape' => 'VoiceProfileDomain', ], ], ], 'UpdateVoiceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'VoiceProfileId', 'SpeakerSearchTaskId', ], 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', 'location' => 'uri', 'locationName' => 'VoiceProfileId', ], 'SpeakerSearchTaskId' => [ 'shape' => 'NonEmptyString256', ], ], ], 'UpdateVoiceProfileResponse' => [ 'type' => 'structure', 'members' => [ 'VoiceProfile' => [ 'shape' => 'VoiceProfile', ], ], ], 'ValidateE911AddressRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'StreetNumber', 'StreetInfo', 'City', 'State', 'Country', 'PostalCode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'NonEmptyString', ], 'StreetNumber' => [ 'shape' => 'SensitiveNonEmptyString', ], 'StreetInfo' => [ 'shape' => 'SensitiveNonEmptyString', ], 'City' => [ 'shape' => 'SensitiveNonEmptyString', ], 'State' => [ 'shape' => 'SensitiveNonEmptyString', ], 'Country' => [ 'shape' => 'SensitiveNonEmptyString', ], 'PostalCode' => [ 'shape' => 'SensitiveNonEmptyString', ], ], ], 'ValidateE911AddressResponse' => [ 'type' => 'structure', 'members' => [ 'ValidationResult' => [ 'shape' => 'ValidationResult', ], 'AddressExternalId' => [ 'shape' => 'String', ], 'Address' => [ 'shape' => 'Address', ], 'CandidateAddressList' => [ 'shape' => 'CandidateAddressList', ], ], ], 'ValidationResult' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'VoiceConnector' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', ], 'AwsRegion' => [ 'shape' => 'VoiceConnectorAwsRegion', ], 'Name' => [ 'shape' => 'VoiceConnectorName', ], 'OutboundHostName' => [ 'shape' => 'String', ], 'RequireEncryption' => [ 'shape' => 'Boolean', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'VoiceConnectorArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'VoiceConnectorAwsRegion' => [ 'type' => 'string', 'enum' => [ 'us-east-1', 'us-west-2', 'ca-central-1', 'eu-central-1', 'eu-west-1', 'eu-west-2', 'ap-northeast-2', 'ap-northeast-1', 'ap-southeast-1', 'ap-southeast-2', ], ], 'VoiceConnectorAwsRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnectorAwsRegion', ], ], 'VoiceConnectorGroup' => [ 'type' => 'structure', 'members' => [ 'VoiceConnectorGroupId' => [ 'shape' => 'NonEmptyString', ], 'Name' => [ 'shape' => 'VoiceConnectorGroupName', ], 'VoiceConnectorItems' => [ 'shape' => 'VoiceConnectorItemList', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'VoiceConnectorGroupArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'VoiceConnectorGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnectorGroup', ], ], 'VoiceConnectorGroupName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'VoiceConnectorItem' => [ 'type' => 'structure', 'required' => [ 'VoiceConnectorId', 'Priority', ], 'members' => [ 'VoiceConnectorId' => [ 'shape' => 'NonEmptyString', ], 'Priority' => [ 'shape' => 'VoiceConnectorItemPriority', ], ], ], 'VoiceConnectorItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnectorItem', ], ], 'VoiceConnectorItemPriority' => [ 'type' => 'integer', 'max' => 99, 'min' => 1, ], 'VoiceConnectorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceConnector', ], ], 'VoiceConnectorName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'VoiceConnectorSettings' => [ 'type' => 'structure', 'members' => [ 'CdrBucket' => [ 'shape' => 'String', ], ], ], 'VoiceProfile' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileArn' => [ 'shape' => 'Arn', ], 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'ExpirationTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileDomain' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileDomainArn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileDomainDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'VoiceProfileDomainName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9 _.-]+', ], 'VoiceProfileDomainSummary' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileDomainArn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'VoiceProfileDomainName', ], 'Description' => [ 'shape' => 'VoiceProfileDomainDescription', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileDomainSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceProfileDomainSummary', ], ], 'VoiceProfileSummary' => [ 'type' => 'structure', 'members' => [ 'VoiceProfileId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceProfileArn' => [ 'shape' => 'Arn', ], 'VoiceProfileDomainId' => [ 'shape' => 'NonEmptyString256', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'ExpirationTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], ], ], 'VoiceProfileSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VoiceProfileSummary', ], ], 'VoiceToneAnalysisTask' => [ 'type' => 'structure', 'members' => [ 'VoiceToneAnalysisTaskId' => [ 'shape' => 'NonEmptyString256', ], 'VoiceToneAnalysisTaskStatus' => [ 'shape' => 'NonEmptyString', ], 'CallDetails' => [ 'shape' => 'CallDetails', ], 'CreatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'UpdatedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StartedTimestamp' => [ 'shape' => 'Iso8601Timestamp', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], ],]; diff --git a/src/data/chime-sdk-voice/2022-08-03/docs-2.json b/src/data/chime-sdk-voice/2022-08-03/docs-2.json index 5b7e428aba..fa534fcceb 100644 --- a/src/data/chime-sdk-voice/2022-08-03/docs-2.json +++ b/src/data/chime-sdk-voice/2022-08-03/docs-2.json @@ -5,7 +5,7 @@ "AssociatePhoneNumbersWithVoiceConnector": "

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

", "AssociatePhoneNumbersWithVoiceConnectorGroup": "

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

", "BatchDeletePhoneNumber": "

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

", - "BatchUpdatePhoneNumber": "

Updates one or more phone numbers.

", + "BatchUpdatePhoneNumber": "

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.

You cannot have a duplicate phoneNumberId in a request.

", "CreatePhoneNumberOrder": "

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

", "CreateProxySession": "

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

", "CreateSipMediaApplication": "

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

", @@ -37,7 +37,7 @@ "GetPhoneNumberSettings": "

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

", "GetProxySession": "

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

", "GetSipMediaApplication": "

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

", - "GetSipMediaApplicationAlexaSkillConfiguration": "

Gets the Alexa Skill configuration for the SIP media application.

", + "GetSipMediaApplicationAlexaSkillConfiguration": "

Gets the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

", "GetSipMediaApplicationLoggingConfiguration": "

Retrieves the logging configuration for the specified SIP media application.

", "GetSipRule": "

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

", "GetSpeakerSearchTask": "

Retrieves the details of the specified speaker search task.

", @@ -66,7 +66,7 @@ "ListVoiceConnectors": "

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

", "ListVoiceProfileDomains": "

Lists the specified voice profile domains in the administrator's AWS account.

", "ListVoiceProfiles": "

Lists the voice profiles in a voice profile domain.

", - "PutSipMediaApplicationAlexaSkillConfiguration": "

Updates the Alexa Skill configuration for the SIP media application.

", + "PutSipMediaApplicationAlexaSkillConfiguration": "

Updates the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

", "PutSipMediaApplicationLoggingConfiguration": "

Updates the logging configuration for the specified SIP media application.

", "PutVoiceConnectorEmergencyCallingConfiguration": "

Updates a Voice Connector's emergency calling configuration.

", "PutVoiceConnectorLoggingConfiguration": "

Updates a Voice Connector's logging configuration.

", @@ -84,7 +84,7 @@ "TagResource": "

Adds a tag to the specified resource.

", "UntagResource": "

Removes tags from a resource.

", "UpdateGlobalSettings": "

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

", - "UpdatePhoneNumber": "

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

", + "UpdatePhoneNumber": "

Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type, calling name, or phone number name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

", "UpdatePhoneNumberSettings": "

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

", "UpdateProxySession": "

Updates the specified proxy session details, such as voice or SMS capabilities.

", "UpdateSipMediaApplication": "

Updates the details of the specified SIP media application.

", @@ -1341,7 +1341,7 @@ "refs": { "CreatePhoneNumberOrderRequest$Name": "

Specifies the name assigned to one or more phone numbers.

", "PhoneNumber$Name": "

The name of the phone number.

", - "UpdatePhoneNumberRequest$Name": "

Specifies the name assigned to one or more phone numbers.

", + "UpdatePhoneNumberRequest$Name": "

Specifies the updated name assigned to one or more phone numbers.

", "UpdatePhoneNumberRequestItem$Name": "

The name of the phone number.

" } }, @@ -1683,7 +1683,7 @@ } }, "SipMediaApplicationAlexaSkillConfiguration": { - "base": "

The Alexa Skill configuration of a SIP media application.

", + "base": "

The Alexa Skill configuration of a SIP media application.

Due to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to the Alexa Smart Properties page.

", "refs": { "GetSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration": "

Returns the Alexa Skill configuration.

", "PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationAlexaSkillConfiguration": "

The Alexa Skill configuration.

", diff --git a/src/data/chime-sdk-voice/2022-08-03/docs-2.json.php b/src/data/chime-sdk-voice/2022-08-03/docs-2.json.php index 7a655ad5cc..5bec9383f9 100644 --- a/src/data/chime-sdk-voice/2022-08-03/docs-2.json.php +++ b/src/data/chime-sdk-voice/2022-08-03/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

', 'operations' => [ 'AssociatePhoneNumbersWithVoiceConnector' => '

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

', 'AssociatePhoneNumbersWithVoiceConnectorGroup' => '

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

', 'BatchDeletePhoneNumber' => '

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

', 'BatchUpdatePhoneNumber' => '

Updates one or more phone numbers.

', 'CreatePhoneNumberOrder' => '

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

', 'CreateProxySession' => '

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

', 'CreateSipMediaApplication' => '

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

', 'CreateSipMediaApplicationCall' => '

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

', 'CreateSipRule' => '

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

', 'CreateVoiceConnector' => '

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

', 'CreateVoiceConnectorGroup' => '

Creates an Amazon Chime SDK Voice Connector group under the administrator\'s AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

', 'CreateVoiceProfile' => '

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

', 'CreateVoiceProfileDomain' => '

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

', 'DeletePhoneNumber' => '

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.

', 'DeleteProxySession' => '

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

', 'DeleteSipMediaApplication' => '

Deletes a SIP media application.

', 'DeleteSipRule' => '

Deletes a SIP rule.

', 'DeleteVoiceConnector' => '

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

', 'DeleteVoiceConnectorEmergencyCallingConfiguration' => '

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

', 'DeleteVoiceConnectorGroup' => '

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

', 'DeleteVoiceConnectorOrigination' => '

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

', 'DeleteVoiceConnectorProxy' => '

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

', 'DeleteVoiceConnectorStreamingConfiguration' => '

Deletes a Voice Connector\'s streaming configuration.

', 'DeleteVoiceConnectorTermination' => '

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

', 'DeleteVoiceConnectorTerminationCredentials' => '

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

', 'DeleteVoiceProfile' => '

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

', 'DeleteVoiceProfileDomain' => '

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

', 'DisassociatePhoneNumbersFromVoiceConnector' => '

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroup' => '

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

', 'GetGlobalSettings' => '

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

', 'GetPhoneNumber' => '

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

', 'GetPhoneNumberOrder' => '

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

', 'GetPhoneNumberSettings' => '

Retrieves the phone number settings for the administrator\'s AWS account, such as the default outbound calling name.

', 'GetProxySession' => '

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

', 'GetSipMediaApplication' => '

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

', 'GetSipMediaApplicationAlexaSkillConfiguration' => '

Gets the Alexa Skill configuration for the SIP media application.

', 'GetSipMediaApplicationLoggingConfiguration' => '

Retrieves the logging configuration for the specified SIP media application.

', 'GetSipRule' => '

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

', 'GetSpeakerSearchTask' => '

Retrieves the details of the specified speaker search task.

', 'GetVoiceConnector' => '

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

', 'GetVoiceConnectorEmergencyCallingConfiguration' => '

Retrieves the emergency calling configuration details for the specified Voice Connector.

', 'GetVoiceConnectorGroup' => '

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

', 'GetVoiceConnectorLoggingConfiguration' => '

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

', 'GetVoiceConnectorOrigination' => '

Retrieves the origination settings for the specified Voice Connector.

', 'GetVoiceConnectorProxy' => '

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

', 'GetVoiceConnectorStreamingConfiguration' => '

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

', 'GetVoiceConnectorTermination' => '

Retrieves the termination setting details for the specified Voice Connector.

', 'GetVoiceConnectorTerminationHealth' => '

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

', 'GetVoiceProfile' => '

Retrieves the details of the specified voice profile.

', 'GetVoiceProfileDomain' => '

Retrieves the details of the specified voice profile domain.

', 'GetVoiceToneAnalysisTask' => '

Retrieves the details of a voice tone analysis task.

', 'ListAvailableVoiceConnectorRegions' => '

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

', 'ListPhoneNumberOrders' => '

Lists the phone numbers for an administrator\'s Amazon Chime SDK account.

', 'ListPhoneNumbers' => '

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

', 'ListProxySessions' => '

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

', 'ListSipMediaApplications' => '

Lists the SIP media applications under the administrator\'s AWS account.

', 'ListSipRules' => '

Lists the SIP rules under the administrator\'s AWS account.

', 'ListSupportedPhoneNumberCountries' => '

Lists the countries that you can order phone numbers from.

', 'ListTagsForResource' => '

Returns a list of the tags in a given resource.

', 'ListVoiceConnectorGroups' => '

Lists the Amazon Chime SDK Voice Connector groups in the administrator\'s AWS account.

', 'ListVoiceConnectorTerminationCredentials' => '

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

', 'ListVoiceConnectors' => '

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

', 'ListVoiceProfileDomains' => '

Lists the specified voice profile domains in the administrator\'s AWS account.

', 'ListVoiceProfiles' => '

Lists the voice profiles in a voice profile domain.

', 'PutSipMediaApplicationAlexaSkillConfiguration' => '

Updates the Alexa Skill configuration for the SIP media application.

', 'PutSipMediaApplicationLoggingConfiguration' => '

Updates the logging configuration for the specified SIP media application.

', 'PutVoiceConnectorEmergencyCallingConfiguration' => '

Updates a Voice Connector\'s emergency calling configuration.

', 'PutVoiceConnectorLoggingConfiguration' => '

Updates a Voice Connector\'s logging configuration.

', 'PutVoiceConnectorOrigination' => '

Updates a Voice Connector\'s origination settings.

', 'PutVoiceConnectorProxy' => '

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

', 'PutVoiceConnectorStreamingConfiguration' => '

Updates a Voice Connector\'s streaming configuration settings.

', 'PutVoiceConnectorTermination' => '

Updates a Voice Connector\'s termination settings.

', 'PutVoiceConnectorTerminationCredentials' => '

Updates a Voice Connector\'s termination credentials.

', 'RestorePhoneNumber' => '

Restores a deleted phone number.

', 'SearchAvailablePhoneNumbers' => '

Searches the provisioned phone numbers in an organization.

', 'StartSpeakerSearchTask' => '

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

', 'StartVoiceToneAnalysisTask' => '

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

', 'StopSpeakerSearchTask' => '

Stops a speaker search task.

', 'StopVoiceToneAnalysisTask' => '

Stops a voice tone analysis task.

', 'TagResource' => '

Adds a tag to the specified resource.

', 'UntagResource' => '

Removes tags from a resource.

', 'UpdateGlobalSettings' => '

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

', 'UpdatePhoneNumber' => '

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

', 'UpdatePhoneNumberSettings' => '

Updates the phone number settings for the administrator\'s AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

', 'UpdateProxySession' => '

Updates the specified proxy session details, such as voice or SMS capabilities.

', 'UpdateSipMediaApplication' => '

Updates the details of the specified SIP media application.

', 'UpdateSipMediaApplicationCall' => '

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

', 'UpdateSipRule' => '

Updates the details of the specified SIP rule.

', 'UpdateVoiceConnector' => '

Updates the details for the specified Amazon Chime SDK Voice Connector.

', 'UpdateVoiceConnectorGroup' => '

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

', 'UpdateVoiceProfile' => '

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

', 'UpdateVoiceProfileDomain' => '

Updates the settings for the specified voice profile domain.

', 'ValidateE911Address' => '

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

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

You don\'t have the permissions needed to run this action.

', 'refs' => [], ], 'Address' => [ 'base' => '

A validated address.

', 'refs' => [ 'ValidateE911AddressResponse$Address' => '

The validated address.

', ], ], 'AlexaSkillId' => [ 'base' => NULL, 'refs' => [ 'AlexaSkillIdList$member' => NULL, ], ], 'AlexaSkillIdList' => [ 'base' => NULL, 'refs' => [ 'SipMediaApplicationAlexaSkillConfiguration$AlexaSkillIds' => '

The ID of the Alexa Skill configuration.

', ], ], 'AlexaSkillStatus' => [ 'base' => NULL, 'refs' => [ 'SipMediaApplicationAlexaSkillConfiguration$AlexaSkillStatus' => '

The status of the Alexa Skill configuration.

', ], ], 'Alpha2CountryCode' => [ 'base' => NULL, 'refs' => [ 'DNISEmergencyCallingConfiguration$CallingCountry' => '

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

', 'PhoneNumber$Country' => '

The phone number\'s country. Format: ISO 3166-1 alpha-2.

', 'PhoneNumberCountry$CountryCode' => '

The phone number country code. Format: ISO 3166-1 alpha-2.

', 'SearchAvailablePhoneNumbersRequest$Country' => '

Confines a search to just the phone numbers associated with the specified country.

', ], ], 'AreaCode' => [ 'base' => NULL, 'refs' => [ 'GeoMatchParams$AreaCode' => '

The area code.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => '

The resource ARN.

', 'MediaInsightsConfiguration$ConfigurationArn' => '

The configuration\'s ARN.

', 'ServerSideEncryptionConfiguration$KmsKeyArn' => '

The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

', 'TagResourceRequest$ResourceARN' => '

The ARN of the resource being tagged.

', 'UntagResourceRequest$ResourceARN' => '

The ARN of the resource having its tags removed.

', 'VoiceProfile$VoiceProfileArn' => '

The ARN of the voice profile.

', 'VoiceProfileDomain$VoiceProfileDomainArn' => '

The voice profile domain\'s Amazon Resource Number (ARN).

', 'VoiceProfileDomainSummary$VoiceProfileDomainArn' => '

The ARN of a voice profile in a voice profile domain summary.

', 'VoiceProfileSummary$VoiceProfileArn' => '

The ARN of the voice profile in a voice profile summary.

', ], ], 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePhoneNumbersWithVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePhoneNumbersWithVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'BadRequestException' => [ 'base' => '

The input parameters don\'t match the service\'s restrictions.

', 'refs' => [], ], 'BatchDeletePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchUpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchUpdatePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CallDetails$IsCaller' => '

Identifies a person as the caller or the callee.

', 'CreateVoiceConnectorRequest$RequireEncryption' => '

Enables or disables encryption for the Voice Connector.

', 'GetVoiceToneAnalysisTaskRequest$IsCaller' => '

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

', 'LoggingConfiguration$EnableSIPLogs' => '

Boolean that enables sending SIP message logs to Amazon CloudWatch.

', 'LoggingConfiguration$EnableMediaMetricLogs' => '

Enables or disables media metrics logging.

', 'MediaInsightsConfiguration$Disabled' => '

Denotes the configration as enabled or disabled.

', 'Origination$Disabled' => '

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

', 'Proxy$Disabled' => '

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

', 'PutVoiceConnectorProxyRequest$Disabled' => '

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

', 'SipMediaApplicationLoggingConfiguration$EnableSipMediaApplicationMessageLogs' => '

Enables message logging for the specified SIP media application.

', 'SipRule$Disabled' => '

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

', 'StreamingConfiguration$Disabled' => '

When true, streaming to Kinesis is off.

', 'Termination$Disabled' => '

When termination is disabled, outbound calls cannot be made.

', 'UpdateVoiceConnectorRequest$RequireEncryption' => '

When enabled, requires encryption for the Voice Connector.

', 'VoiceConnector$RequireEncryption' => '

Enables or disables encryption for the Voice Connector.

', ], ], 'CallDetails' => [ 'base' => '

The details of an Amazon Chime SDK Voice Connector call.

', 'refs' => [ 'SpeakerSearchTask$CallDetails' => '

The call details of a speaker search task.

', 'VoiceToneAnalysisTask$CallDetails' => '

The call details of a voice tone analysis task.

', ], ], 'CallLegType' => [ 'base' => NULL, 'refs' => [ 'StartSpeakerSearchTaskRequest$CallLeg' => '

Specifies which call leg to stream for speaker search.

', ], ], 'CallingName' => [ 'base' => NULL, 'refs' => [ 'GetPhoneNumberSettingsResponse$CallingName' => '

The default outbound calling name for the account.

', 'PhoneNumber$CallingName' => '

The outbound calling name associated with the phone number.

', 'UpdatePhoneNumberRequest$CallingName' => '

The outbound calling name associated with the phone number.

', 'UpdatePhoneNumberRequestItem$CallingName' => '

The outbound calling name to update.

', 'UpdatePhoneNumberSettingsRequest$CallingName' => '

The default outbound calling name for the account.

', ], ], 'CallingNameStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$CallingNameStatus' => '

The outbound calling name status.

', ], ], 'CallingRegion' => [ 'base' => NULL, 'refs' => [ 'CallingRegionList$member' => NULL, ], ], 'CallingRegionList' => [ 'base' => NULL, 'refs' => [ 'Termination$CallingRegions' => '

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

', ], ], 'CandidateAddress' => [ 'base' => '

A suggested address.

', 'refs' => [ 'CandidateAddressList$member' => NULL, ], ], 'CandidateAddressList' => [ 'base' => NULL, 'refs' => [ 'ValidateE911AddressResponse$CandidateAddressList' => '

The list of address suggestions..

', ], ], 'Capability' => [ 'base' => NULL, 'refs' => [ 'CapabilityList$member' => NULL, ], ], 'CapabilityList' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$Capabilities' => '

The proxy session\'s capabilities.

', 'ProxySession$Capabilities' => '

The proxy session capabilities.

', 'UpdateProxySessionRequest$Capabilities' => '

The proxy session capabilities.

', ], ], 'ClientRequestId' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceProfileDomainRequest$ClientRequestToken' => '

The unique identifier for the client request. Use a different token for different domain creation requests.

', 'StartSpeakerSearchTaskRequest$ClientRequestToken' => '

The unique identifier for the client request. Use a different token for different speaker search tasks.

', 'StartVoiceToneAnalysisTaskRequest$ClientRequestToken' => '

The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

', ], ], 'ConfidenceScore' => [ 'base' => NULL, 'refs' => [ 'SpeakerSearchResult$ConfidenceScore' => '

The confidence score in the speaker search analysis.

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

Multiple instances of the same request were made simultaneously.

', 'refs' => [], ], 'Country' => [ 'base' => NULL, 'refs' => [ 'CountryList$member' => NULL, 'GeoMatchParams$Country' => '

The country.

', ], ], 'CountryList' => [ 'base' => NULL, 'refs' => [ 'PutVoiceConnectorProxyRequest$PhoneNumberPoolCountries' => '

The countries for proxy phone numbers to be selected from.

', ], ], 'CpsLimit' => [ 'base' => NULL, 'refs' => [ 'Termination$CpsLimit' => '

The limit on calls per second. Max value based on account service quota. Default value of 1.

', ], ], 'CreatePhoneNumberOrderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePhoneNumberOrderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProxySessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationCallRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationCallResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'Credential' => [ 'base' => '

The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'CredentialList$member' => NULL, ], ], 'CredentialList' => [ 'base' => NULL, 'refs' => [ 'PutVoiceConnectorTerminationCredentialsRequest$Credentials' => '

The termination credentials being updated.

', ], ], 'DNISEmergencyCallingConfiguration' => [ 'base' => '

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector\'s emergency calling configuration.

', 'refs' => [ 'DNISEmergencyCallingConfigurationList$member' => NULL, ], ], 'DNISEmergencyCallingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'EmergencyCallingConfiguration$DNIS' => '

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

', ], ], 'DataRetentionInHours' => [ 'base' => NULL, 'refs' => [ 'StreamingConfiguration$DataRetentionInHours' => '

The amount of time, in hours, to the Kinesis data.

', ], ], 'DeletePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorOriginationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorStreamingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorTerminationCredentialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorTerminationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'E164PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationCallRequest$FromPhoneNumber' => '

The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

', 'CreateSipMediaApplicationCallRequest$ToPhoneNumber' => '

The phone number that the service should call.

', 'DNISEmergencyCallingConfiguration$EmergencyPhoneNumber' => '

The DNIS phone number that you route emergency calls to, in E.164 format.

', 'DNISEmergencyCallingConfiguration$TestPhoneNumber' => '

The DNIS phone number for routing test emergency calls to, in E.164 format.

', 'E164PhoneNumberList$member' => NULL, 'OrderedPhoneNumber$E164PhoneNumber' => '

The phone number, in E.164 format.

', 'Participant$PhoneNumber' => '

The participant\'s phone number.

', 'Participant$ProxyPhoneNumber' => '

The participant\'s proxy phone number.

', 'ParticipantPhoneNumberList$member' => NULL, 'PhoneNumber$E164PhoneNumber' => '

The phone number, in E.164 format.

', 'Proxy$FallBackPhoneNumber' => '

The phone number to route calls to after a proxy session expires.

', 'PutVoiceConnectorProxyRequest$FallBackPhoneNumber' => '

The phone number to route calls to after a proxy session expires.

', 'Termination$DefaultPhoneNumber' => '

The default outbound calling number.

', ], ], 'E164PhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'AssociatePhoneNumbersWithVoiceConnectorRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'CreatePhoneNumberOrderRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$E164PhoneNumbers' => '

The list of phone numbers, in E.164 format.

', 'DisassociatePhoneNumbersFromVoiceConnectorRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'SearchAvailablePhoneNumbersResponse$E164PhoneNumbers' => '

Confines a search to just the phone numbers in the E.164 format.

', ], ], 'EmergencyCallingConfiguration' => [ 'base' => '

The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration' => '

The details of the emergency calling configuration.

', 'PutVoiceConnectorEmergencyCallingConfigurationRequest$EmergencyCallingConfiguration' => '

The configuration being updated.

', 'PutVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration' => '

The updated configuration.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberError$ErrorCode' => '

The error code.

', ], ], 'ForbiddenException' => [ 'base' => '

The client is permanently forbidden from making the request.

', 'refs' => [], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'SipMediaApplicationEndpoint$LambdaArn' => '

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

', ], ], 'GeoMatchLevel' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$GeoMatchLevel' => '

The preference for matching the country or area code of the proxy phone number with that of the first participant.

', 'ProxySession$GeoMatchLevel' => '

The preference for matching the country or area code of the proxy phone number with that of the first participant.

', ], ], 'GeoMatchParams' => [ 'base' => '

The country and area code for a proxy phone number in a proxy phone session.

', 'refs' => [ 'CreateProxySessionRequest$GeoMatchParams' => '

The country and area code for the proxy phone number.

', 'ProxySession$GeoMatchParams' => '

The country and area code for the proxy phone number.

', ], ], 'GetGlobalSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberOrderRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberOrderResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProxySessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSpeakerSearchTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSpeakerSearchTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorOriginationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorOriginationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorStreamingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorStreamingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationHealthRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationHealthResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceToneAnalysisTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceToneAnalysisTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'GoneException' => [ 'base' => '

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

', 'refs' => [], ], 'GuidString' => [ 'base' => NULL, 'refs' => [ 'GetPhoneNumberOrderRequest$PhoneNumberOrderId' => '

The ID of the phone number order .

', 'PhoneNumber$OrderId' => '

The phone number\'s order ID.

', 'PhoneNumberOrder$PhoneNumberOrderId' => '

The ID of the phone order.

', 'SipMediaApplicationCall$TransactionId' => '

The call\'s transaction ID.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Proxy$DefaultSessionExpiryMinutes' => '

The default number of minutes allowed for proxy sessions.

', 'PutVoiceConnectorProxyRequest$DefaultSessionExpiryMinutes' => '

The default number of minutes allowed for proxy session.

', ], ], 'Iso8601Timestamp' => [ 'base' => NULL, 'refs' => [ 'GetPhoneNumberSettingsResponse$CallingNameUpdatedTimestamp' => '

The updated outbound calling name timestamp, in ISO 8601 format.

', 'PhoneNumber$CreatedTimestamp' => '

The phone number creation timestamp, in ISO 8601 format.

', 'PhoneNumber$UpdatedTimestamp' => '

The updated phone number timestamp, in ISO 8601 format.

', 'PhoneNumber$DeletionTimestamp' => '

The deleted phone number timestamp, in ISO 8601 format.

', 'PhoneNumberAssociation$AssociatedTimestamp' => '

The timestamp of the phone number association, in ISO 8601 format.

', 'PhoneNumberOrder$CreatedTimestamp' => '

The phone number order creation time stamp, in ISO 8601 format.

', 'PhoneNumberOrder$UpdatedTimestamp' => '

The updated phone number order time stamp, in ISO 8601 format.

', 'ProxySession$CreatedTimestamp' => '

The created time stamp, in ISO 8601 format.

', 'ProxySession$UpdatedTimestamp' => '

The updated time stamp, in ISO 8601 format.

', 'ProxySession$EndedTimestamp' => '

The ended time stamp, in ISO 8601 format.

', 'SipMediaApplication$CreatedTimestamp' => '

The SIP media application creation timestamp, in ISO 8601 format.

', 'SipMediaApplication$UpdatedTimestamp' => '

The time at which the SIP media application was updated.

', 'SipRule$CreatedTimestamp' => '

The time at which the SIP rule was created, in ISO 8601 format.

', 'SipRule$UpdatedTimestamp' => '

The time at which the SIP rule was updated, in ISO 8601 format.

', 'SpeakerSearchTask$CreatedTimestamp' => '

The time at which a speaker search task was created.

', 'SpeakerSearchTask$UpdatedTimestamp' => '

The time at which a speaker search task was updated.

', 'SpeakerSearchTask$StartedTimestamp' => '

The time at which the speaker search task began.

', 'TerminationHealth$Timestamp' => '

The timestamp, in ISO 8601 format.

', 'VoiceConnector$CreatedTimestamp' => '

The Voice Connector\'s creation timestamp, in ISO 8601 format.

', 'VoiceConnector$UpdatedTimestamp' => '

The Voice Connector\'s updated timestamp, in ISO 8601 format.

', 'VoiceConnectorGroup$CreatedTimestamp' => '

The Voice Connector group\'s creation time stamp, in ISO 8601 format.

', 'VoiceConnectorGroup$UpdatedTimestamp' => '

The Voice Connector group\'s creation time stamp, in ISO 8601 format.

', 'VoiceProfile$CreatedTimestamp' => '

The time at which the voice profile was created and enrolled.

', 'VoiceProfile$UpdatedTimestamp' => '

The time at which the voice profile was last updated.

', 'VoiceProfile$ExpirationTimestamp' => '

The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

', 'VoiceProfileDomain$CreatedTimestamp' => '

The time at which the voice profile domain was created.

', 'VoiceProfileDomain$UpdatedTimestamp' => '

The time at which the voice profile was last updated.

', 'VoiceProfileDomainSummary$CreatedTimestamp' => '

The time at which the voice profile domain summary was created.

', 'VoiceProfileDomainSummary$UpdatedTimestamp' => '

The time at which the voice profile domain summary was last updated.

', 'VoiceProfileSummary$CreatedTimestamp' => '

The time at which a voice profile summary was created.

', 'VoiceProfileSummary$UpdatedTimestamp' => '

The time at which a voice profile summary was last updated.

', 'VoiceProfileSummary$ExpirationTimestamp' => '

Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile\'s voice print and extend the life of the summary.

', 'VoiceToneAnalysisTask$CreatedTimestamp' => '

The time at which a voice tone analysis task was created.

', 'VoiceToneAnalysisTask$UpdatedTimestamp' => '

The time at which a voice tone analysis task was updated.

', 'VoiceToneAnalysisTask$StartedTimestamp' => '

The time at which a voice tone analysis task started.

', ], ], 'LanguageCode' => [ 'base' => NULL, 'refs' => [ 'StartVoiceToneAnalysisTaskRequest$LanguageCode' => '

The language code.

', ], ], 'ListAvailableVoiceConnectorRegionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumberOrdersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumberOrdersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProxySessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProxySessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSipMediaApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSipMediaApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSipRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSipRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedPhoneNumberCountriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedPhoneNumberCountriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorTerminationCredentialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorTerminationCredentialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfileDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfileDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoggingConfiguration' => [ 'base' => '

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.

', 'refs' => [ 'GetVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration' => '

The logging configuration details .

', 'PutVoiceConnectorLoggingConfigurationRequest$LoggingConfiguration' => '

The logging configuration being updated.

', 'PutVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration' => '

The updated logging configuration.

', ], ], 'MediaInsightsConfiguration' => [ 'base' => '

The configuration for a call analytics task.

', 'refs' => [ 'StreamingConfiguration$MediaInsightsConfiguration' => '

The call analytics configuration.

', ], ], 'NextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListProxySessionsRequest$NextToken' => '

The token used to retrieve the next page of results.

', 'ListProxySessionsResponse$NextToken' => '

The token used to retrieve the next page of results.

', 'ListSipMediaApplicationsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListSipMediaApplicationsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListSipRulesRequest$NextToken' => '

The token used to return the next page of results.

', 'ListSipRulesResponse$NextToken' => '

The token used to return the next page of results.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Amazon Chime SDK Voice Connector group ID.

', 'AssociatePhoneNumbersWithVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'CreateSipMediaApplicationCallRequest$SipMediaApplicationId' => '

The ID of the SIP media application.

', 'CreateSipRuleRequest$TriggerValue' => '

If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

', 'DeleteSipMediaApplicationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'DeleteSipRuleRequest$SipRuleId' => '

The SIP rule ID.

', 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector Group ID.

', 'DeleteVoiceConnectorOriginationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorTerminationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector group ID.

', 'DisassociatePhoneNumbersFromVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'GetSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'GetSipMediaApplicationRequest$SipMediaApplicationId' => '

The SIP media application ID .

', 'GetSipRuleRequest$SipRuleId' => '

The SIP rule ID.

', 'GetVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector group ID.

', 'GetVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorOriginationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorTerminationHealthRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorTerminationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ListSipRulesRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'ListVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'PutVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorOriginationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorTerminationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'SipMediaApplication$SipMediaApplicationId' => '

A SIP media application\'s ID.

', 'SipMediaApplication$SipMediaApplicationArn' => '

The ARN of the SIP media application.

', 'SipRule$SipRuleId' => '

A SIP rule\'s ID.

', 'SipRule$TriggerValue' => '

The value set for a SIP rule\'s trigger type. Either a phone number or a URI hostname.

', 'SipRuleTargetApplication$SipMediaApplicationId' => '

The ID of a rule\'s target SIP media application.

', 'SpeakerSearchTask$SpeakerSearchTaskStatus' => '

The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

', 'UpdateSipMediaApplicationCallRequest$SipMediaApplicationId' => '

The ID of the SIP media application handling the call.

', 'UpdateSipMediaApplicationCallRequest$TransactionId' => '

The ID of the call transaction.

', 'UpdateSipMediaApplicationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'UpdateSipRuleRequest$SipRuleId' => '

The SIP rule ID.

', 'UpdateVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector ID.

', 'UpdateVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ValidateE911AddressRequest$AwsAccountId' => '

The AWS account ID.

', 'VoiceConnector$VoiceConnectorId' => '

The Voice Connector\'s ID.

', 'VoiceConnector$VoiceConnectorArn' => '

The ARN of the Voice Connector.

', 'VoiceConnectorGroup$VoiceConnectorGroupId' => '

The ID of a Voice Connector group.

', 'VoiceConnectorGroup$VoiceConnectorGroupArn' => '

The ARN of the Voice Connector group.

', 'VoiceConnectorItem$VoiceConnectorId' => '

The Voice Connector ID.

', 'VoiceToneAnalysisTask$VoiceToneAnalysisTaskStatus' => '

The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

', ], ], 'NonEmptyString128' => [ 'base' => NULL, 'refs' => [ 'CallDetails$VoiceConnectorId' => '

The Voice Connector ID.

', 'CreateProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteProxySessionRequest$ProxySessionId' => '

The proxy session ID.

', 'DeleteVoiceConnectorProxyRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetProxySessionRequest$ProxySessionId' => '

The proxy session ID.

', 'GetSpeakerSearchTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorProxyRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceToneAnalysisTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ListProxySessionsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ProxySession$VoiceConnectorId' => '

The Voice Connector ID.

', 'ProxySession$ProxySessionId' => '

The proxy session ID.

', 'PutVoiceConnectorProxyRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StartSpeakerSearchTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StartVoiceToneAnalysisTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StopSpeakerSearchTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StopVoiceToneAnalysisTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'UpdateProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'UpdateProxySessionRequest$ProxySessionId' => '

The proxy session ID.

', ], ], 'NonEmptyString256' => [ 'base' => NULL, 'refs' => [ 'CallDetails$TransactionId' => '

The transaction ID of a Voice Connector call.

', 'CreateVoiceProfileRequest$SpeakerSearchTaskId' => '

The ID of the speaker search task.

', 'DeleteVoiceProfileDomainRequest$VoiceProfileDomainId' => '

The voice profile domain ID.

', 'DeleteVoiceProfileRequest$VoiceProfileId' => '

The voice profile ID.

', 'GetSpeakerSearchTaskRequest$SpeakerSearchTaskId' => '

The ID of the speaker search task.

', 'GetVoiceProfileDomainRequest$VoiceProfileDomainId' => '

The voice profile domain ID.

', 'GetVoiceProfileRequest$VoiceProfileId' => '

The voice profile ID.

', 'GetVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId' => '

The ID of the voice tone anlysis task.

', 'ListVoiceProfilesRequest$VoiceProfileDomainId' => '

The ID of the voice profile domain.

', 'SpeakerSearchDetails$VoiceprintGenerationStatus' => '

The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..

', 'SpeakerSearchResult$VoiceProfileId' => '

The voice profile ID.

', 'SpeakerSearchTask$SpeakerSearchTaskId' => '

The speaker search task ID.

', 'StartSpeakerSearchTaskRequest$TransactionId' => '

The transaction ID of the call being analyzed.

', 'StartSpeakerSearchTaskRequest$VoiceProfileDomainId' => '

The ID of the voice profile domain that will store the voice profile.

', 'StartVoiceToneAnalysisTaskRequest$TransactionId' => '

The transaction ID.

', 'StopSpeakerSearchTaskRequest$SpeakerSearchTaskId' => '

The speaker search task ID.

', 'StopVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId' => '

The ID of the voice tone analysis task.

', 'UpdateVoiceProfileDomainRequest$VoiceProfileDomainId' => '

The domain ID.

', 'UpdateVoiceProfileRequest$VoiceProfileId' => '

The profile ID.

', 'UpdateVoiceProfileRequest$SpeakerSearchTaskId' => '

The ID of the speaker search task.

', 'VoiceProfile$VoiceProfileId' => '

The ID of the voice profile.

', 'VoiceProfile$VoiceProfileDomainId' => '

The ID of the domain that contains the voice profile.

', 'VoiceProfileDomain$VoiceProfileDomainId' => '

The ID of the voice profile domain.

', 'VoiceProfileDomainSummary$VoiceProfileDomainId' => '

The ID of the voice profile domain summary.

', 'VoiceProfileSummary$VoiceProfileId' => '

The ID of the voice profile in a voice profile summary.

', 'VoiceProfileSummary$VoiceProfileDomainId' => '

The ID of the voice profile domain in a voice profile summary.

', 'VoiceToneAnalysisTask$VoiceToneAnalysisTaskId' => '

The ID of the voice tone analysis task.

', ], ], 'NonEmptyStringList' => [ 'base' => NULL, 'refs' => [ 'BatchDeletePhoneNumberRequest$PhoneNumberIds' => '

List of phone number IDs.

', ], ], 'NotFoundException' => [ 'base' => '

The requested resource couldn\'t be found.

', 'refs' => [], ], 'NotificationTarget' => [ 'base' => NULL, 'refs' => [ 'StreamingNotificationTarget$NotificationTarget' => '

The streaming notification target.

', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest$ForceAssociate' => '

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

', 'AssociatePhoneNumbersWithVoiceConnectorRequest$ForceAssociate' => '

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

', 'CreateSipRuleRequest$Disabled' => '

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

', 'PhoneNumberCapabilities$InboundCall' => '

Allows or denies inbound calling for the specified phone number.

', 'PhoneNumberCapabilities$OutboundCall' => '

Allows or denies outbound calling for the specified phone number.

', 'PhoneNumberCapabilities$InboundSMS' => '

Allows or denies inbound SMS messaging for the specified phone number.

', 'PhoneNumberCapabilities$OutboundSMS' => '

Allows or denies outbound SMS messaging for the specified phone number.

', 'PhoneNumberCapabilities$InboundMMS' => '

Allows or denies inbound MMS messaging for the specified phone number.

', 'PhoneNumberCapabilities$OutboundMMS' => '

Allows or denies inbound MMS messaging for the specified phone number.

', 'UpdateSipRuleRequest$Disabled' => '

The new value that indicates whether the rule is disabled.

', ], ], 'NumberSelectionBehavior' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$NumberSelectionBehavior' => '

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

', 'ProxySession$NumberSelectionBehavior' => '

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

', ], ], 'OrderedPhoneNumber' => [ 'base' => '

A phone number for which an order has been placed.

', 'refs' => [ 'OrderedPhoneNumberList$member' => NULL, ], ], 'OrderedPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberOrder$OrderedPhoneNumbers' => '

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

', ], ], 'OrderedPhoneNumberStatus' => [ 'base' => NULL, 'refs' => [ 'OrderedPhoneNumber$Status' => '

The phone number status.

', ], ], 'Origination' => [ 'base' => '

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice Connector.

The parameters listed below are not required, but you must use at least one.

', 'refs' => [ 'GetVoiceConnectorOriginationResponse$Origination' => '

The origination setting details.

', 'PutVoiceConnectorOriginationRequest$Origination' => '

The origination settings being updated.

', 'PutVoiceConnectorOriginationResponse$Origination' => '

The updated origination settings.

', ], ], 'OriginationRoute' => [ 'base' => '

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

The parameters listed below are not required, but you must use at least one.

', 'refs' => [ 'OriginationRouteList$member' => NULL, ], ], 'OriginationRouteList' => [ 'base' => NULL, 'refs' => [ 'Origination$Routes' => '

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

', ], ], 'OriginationRoutePriority' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Priority' => '

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

', ], ], 'OriginationRouteProtocol' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Protocol' => '

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

', ], ], 'OriginationRouteWeight' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Weight' => '

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

', ], ], 'Participant' => [ 'base' => '

The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.

', 'refs' => [ 'Participants$member' => NULL, ], ], 'ParticipantPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$ParticipantPhoneNumbers' => '

The participant phone numbers.

', ], ], 'Participants' => [ 'base' => NULL, 'refs' => [ 'ProxySession$Participants' => '

The proxy session participants.

', ], ], 'PhoneNumber' => [ 'base' => '

A phone number used to call an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetPhoneNumberResponse$PhoneNumber' => '

The phone number details.

', 'PhoneNumberList$member' => NULL, 'RestorePhoneNumberResponse$PhoneNumber' => '

The restored phone number.

', 'UpdatePhoneNumberResponse$PhoneNumber' => '

The updated phone number details.

', ], ], 'PhoneNumberAssociation' => [ 'base' => '

The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

', 'refs' => [ 'PhoneNumberAssociationList$member' => NULL, ], ], 'PhoneNumberAssociationList' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$Associations' => '

The phone number\'s associations.

', ], ], 'PhoneNumberAssociationName' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersRequest$FilterName' => '

The filter to limit the number of results.

', 'PhoneNumberAssociation$Name' => '

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

', ], ], 'PhoneNumberCapabilities' => [ 'base' => '

The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and outbound calling, and text messaging.

', 'refs' => [ 'PhoneNumber$Capabilities' => '

The phone number\'s capabilities.

', ], ], 'PhoneNumberCountriesList' => [ 'base' => NULL, 'refs' => [ 'ListSupportedPhoneNumberCountriesResponse$PhoneNumberCountries' => '

The supported phone number countries.

', ], ], 'PhoneNumberCountry' => [ 'base' => '

The phone number\'s country.

', 'refs' => [ 'PhoneNumberCountriesList$member' => NULL, ], ], 'PhoneNumberError' => [ 'base' => '

If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.

', 'refs' => [ 'PhoneNumberErrorList$member' => NULL, ], ], 'PhoneNumberErrorList' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'AssociatePhoneNumbersWithVoiceConnectorResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'BatchDeletePhoneNumberResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'BatchUpdatePhoneNumberResponse$PhoneNumberErrors' => '

A list of failed phone numbers and their error messages.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'DisassociatePhoneNumbersFromVoiceConnectorResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', ], ], 'PhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersResponse$PhoneNumbers' => '

The phone number details.

', ], ], 'PhoneNumberMaxResults' => [ 'base' => NULL, 'refs' => [ 'SearchAvailablePhoneNumbersRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'PhoneNumberName' => [ 'base' => NULL, 'refs' => [ 'CreatePhoneNumberOrderRequest$Name' => '

Specifies the name assigned to one or more phone numbers.

', 'PhoneNumber$Name' => '

The name of the phone number.

', 'UpdatePhoneNumberRequest$Name' => '

Specifies the name assigned to one or more phone numbers.

', 'UpdatePhoneNumberRequestItem$Name' => '

The name of the phone number.

', ], ], 'PhoneNumberOrder' => [ 'base' => '

The details of an Amazon Chime SDK phone number order.

', 'refs' => [ 'CreatePhoneNumberOrderResponse$PhoneNumberOrder' => '

The phone number order details.

', 'GetPhoneNumberOrderResponse$PhoneNumberOrder' => '

The phone number order details.

', 'PhoneNumberOrderList$member' => NULL, ], ], 'PhoneNumberOrderList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumberOrdersResponse$PhoneNumberOrders' => '

The phone number order details.

', ], ], 'PhoneNumberOrderStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberOrder$Status' => '

The status of the phone number order.

', ], ], 'PhoneNumberOrderType' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberOrder$OrderType' => '

The type of phone number being ordered, local or toll-free.

', ], ], 'PhoneNumberProductType' => [ 'base' => NULL, 'refs' => [ 'CreatePhoneNumberOrderRequest$ProductType' => '

The phone number product type.

', 'ListPhoneNumbersRequest$ProductType' => '

The phone number product types.

', 'ListSupportedPhoneNumberCountriesRequest$ProductType' => '

The phone number product type.

', 'PhoneNumber$ProductType' => '

The phone number\'s product type.

', 'PhoneNumberOrder$ProductType' => '

The phone number order product type.

', 'UpdatePhoneNumberRequest$ProductType' => '

The product type.

', 'UpdatePhoneNumberRequestItem$ProductType' => '

The product type to update.

', ], ], 'PhoneNumberStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$Status' => '

The phone number\'s status.

', ], ], 'PhoneNumberType' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$Type' => '

The phone number\'s type.

', 'PhoneNumberTypeList$member' => NULL, 'SearchAvailablePhoneNumbersRequest$PhoneNumberType' => '

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

', ], ], 'PhoneNumberTypeList' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberCountry$SupportedPhoneNumberTypes' => '

The supported phone number types.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Port' => '

The designated origination route port. Defaults to 5060.

', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$ExpiryMinutes' => '

The number of minutes allowed for the proxy session.

', 'ProxySession$ExpiryMinutes' => '

The number of minutes allowed for the proxy session.

', 'UpdateProxySessionRequest$ExpiryMinutes' => '

The number of minutes allowed for the proxy session.

', ], ], 'Proxy' => [ 'base' => '

The proxy configuration for an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetVoiceConnectorProxyResponse$Proxy' => '

The proxy configuration details.

', 'PutVoiceConnectorProxyResponse$Proxy' => '

The proxy configuration details.

', ], ], 'ProxySession' => [ 'base' => '

The proxy session for an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'CreateProxySessionResponse$ProxySession' => '

The proxy session details.

', 'GetProxySessionResponse$ProxySession' => '

The proxy session details.

', 'ProxySessions$member' => NULL, 'UpdateProxySessionResponse$ProxySession' => '

The updated proxy session details.

', ], ], 'ProxySessionNameString' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$Name' => '

The name of the proxy session.

', ], ], 'ProxySessionStatus' => [ 'base' => NULL, 'refs' => [ 'ListProxySessionsRequest$Status' => '

The proxy session status.

', 'ProxySession$Status' => '

The proxy session status.

', ], ], 'ProxySessions' => [ 'base' => NULL, 'refs' => [ 'ListProxySessionsResponse$ProxySessions' => '

The proxy sessions\' details.

', ], ], 'PutSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutSipMediaApplicationLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSipMediaApplicationLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorOriginationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorOriginationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorStreamingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorStreamingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorTerminationCredentialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorTerminationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorTerminationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceLimitExceededException' => [ 'base' => '

The request exceeds the resource limit.

', 'refs' => [], ], 'RestorePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestorePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResultMax' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumberOrdersRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListPhoneNumbersRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListProxySessionsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListSipMediaApplicationsRequest$MaxResults' => '

The maximum number of results to return in a single call. Defaults to 100.

', 'ListSipRulesRequest$MaxResults' => '

The maximum number of results to return in a single call. Defaults to 100.

', 'ListVoiceConnectorGroupsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListVoiceConnectorsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListVoiceProfileDomainsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListVoiceProfilesRequest$MaxResults' => '

The maximum number of results in the request.

', ], ], 'SMACreateCallArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationCallRequest$ArgumentsMap' => '

Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"

', ], ], 'SMAUpdateCallArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'UpdateSipMediaApplicationCallRequest$Arguments' => '

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

', ], ], 'SearchAvailablePhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchAvailablePhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Address$streetName' => '

The address street, such as 8th Avenue.

', 'Address$streetSuffix' => '

The address suffix, such as the N in 8th Avenue N.

', 'Address$postDirectional' => '

An address suffix location, such as the S. Unit A in Central Park S. Unit A.

', 'Address$preDirectional' => '

An address prefix location, such as the N in N. Third St.

', 'Address$streetNumber' => '

The numeric portion of an address.

', 'Address$city' => '

The city of an address.

', 'Address$state' => '

The state of an address.

', 'Address$postalCode' => '

The postal code of an address.

', 'Address$postalCodePlus4' => '

The zip + 4 or postal code + 4 of an address.

', 'Address$country' => '

The country of an address.

', 'CandidateAddress$streetInfo' => '

The street information of the candidate address.

', 'CandidateAddress$streetNumber' => '

The numeric portion of the candidate address.

', 'CandidateAddress$city' => '

The city of the candidate address.

', 'CandidateAddress$state' => '

The state of the candidate address.

', 'CandidateAddress$postalCode' => '

The postal code of the candidate address.

', 'CandidateAddress$postalCodePlus4' => '

The zip + 4 or postal code +4 of the candidate address.

', 'CandidateAddress$country' => '

The country of the candidate address.

', 'DeletePhoneNumberRequest$PhoneNumberId' => '

The phone number ID.

', 'GetPhoneNumberRequest$PhoneNumberId' => '

The phone number ID.

', 'PhoneNumber$PhoneNumberId' => '

The phone number\'s ID.

', 'PhoneNumberError$PhoneNumberId' => '

The phone number ID for which the action failed.

', 'RestorePhoneNumberRequest$PhoneNumberId' => '

The ID of the phone number being restored.

', 'UpdatePhoneNumberRequest$PhoneNumberId' => '

The phone number ID.

', 'UpdatePhoneNumberRequestItem$PhoneNumberId' => '

The phone number ID to update.

', 'ValidateE911AddressRequest$StreetNumber' => '

The address street number, such as 200 or 2121.

', 'ValidateE911AddressRequest$StreetInfo' => '

The address street information, such as 8th Avenue.

', 'ValidateE911AddressRequest$City' => '

The address city, such as Portland.

', 'ValidateE911AddressRequest$State' => '

The address state, such as ME.

', 'ValidateE911AddressRequest$Country' => '

The country in the address being validated.

', 'ValidateE911AddressRequest$PostalCode' => '

The dress postal code, such 04352.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'Credential$Username' => '

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

', 'Credential$Password' => '

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

', 'SMACreateCallArgumentsMap$key' => NULL, 'SMACreateCallArgumentsMap$value' => NULL, 'SMAUpdateCallArgumentsMap$key' => NULL, 'SMAUpdateCallArgumentsMap$value' => NULL, 'SensitiveStringList$member' => NULL, 'SipHeadersMap$key' => NULL, 'SipHeadersMap$value' => NULL, ], ], 'SensitiveStringList' => [ 'base' => NULL, 'refs' => [ 'DeleteVoiceConnectorTerminationCredentialsRequest$Usernames' => '

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

', 'ListVoiceConnectorTerminationCredentialsResponse$Usernames' => '

A list of user names.

', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => '

A structure that contains the configuration settings for server-side encryption.

We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.

', 'refs' => [ 'CreateVoiceProfileDomainRequest$ServerSideEncryptionConfiguration' => '

The server-side encryption configuration for the request.

', 'VoiceProfileDomain$ServerSideEncryptionConfiguration' => '

A structure that contains the configuration settings for server-side encryption.

', ], ], 'ServiceFailureException' => [ 'base' => '

The service encountered an unexpected error.

', 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => '

The service is currently unavailable.

', 'refs' => [], ], 'SipApplicationPriority' => [ 'base' => NULL, 'refs' => [ 'SipRuleTargetApplication$Priority' => '

The priority setting of a rule\'s target SIP media application.

', ], ], 'SipHeadersMap' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationCallRequest$SipHeaders' => '

The SIP headers added to an outbound call leg.

', ], ], 'SipMediaApplication' => [ 'base' => '

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

', 'refs' => [ 'CreateSipMediaApplicationResponse$SipMediaApplication' => '

The SIP media application details.

', 'GetSipMediaApplicationResponse$SipMediaApplication' => '

The details of the SIP media application.

', 'SipMediaApplicationList$member' => NULL, 'UpdateSipMediaApplicationResponse$SipMediaApplication' => '

The updated SIP media application’s details.

', ], ], 'SipMediaApplicationAlexaSkillConfiguration' => [ 'base' => '

The Alexa Skill configuration of a SIP media application.

', 'refs' => [ 'GetSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration' => '

Returns the Alexa Skill configuration.

', 'PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationAlexaSkillConfiguration' => '

The Alexa Skill configuration.

', 'PutSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration' => '

Returns the Alexa Skill configuration.

', ], ], 'SipMediaApplicationCall' => [ 'base' => '

A Call instance for a SIP media application.

', 'refs' => [ 'CreateSipMediaApplicationCallResponse$SipMediaApplicationCall' => '

The actual call.

', 'UpdateSipMediaApplicationCallResponse$SipMediaApplicationCall' => '

A Call instance for a SIP media application.

', ], ], 'SipMediaApplicationEndpoint' => [ 'base' => '

The endpoint assigned to a SIP media application.

', 'refs' => [ 'SipMediaApplicationEndpointList$member' => NULL, ], ], 'SipMediaApplicationEndpointList' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$Endpoints' => '

List of endpoints (Lambda ARNs) specified for the SIP media application.

', 'SipMediaApplication$Endpoints' => '

List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

', 'UpdateSipMediaApplicationRequest$Endpoints' => '

The new set of endpoints for the specified SIP media application.

', ], ], 'SipMediaApplicationList' => [ 'base' => NULL, 'refs' => [ 'ListSipMediaApplicationsResponse$SipMediaApplications' => '

The list of SIP media applications and application details.

', ], ], 'SipMediaApplicationLoggingConfiguration' => [ 'base' => '

The logging configuration of a SIP media application.

', 'refs' => [ 'GetSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration' => '

The actual logging configuration.

', 'PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationLoggingConfiguration' => '

The logging configuration for the specified SIP media application.

', 'PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration' => '

The updated logging configuration for the specified SIP media application.

', ], ], 'SipMediaApplicationName' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$Name' => '

The SIP media application\'s name.

', 'SipMediaApplication$Name' => '

The SIP media application\'s name.

', 'UpdateSipMediaApplicationRequest$Name' => '

The new name for the specified SIP media application.

', ], ], 'SipRule' => [ 'base' => '

The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

', 'refs' => [ 'CreateSipRuleResponse$SipRule' => '

The SIP rule information, including the rule ID, triggers, and target applications.

', 'GetSipRuleResponse$SipRule' => '

The SIP rule details.

', 'SipRuleList$member' => NULL, 'UpdateSipRuleResponse$SipRule' => '

The updated SIP rule details.

', ], ], 'SipRuleList' => [ 'base' => NULL, 'refs' => [ 'ListSipRulesResponse$SipRules' => '

The list of SIP rules and details.

', ], ], 'SipRuleName' => [ 'base' => NULL, 'refs' => [ 'CreateSipRuleRequest$Name' => '

The name of the SIP rule.

', 'SipRule$Name' => '

A SIP rule\'s name.

', 'UpdateSipRuleRequest$Name' => '

The new name for the specified SIP rule.

', ], ], 'SipRuleTargetApplication' => [ 'base' => '

A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

', 'refs' => [ 'SipRuleTargetApplicationList$member' => NULL, ], ], 'SipRuleTargetApplicationList' => [ 'base' => NULL, 'refs' => [ 'CreateSipRuleRequest$TargetApplications' => '

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

', 'SipRule$TargetApplications' => '

The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

', 'UpdateSipRuleRequest$TargetApplications' => '

The new list of target applications.

', ], ], 'SipRuleTriggerType' => [ 'base' => NULL, 'refs' => [ 'CreateSipRuleRequest$TriggerType' => '

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

', 'SipRule$TriggerType' => '

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

', ], ], 'SpeakerSearchDetails' => [ 'base' => '

The details of a speaker search task.

', 'refs' => [ 'SpeakerSearchTask$SpeakerSearchDetails' => '

The details of a speaker search task.

', ], ], 'SpeakerSearchResult' => [ 'base' => '

The result of a speaker search analysis.

', 'refs' => [ 'SpeakerSearchResultList$member' => NULL, ], ], 'SpeakerSearchResultList' => [ 'base' => NULL, 'refs' => [ 'SpeakerSearchDetails$Results' => '

The result value in the speaker search details.

', ], ], 'SpeakerSearchTask' => [ 'base' => '

A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.

', 'refs' => [ 'GetSpeakerSearchTaskResponse$SpeakerSearchTask' => '

The details of the speaker search task.

', 'StartSpeakerSearchTaskResponse$SpeakerSearchTask' => '

The details of the speaker search task.

', ], ], 'StartSpeakerSearchTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartSpeakerSearchTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartVoiceToneAnalysisTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartVoiceToneAnalysisTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSpeakerSearchTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopVoiceToneAnalysisTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StreamingConfiguration' => [ 'base' => '

The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

', 'refs' => [ 'GetVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration' => '

The details of the streaming configuration.

', 'PutVoiceConnectorStreamingConfigurationRequest$StreamingConfiguration' => '

The streaming settings being updated.

', 'PutVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration' => '

The updated streaming settings.

', ], ], 'StreamingNotificationTarget' => [ 'base' => '

The target recipient for a streaming configuration notification.

', 'refs' => [ 'StreamingNotificationTargetList$member' => NULL, ], ], 'StreamingNotificationTargetList' => [ 'base' => NULL, 'refs' => [ 'StreamingConfiguration$StreamingNotificationTargets' => '

The streaming notification targets.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$AwsRegion' => '

The AWS Region assigned to the SIP media application.

', 'ListPhoneNumberOrdersRequest$NextToken' => '

The token used to retrieve the next page of results.

', 'ListPhoneNumberOrdersResponse$NextToken' => '

The token used to retrieve the next page of results.

', 'ListPhoneNumbersRequest$Status' => '

The status of your organization\'s phone numbers.

', 'ListPhoneNumbersRequest$FilterValue' => '

The filter value.

', 'ListPhoneNumbersRequest$NextToken' => '

The token used to return the next page of results.

', 'ListPhoneNumbersResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorGroupsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorGroupsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceProfileDomainsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceProfileDomainsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceProfilesRequest$NextToken' => '

The token used to retrieve the next page of results.

', 'ListVoiceProfilesResponse$NextToken' => '

The token used to retrieve the next page of results.

', 'NonEmptyStringList$member' => NULL, 'OriginationRoute$Host' => '

The FQDN or IP address to contact for origination traffic.

', 'PhoneNumberAssociation$Value' => '

Contains the ID for the entity specified in Name.

', 'PhoneNumberError$ErrorMessage' => '

The error message.

', 'SearchAvailablePhoneNumbersRequest$AreaCode' => '

Confines a search to just the phone numbers associated with the specified area code.

', 'SearchAvailablePhoneNumbersRequest$City' => '

Confines a search to just the phone numbers associated with the specified city.

', 'SearchAvailablePhoneNumbersRequest$State' => '

Confines a search to just the phone numbers associated with the specified state.

', 'SearchAvailablePhoneNumbersRequest$NextToken' => '

The token used to return the next page of results.

', 'SearchAvailablePhoneNumbersResponse$NextToken' => '

The token used to return the next page of results.

', 'SipMediaApplication$AwsRegion' => '

The AWS Region in which the SIP media application is created.

', 'SipRuleTargetApplication$AwsRegion' => '

The AWS Region of a rule\'s target SIP media application.

', 'SpeakerSearchTask$StatusMessage' => '

A detailed message about the status of a speaker search.

', 'StringList$member' => NULL, 'TerminationHealth$Source' => '

The source IP address.

', 'ValidateE911AddressResponse$AddressExternalId' => '

The ID that represents the address.

', 'VoiceConnector$OutboundHostName' => '

The outbound host name for the Voice Connector.

', 'VoiceConnectorSettings$CdrBucket' => '

The S3 bucket that stores the Voice Connector\'s call detail records.

', 'VoiceToneAnalysisTask$StatusMessage' => '

The status of a voice tone analysis task.

', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'ProxySession$Name' => '

The proxy session name.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Proxy$PhoneNumberCountries' => '

The countries for proxy phone numbers to be selected from.

', 'Termination$CidrAllowedList' => '

The IP addresses allowed to make calls, in CIDR format.

', ], ], 'Tag' => [ 'base' => '

Describes a tag applied to a resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag\'s key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The keys of the tags being removed from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$Tags' => '

The tags assigned to the SIP media application.

', 'CreateVoiceConnectorRequest$Tags' => '

The tags assigned to the Voice Connector.

', 'CreateVoiceProfileDomainRequest$Tags' => '

The tags assigned to the domain.

', 'ListTagsForResourceResponse$Tags' => '

The tags in the list.

', 'TagResourceRequest$Tags' => '

A list of the tags being added to the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag\'s value.

', ], ], 'Termination' => [ 'base' => '

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetVoiceConnectorTerminationResponse$Termination' => '

The termination setting details.

', 'PutVoiceConnectorTerminationRequest$Termination' => '

The termination settings to be updated.

', 'PutVoiceConnectorTerminationResponse$Termination' => '

The updated termination settings.

', ], ], 'TerminationHealth' => [ 'base' => '

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

', 'refs' => [ 'GetVoiceConnectorTerminationHealthResponse$TerminationHealth' => '

The termination health details.

', ], ], 'ThrottledClientException' => [ 'base' => '

The number of customer requests exceeds the request rate limit.

', 'refs' => [], ], 'TollFreePrefix' => [ 'base' => NULL, 'refs' => [ 'SearchAvailablePhoneNumbersRequest$TollFreePrefix' => '

Confines a search to just the phone numbers associated with the specified toll-free prefix.

', ], ], 'UnauthorizedClientException' => [ 'base' => '

The client isn\'t authorized to request a resource.

', 'refs' => [], ], 'UnprocessableEntityException' => [ 'base' => '

A well-formed request couldn\'t be followed due to semantic errors.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGlobalSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequestItem' => [ 'base' => '

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

', 'refs' => [ 'UpdatePhoneNumberRequestItemList$member' => NULL, ], ], 'UpdatePhoneNumberRequestItemList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePhoneNumberRequest$UpdatePhoneNumberRequestItems' => '

Lists the phone numbers in the update request.

', ], ], 'UpdatePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProxySessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationCallRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationCallResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidateE911AddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidateE911AddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationResult' => [ 'base' => NULL, 'refs' => [ 'ValidateE911AddressResponse$ValidationResult' => '

Number indicating the result of address validation. 0 means the address was perfect as-is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

', ], ], 'VoiceConnector' => [ 'base' => '

The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.

', 'refs' => [ 'CreateVoiceConnectorResponse$VoiceConnector' => '

The details of the Voice Connector.

', 'GetVoiceConnectorResponse$VoiceConnector' => '

The Voice Connector details.

', 'UpdateVoiceConnectorResponse$VoiceConnector' => '

The updated Voice Connector details.

', 'VoiceConnectorList$member' => NULL, ], ], 'VoiceConnectorAwsRegion' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorRequest$AwsRegion' => '

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

', 'VoiceConnector$AwsRegion' => '

The AWS Region in which the Voice Connector is created. Default: us-east-1.

', 'VoiceConnectorAwsRegionList$member' => NULL, ], ], 'VoiceConnectorAwsRegionList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableVoiceConnectorRegionsResponse$VoiceConnectorRegions' => '

The list of AWS Regions.

', ], ], 'VoiceConnectorGroup' => [ 'base' => '

The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.

', 'refs' => [ 'CreateVoiceConnectorGroupResponse$VoiceConnectorGroup' => '

The details of the Voice Connector group.

', 'GetVoiceConnectorGroupResponse$VoiceConnectorGroup' => '

The details of the Voice Connector group.

', 'UpdateVoiceConnectorGroupResponse$VoiceConnectorGroup' => '

The updated Voice Connector group.

', 'VoiceConnectorGroupList$member' => NULL, ], ], 'VoiceConnectorGroupList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceConnectorGroupsResponse$VoiceConnectorGroups' => '

The details of the Voice Connector groups.

', ], ], 'VoiceConnectorGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorGroupRequest$Name' => '

The name of the Voice Connector group.

', 'UpdateVoiceConnectorGroupRequest$Name' => '

The name of the Voice Connector group.

', 'VoiceConnectorGroup$Name' => '

The name of a Voice Connector group.

', ], ], 'VoiceConnectorItem' => [ 'base' => '

For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

', 'refs' => [ 'VoiceConnectorItemList$member' => NULL, ], ], 'VoiceConnectorItemList' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorGroupRequest$VoiceConnectorItems' => '

Lists the Voice Connectors that inbound calls are routed to.

', 'UpdateVoiceConnectorGroupRequest$VoiceConnectorItems' => '

The VoiceConnectorItems to associate with the Voice Connector group.

', 'VoiceConnectorGroup$VoiceConnectorItems' => '

The Voice Connectors to which you route inbound calls.

', ], ], 'VoiceConnectorItemPriority' => [ 'base' => NULL, 'refs' => [ 'VoiceConnectorItem$Priority' => '

The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

', ], ], 'VoiceConnectorList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceConnectorsResponse$VoiceConnectors' => '

The details of the Voice Connectors.

', ], ], 'VoiceConnectorName' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorRequest$Name' => '

The name of the Voice Connector.

', 'UpdateVoiceConnectorRequest$Name' => '

The name of the Voice Connector.

', 'VoiceConnector$Name' => '

The Voice Connector\'s name.

', ], ], 'VoiceConnectorSettings' => [ 'base' => '

The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

', 'refs' => [ 'GetGlobalSettingsResponse$VoiceConnector' => '

The Voice Connector settings.

', 'UpdateGlobalSettingsRequest$VoiceConnector' => '

The Voice Connector settings.

', ], ], 'VoiceProfile' => [ 'base' => '

The combination of a voice print and caller ID.

', 'refs' => [ 'CreateVoiceProfileResponse$VoiceProfile' => '

The requested voice profile.

', 'GetVoiceProfileResponse$VoiceProfile' => '

The voice profile details.

', 'UpdateVoiceProfileResponse$VoiceProfile' => '

The updated voice profile settings.

', ], ], 'VoiceProfileDomain' => [ 'base' => '

A collection of voice profiles.

', 'refs' => [ 'CreateVoiceProfileDomainResponse$VoiceProfileDomain' => '

The requested voice profile domain.

', 'GetVoiceProfileDomainResponse$VoiceProfileDomain' => '

The details of the voice profile domain.

', 'UpdateVoiceProfileDomainResponse$VoiceProfileDomain' => '

The updated details of the voice profile domain.

', ], ], 'VoiceProfileDomainDescription' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceProfileDomainRequest$Description' => '

A description of the voice profile domain.

', 'UpdateVoiceProfileDomainRequest$Description' => '

The description of the voice profile domain.

', 'VoiceProfileDomain$Description' => '

The description of the voice profile domain.

', 'VoiceProfileDomainSummary$Description' => '

Describes the voice profile domain summary.

', ], ], 'VoiceProfileDomainName' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceProfileDomainRequest$Name' => '

The name of the voice profile domain.

', 'UpdateVoiceProfileDomainRequest$Name' => '

The name of the voice profile domain.

', 'VoiceProfileDomain$Name' => '

The name of the voice profile domain.

', 'VoiceProfileDomainSummary$Name' => '

The name of the voice profile domain summary.

', ], ], 'VoiceProfileDomainSummary' => [ 'base' => '

A high-level overview of a voice profile domain.

', 'refs' => [ 'VoiceProfileDomainSummaryList$member' => NULL, ], ], 'VoiceProfileDomainSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceProfileDomainsResponse$VoiceProfileDomains' => '

The list of voice profile domains.

', ], ], 'VoiceProfileSummary' => [ 'base' => '

A high-level summary of a voice profile.

', 'refs' => [ 'VoiceProfileSummaryList$member' => NULL, ], ], 'VoiceProfileSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceProfilesResponse$VoiceProfiles' => '

The list of voice profiles.

', ], ], 'VoiceToneAnalysisTask' => [ 'base' => '

A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.

', 'refs' => [ 'GetVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask' => '

The details of the voice tone analysis task.

', 'StartVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask' => '

The details of the voice tone analysis task.

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

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

', 'operations' => [ 'AssociatePhoneNumbersWithVoiceConnector' => '

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

', 'AssociatePhoneNumbersWithVoiceConnectorGroup' => '

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

', 'BatchDeletePhoneNumber' => '

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

', 'BatchUpdatePhoneNumber' => '

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.

You cannot have a duplicate phoneNumberId in a request.

', 'CreatePhoneNumberOrder' => '

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

', 'CreateProxySession' => '

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

', 'CreateSipMediaApplication' => '

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

', 'CreateSipMediaApplicationCall' => '

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

', 'CreateSipRule' => '

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

', 'CreateVoiceConnector' => '

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

', 'CreateVoiceConnectorGroup' => '

Creates an Amazon Chime SDK Voice Connector group under the administrator\'s AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

', 'CreateVoiceProfile' => '

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

', 'CreateVoiceProfileDomain' => '

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

', 'DeletePhoneNumber' => '

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.

', 'DeleteProxySession' => '

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

', 'DeleteSipMediaApplication' => '

Deletes a SIP media application.

', 'DeleteSipRule' => '

Deletes a SIP rule.

', 'DeleteVoiceConnector' => '

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

', 'DeleteVoiceConnectorEmergencyCallingConfiguration' => '

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

', 'DeleteVoiceConnectorGroup' => '

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

', 'DeleteVoiceConnectorOrigination' => '

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

', 'DeleteVoiceConnectorProxy' => '

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

', 'DeleteVoiceConnectorStreamingConfiguration' => '

Deletes a Voice Connector\'s streaming configuration.

', 'DeleteVoiceConnectorTermination' => '

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

', 'DeleteVoiceConnectorTerminationCredentials' => '

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

', 'DeleteVoiceProfile' => '

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

', 'DeleteVoiceProfileDomain' => '

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

', 'DisassociatePhoneNumbersFromVoiceConnector' => '

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroup' => '

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

', 'GetGlobalSettings' => '

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

', 'GetPhoneNumber' => '

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

', 'GetPhoneNumberOrder' => '

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

', 'GetPhoneNumberSettings' => '

Retrieves the phone number settings for the administrator\'s AWS account, such as the default outbound calling name.

', 'GetProxySession' => '

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

', 'GetSipMediaApplication' => '

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

', 'GetSipMediaApplicationAlexaSkillConfiguration' => '

Gets the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

', 'GetSipMediaApplicationLoggingConfiguration' => '

Retrieves the logging configuration for the specified SIP media application.

', 'GetSipRule' => '

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

', 'GetSpeakerSearchTask' => '

Retrieves the details of the specified speaker search task.

', 'GetVoiceConnector' => '

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

', 'GetVoiceConnectorEmergencyCallingConfiguration' => '

Retrieves the emergency calling configuration details for the specified Voice Connector.

', 'GetVoiceConnectorGroup' => '

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

', 'GetVoiceConnectorLoggingConfiguration' => '

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

', 'GetVoiceConnectorOrigination' => '

Retrieves the origination settings for the specified Voice Connector.

', 'GetVoiceConnectorProxy' => '

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

', 'GetVoiceConnectorStreamingConfiguration' => '

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

', 'GetVoiceConnectorTermination' => '

Retrieves the termination setting details for the specified Voice Connector.

', 'GetVoiceConnectorTerminationHealth' => '

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

', 'GetVoiceProfile' => '

Retrieves the details of the specified voice profile.

', 'GetVoiceProfileDomain' => '

Retrieves the details of the specified voice profile domain.

', 'GetVoiceToneAnalysisTask' => '

Retrieves the details of a voice tone analysis task.

', 'ListAvailableVoiceConnectorRegions' => '

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

', 'ListPhoneNumberOrders' => '

Lists the phone numbers for an administrator\'s Amazon Chime SDK account.

', 'ListPhoneNumbers' => '

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

', 'ListProxySessions' => '

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

', 'ListSipMediaApplications' => '

Lists the SIP media applications under the administrator\'s AWS account.

', 'ListSipRules' => '

Lists the SIP rules under the administrator\'s AWS account.

', 'ListSupportedPhoneNumberCountries' => '

Lists the countries that you can order phone numbers from.

', 'ListTagsForResource' => '

Returns a list of the tags in a given resource.

', 'ListVoiceConnectorGroups' => '

Lists the Amazon Chime SDK Voice Connector groups in the administrator\'s AWS account.

', 'ListVoiceConnectorTerminationCredentials' => '

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

', 'ListVoiceConnectors' => '

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

', 'ListVoiceProfileDomains' => '

Lists the specified voice profile domains in the administrator\'s AWS account.

', 'ListVoiceProfiles' => '

Lists the voice profiles in a voice profile domain.

', 'PutSipMediaApplicationAlexaSkillConfiguration' => '

Updates the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

', 'PutSipMediaApplicationLoggingConfiguration' => '

Updates the logging configuration for the specified SIP media application.

', 'PutVoiceConnectorEmergencyCallingConfiguration' => '

Updates a Voice Connector\'s emergency calling configuration.

', 'PutVoiceConnectorLoggingConfiguration' => '

Updates a Voice Connector\'s logging configuration.

', 'PutVoiceConnectorOrigination' => '

Updates a Voice Connector\'s origination settings.

', 'PutVoiceConnectorProxy' => '

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

', 'PutVoiceConnectorStreamingConfiguration' => '

Updates a Voice Connector\'s streaming configuration settings.

', 'PutVoiceConnectorTermination' => '

Updates a Voice Connector\'s termination settings.

', 'PutVoiceConnectorTerminationCredentials' => '

Updates a Voice Connector\'s termination credentials.

', 'RestorePhoneNumber' => '

Restores a deleted phone number.

', 'SearchAvailablePhoneNumbers' => '

Searches the provisioned phone numbers in an organization.

', 'StartSpeakerSearchTask' => '

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

', 'StartVoiceToneAnalysisTask' => '

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

', 'StopSpeakerSearchTask' => '

Stops a speaker search task.

', 'StopVoiceToneAnalysisTask' => '

Stops a voice tone analysis task.

', 'TagResource' => '

Adds a tag to the specified resource.

', 'UntagResource' => '

Removes tags from a resource.

', 'UpdateGlobalSettings' => '

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

', 'UpdatePhoneNumber' => '

Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type, calling name, or phone number name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

', 'UpdatePhoneNumberSettings' => '

Updates the phone number settings for the administrator\'s AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

', 'UpdateProxySession' => '

Updates the specified proxy session details, such as voice or SMS capabilities.

', 'UpdateSipMediaApplication' => '

Updates the details of the specified SIP media application.

', 'UpdateSipMediaApplicationCall' => '

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

', 'UpdateSipRule' => '

Updates the details of the specified SIP rule.

', 'UpdateVoiceConnector' => '

Updates the details for the specified Amazon Chime SDK Voice Connector.

', 'UpdateVoiceConnectorGroup' => '

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

', 'UpdateVoiceProfile' => '

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

', 'UpdateVoiceProfileDomain' => '

Updates the settings for the specified voice profile domain.

', 'ValidateE911Address' => '

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

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

You don\'t have the permissions needed to run this action.

', 'refs' => [], ], 'Address' => [ 'base' => '

A validated address.

', 'refs' => [ 'ValidateE911AddressResponse$Address' => '

The validated address.

', ], ], 'AlexaSkillId' => [ 'base' => NULL, 'refs' => [ 'AlexaSkillIdList$member' => NULL, ], ], 'AlexaSkillIdList' => [ 'base' => NULL, 'refs' => [ 'SipMediaApplicationAlexaSkillConfiguration$AlexaSkillIds' => '

The ID of the Alexa Skill configuration.

', ], ], 'AlexaSkillStatus' => [ 'base' => NULL, 'refs' => [ 'SipMediaApplicationAlexaSkillConfiguration$AlexaSkillStatus' => '

The status of the Alexa Skill configuration.

', ], ], 'Alpha2CountryCode' => [ 'base' => NULL, 'refs' => [ 'DNISEmergencyCallingConfiguration$CallingCountry' => '

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

', 'PhoneNumber$Country' => '

The phone number\'s country. Format: ISO 3166-1 alpha-2.

', 'PhoneNumberCountry$CountryCode' => '

The phone number country code. Format: ISO 3166-1 alpha-2.

', 'SearchAvailablePhoneNumbersRequest$Country' => '

Confines a search to just the phone numbers associated with the specified country.

', ], ], 'AreaCode' => [ 'base' => NULL, 'refs' => [ 'GeoMatchParams$AreaCode' => '

The area code.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => '

The resource ARN.

', 'MediaInsightsConfiguration$ConfigurationArn' => '

The configuration\'s ARN.

', 'ServerSideEncryptionConfiguration$KmsKeyArn' => '

The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

', 'TagResourceRequest$ResourceARN' => '

The ARN of the resource being tagged.

', 'UntagResourceRequest$ResourceARN' => '

The ARN of the resource having its tags removed.

', 'VoiceProfile$VoiceProfileArn' => '

The ARN of the voice profile.

', 'VoiceProfileDomain$VoiceProfileDomainArn' => '

The voice profile domain\'s Amazon Resource Number (ARN).

', 'VoiceProfileDomainSummary$VoiceProfileDomainArn' => '

The ARN of a voice profile in a voice profile domain summary.

', 'VoiceProfileSummary$VoiceProfileArn' => '

The ARN of the voice profile in a voice profile summary.

', ], ], 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePhoneNumbersWithVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePhoneNumbersWithVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'BadRequestException' => [ 'base' => '

The input parameters don\'t match the service\'s restrictions.

', 'refs' => [], ], 'BatchDeletePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchUpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchUpdatePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CallDetails$IsCaller' => '

Identifies a person as the caller or the callee.

', 'CreateVoiceConnectorRequest$RequireEncryption' => '

Enables or disables encryption for the Voice Connector.

', 'GetVoiceToneAnalysisTaskRequest$IsCaller' => '

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

', 'LoggingConfiguration$EnableSIPLogs' => '

Boolean that enables sending SIP message logs to Amazon CloudWatch.

', 'LoggingConfiguration$EnableMediaMetricLogs' => '

Enables or disables media metrics logging.

', 'MediaInsightsConfiguration$Disabled' => '

Denotes the configration as enabled or disabled.

', 'Origination$Disabled' => '

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

', 'Proxy$Disabled' => '

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

', 'PutVoiceConnectorProxyRequest$Disabled' => '

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

', 'SipMediaApplicationLoggingConfiguration$EnableSipMediaApplicationMessageLogs' => '

Enables message logging for the specified SIP media application.

', 'SipRule$Disabled' => '

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

', 'StreamingConfiguration$Disabled' => '

When true, streaming to Kinesis is off.

', 'Termination$Disabled' => '

When termination is disabled, outbound calls cannot be made.

', 'UpdateVoiceConnectorRequest$RequireEncryption' => '

When enabled, requires encryption for the Voice Connector.

', 'VoiceConnector$RequireEncryption' => '

Enables or disables encryption for the Voice Connector.

', ], ], 'CallDetails' => [ 'base' => '

The details of an Amazon Chime SDK Voice Connector call.

', 'refs' => [ 'SpeakerSearchTask$CallDetails' => '

The call details of a speaker search task.

', 'VoiceToneAnalysisTask$CallDetails' => '

The call details of a voice tone analysis task.

', ], ], 'CallLegType' => [ 'base' => NULL, 'refs' => [ 'StartSpeakerSearchTaskRequest$CallLeg' => '

Specifies which call leg to stream for speaker search.

', ], ], 'CallingName' => [ 'base' => NULL, 'refs' => [ 'GetPhoneNumberSettingsResponse$CallingName' => '

The default outbound calling name for the account.

', 'PhoneNumber$CallingName' => '

The outbound calling name associated with the phone number.

', 'UpdatePhoneNumberRequest$CallingName' => '

The outbound calling name associated with the phone number.

', 'UpdatePhoneNumberRequestItem$CallingName' => '

The outbound calling name to update.

', 'UpdatePhoneNumberSettingsRequest$CallingName' => '

The default outbound calling name for the account.

', ], ], 'CallingNameStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$CallingNameStatus' => '

The outbound calling name status.

', ], ], 'CallingRegion' => [ 'base' => NULL, 'refs' => [ 'CallingRegionList$member' => NULL, ], ], 'CallingRegionList' => [ 'base' => NULL, 'refs' => [ 'Termination$CallingRegions' => '

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

', ], ], 'CandidateAddress' => [ 'base' => '

A suggested address.

', 'refs' => [ 'CandidateAddressList$member' => NULL, ], ], 'CandidateAddressList' => [ 'base' => NULL, 'refs' => [ 'ValidateE911AddressResponse$CandidateAddressList' => '

The list of address suggestions..

', ], ], 'Capability' => [ 'base' => NULL, 'refs' => [ 'CapabilityList$member' => NULL, ], ], 'CapabilityList' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$Capabilities' => '

The proxy session\'s capabilities.

', 'ProxySession$Capabilities' => '

The proxy session capabilities.

', 'UpdateProxySessionRequest$Capabilities' => '

The proxy session capabilities.

', ], ], 'ClientRequestId' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceProfileDomainRequest$ClientRequestToken' => '

The unique identifier for the client request. Use a different token for different domain creation requests.

', 'StartSpeakerSearchTaskRequest$ClientRequestToken' => '

The unique identifier for the client request. Use a different token for different speaker search tasks.

', 'StartVoiceToneAnalysisTaskRequest$ClientRequestToken' => '

The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

', ], ], 'ConfidenceScore' => [ 'base' => NULL, 'refs' => [ 'SpeakerSearchResult$ConfidenceScore' => '

The confidence score in the speaker search analysis.

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

Multiple instances of the same request were made simultaneously.

', 'refs' => [], ], 'Country' => [ 'base' => NULL, 'refs' => [ 'CountryList$member' => NULL, 'GeoMatchParams$Country' => '

The country.

', ], ], 'CountryList' => [ 'base' => NULL, 'refs' => [ 'PutVoiceConnectorProxyRequest$PhoneNumberPoolCountries' => '

The countries for proxy phone numbers to be selected from.

', ], ], 'CpsLimit' => [ 'base' => NULL, 'refs' => [ 'Termination$CpsLimit' => '

The limit on calls per second. Max value based on account service quota. Default value of 1.

', ], ], 'CreatePhoneNumberOrderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePhoneNumberOrderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProxySessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationCallRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationCallResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipMediaApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSipRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVoiceProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'Credential' => [ 'base' => '

The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'CredentialList$member' => NULL, ], ], 'CredentialList' => [ 'base' => NULL, 'refs' => [ 'PutVoiceConnectorTerminationCredentialsRequest$Credentials' => '

The termination credentials being updated.

', ], ], 'DNISEmergencyCallingConfiguration' => [ 'base' => '

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector\'s emergency calling configuration.

', 'refs' => [ 'DNISEmergencyCallingConfigurationList$member' => NULL, ], ], 'DNISEmergencyCallingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'EmergencyCallingConfiguration$DNIS' => '

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

', ], ], 'DataRetentionInHours' => [ 'base' => NULL, 'refs' => [ 'StreamingConfiguration$DataRetentionInHours' => '

The amount of time, in hours, to the Kinesis data.

', ], ], 'DeletePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorOriginationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorStreamingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorTerminationCredentialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceConnectorTerminationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumbersFromVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'E164PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationCallRequest$FromPhoneNumber' => '

The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

', 'CreateSipMediaApplicationCallRequest$ToPhoneNumber' => '

The phone number that the service should call.

', 'DNISEmergencyCallingConfiguration$EmergencyPhoneNumber' => '

The DNIS phone number that you route emergency calls to, in E.164 format.

', 'DNISEmergencyCallingConfiguration$TestPhoneNumber' => '

The DNIS phone number for routing test emergency calls to, in E.164 format.

', 'E164PhoneNumberList$member' => NULL, 'OrderedPhoneNumber$E164PhoneNumber' => '

The phone number, in E.164 format.

', 'Participant$PhoneNumber' => '

The participant\'s phone number.

', 'Participant$ProxyPhoneNumber' => '

The participant\'s proxy phone number.

', 'ParticipantPhoneNumberList$member' => NULL, 'PhoneNumber$E164PhoneNumber' => '

The phone number, in E.164 format.

', 'Proxy$FallBackPhoneNumber' => '

The phone number to route calls to after a proxy session expires.

', 'PutVoiceConnectorProxyRequest$FallBackPhoneNumber' => '

The phone number to route calls to after a proxy session expires.

', 'Termination$DefaultPhoneNumber' => '

The default outbound calling number.

', ], ], 'E164PhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'AssociatePhoneNumbersWithVoiceConnectorRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'CreatePhoneNumberOrderRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$E164PhoneNumbers' => '

The list of phone numbers, in E.164 format.

', 'DisassociatePhoneNumbersFromVoiceConnectorRequest$E164PhoneNumbers' => '

List of phone numbers, in E.164 format.

', 'SearchAvailablePhoneNumbersResponse$E164PhoneNumbers' => '

Confines a search to just the phone numbers in the E.164 format.

', ], ], 'EmergencyCallingConfiguration' => [ 'base' => '

The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration' => '

The details of the emergency calling configuration.

', 'PutVoiceConnectorEmergencyCallingConfigurationRequest$EmergencyCallingConfiguration' => '

The configuration being updated.

', 'PutVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration' => '

The updated configuration.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberError$ErrorCode' => '

The error code.

', ], ], 'ForbiddenException' => [ 'base' => '

The client is permanently forbidden from making the request.

', 'refs' => [], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'SipMediaApplicationEndpoint$LambdaArn' => '

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

', ], ], 'GeoMatchLevel' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$GeoMatchLevel' => '

The preference for matching the country or area code of the proxy phone number with that of the first participant.

', 'ProxySession$GeoMatchLevel' => '

The preference for matching the country or area code of the proxy phone number with that of the first participant.

', ], ], 'GeoMatchParams' => [ 'base' => '

The country and area code for a proxy phone number in a proxy phone session.

', 'refs' => [ 'CreateProxySessionRequest$GeoMatchParams' => '

The country and area code for the proxy phone number.

', 'ProxySession$GeoMatchParams' => '

The country and area code for the proxy phone number.

', ], ], 'GetGlobalSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberOrderRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberOrderResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPhoneNumberSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProxySessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipMediaApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSipRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSpeakerSearchTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSpeakerSearchTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorOriginationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorOriginationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorStreamingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorStreamingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationHealthRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationHealthResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceConnectorTerminationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceToneAnalysisTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVoiceToneAnalysisTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'GoneException' => [ 'base' => '

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

', 'refs' => [], ], 'GuidString' => [ 'base' => NULL, 'refs' => [ 'GetPhoneNumberOrderRequest$PhoneNumberOrderId' => '

The ID of the phone number order .

', 'PhoneNumber$OrderId' => '

The phone number\'s order ID.

', 'PhoneNumberOrder$PhoneNumberOrderId' => '

The ID of the phone order.

', 'SipMediaApplicationCall$TransactionId' => '

The call\'s transaction ID.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Proxy$DefaultSessionExpiryMinutes' => '

The default number of minutes allowed for proxy sessions.

', 'PutVoiceConnectorProxyRequest$DefaultSessionExpiryMinutes' => '

The default number of minutes allowed for proxy session.

', ], ], 'Iso8601Timestamp' => [ 'base' => NULL, 'refs' => [ 'GetPhoneNumberSettingsResponse$CallingNameUpdatedTimestamp' => '

The updated outbound calling name timestamp, in ISO 8601 format.

', 'PhoneNumber$CreatedTimestamp' => '

The phone number creation timestamp, in ISO 8601 format.

', 'PhoneNumber$UpdatedTimestamp' => '

The updated phone number timestamp, in ISO 8601 format.

', 'PhoneNumber$DeletionTimestamp' => '

The deleted phone number timestamp, in ISO 8601 format.

', 'PhoneNumberAssociation$AssociatedTimestamp' => '

The timestamp of the phone number association, in ISO 8601 format.

', 'PhoneNumberOrder$CreatedTimestamp' => '

The phone number order creation time stamp, in ISO 8601 format.

', 'PhoneNumberOrder$UpdatedTimestamp' => '

The updated phone number order time stamp, in ISO 8601 format.

', 'ProxySession$CreatedTimestamp' => '

The created time stamp, in ISO 8601 format.

', 'ProxySession$UpdatedTimestamp' => '

The updated time stamp, in ISO 8601 format.

', 'ProxySession$EndedTimestamp' => '

The ended time stamp, in ISO 8601 format.

', 'SipMediaApplication$CreatedTimestamp' => '

The SIP media application creation timestamp, in ISO 8601 format.

', 'SipMediaApplication$UpdatedTimestamp' => '

The time at which the SIP media application was updated.

', 'SipRule$CreatedTimestamp' => '

The time at which the SIP rule was created, in ISO 8601 format.

', 'SipRule$UpdatedTimestamp' => '

The time at which the SIP rule was updated, in ISO 8601 format.

', 'SpeakerSearchTask$CreatedTimestamp' => '

The time at which a speaker search task was created.

', 'SpeakerSearchTask$UpdatedTimestamp' => '

The time at which a speaker search task was updated.

', 'SpeakerSearchTask$StartedTimestamp' => '

The time at which the speaker search task began.

', 'TerminationHealth$Timestamp' => '

The timestamp, in ISO 8601 format.

', 'VoiceConnector$CreatedTimestamp' => '

The Voice Connector\'s creation timestamp, in ISO 8601 format.

', 'VoiceConnector$UpdatedTimestamp' => '

The Voice Connector\'s updated timestamp, in ISO 8601 format.

', 'VoiceConnectorGroup$CreatedTimestamp' => '

The Voice Connector group\'s creation time stamp, in ISO 8601 format.

', 'VoiceConnectorGroup$UpdatedTimestamp' => '

The Voice Connector group\'s creation time stamp, in ISO 8601 format.

', 'VoiceProfile$CreatedTimestamp' => '

The time at which the voice profile was created and enrolled.

', 'VoiceProfile$UpdatedTimestamp' => '

The time at which the voice profile was last updated.

', 'VoiceProfile$ExpirationTimestamp' => '

The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

', 'VoiceProfileDomain$CreatedTimestamp' => '

The time at which the voice profile domain was created.

', 'VoiceProfileDomain$UpdatedTimestamp' => '

The time at which the voice profile was last updated.

', 'VoiceProfileDomainSummary$CreatedTimestamp' => '

The time at which the voice profile domain summary was created.

', 'VoiceProfileDomainSummary$UpdatedTimestamp' => '

The time at which the voice profile domain summary was last updated.

', 'VoiceProfileSummary$CreatedTimestamp' => '

The time at which a voice profile summary was created.

', 'VoiceProfileSummary$UpdatedTimestamp' => '

The time at which a voice profile summary was last updated.

', 'VoiceProfileSummary$ExpirationTimestamp' => '

Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile\'s voice print and extend the life of the summary.

', 'VoiceToneAnalysisTask$CreatedTimestamp' => '

The time at which a voice tone analysis task was created.

', 'VoiceToneAnalysisTask$UpdatedTimestamp' => '

The time at which a voice tone analysis task was updated.

', 'VoiceToneAnalysisTask$StartedTimestamp' => '

The time at which a voice tone analysis task started.

', ], ], 'LanguageCode' => [ 'base' => NULL, 'refs' => [ 'StartVoiceToneAnalysisTaskRequest$LanguageCode' => '

The language code.

', ], ], 'ListAvailableVoiceConnectorRegionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumberOrdersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumberOrdersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProxySessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProxySessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSipMediaApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSipMediaApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSipRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSipRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedPhoneNumberCountriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedPhoneNumberCountriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorTerminationCredentialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorTerminationCredentialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceConnectorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfileDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfileDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVoiceProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoggingConfiguration' => [ 'base' => '

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.

', 'refs' => [ 'GetVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration' => '

The logging configuration details .

', 'PutVoiceConnectorLoggingConfigurationRequest$LoggingConfiguration' => '

The logging configuration being updated.

', 'PutVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration' => '

The updated logging configuration.

', ], ], 'MediaInsightsConfiguration' => [ 'base' => '

The configuration for a call analytics task.

', 'refs' => [ 'StreamingConfiguration$MediaInsightsConfiguration' => '

The call analytics configuration.

', ], ], 'NextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListProxySessionsRequest$NextToken' => '

The token used to retrieve the next page of results.

', 'ListProxySessionsResponse$NextToken' => '

The token used to retrieve the next page of results.

', 'ListSipMediaApplicationsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListSipMediaApplicationsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListSipRulesRequest$NextToken' => '

The token used to return the next page of results.

', 'ListSipRulesResponse$NextToken' => '

The token used to return the next page of results.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Amazon Chime SDK Voice Connector group ID.

', 'AssociatePhoneNumbersWithVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'CreateSipMediaApplicationCallRequest$SipMediaApplicationId' => '

The ID of the SIP media application.

', 'CreateSipRuleRequest$TriggerValue' => '

If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

', 'DeleteSipMediaApplicationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'DeleteSipRuleRequest$SipRuleId' => '

The SIP rule ID.

', 'DeleteVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector Group ID.

', 'DeleteVoiceConnectorOriginationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteVoiceConnectorTerminationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector group ID.

', 'DisassociatePhoneNumbersFromVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'GetSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'GetSipMediaApplicationRequest$SipMediaApplicationId' => '

The SIP media application ID .

', 'GetSipRuleRequest$SipRuleId' => '

The SIP rule ID.

', 'GetVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector group ID.

', 'GetVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorOriginationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorTerminationHealthRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorTerminationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ListSipRulesRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'ListVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'PutVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorOriginationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'PutVoiceConnectorTerminationRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'SipMediaApplication$SipMediaApplicationId' => '

A SIP media application\'s ID.

', 'SipMediaApplication$SipMediaApplicationArn' => '

The ARN of the SIP media application.

', 'SipRule$SipRuleId' => '

A SIP rule\'s ID.

', 'SipRule$TriggerValue' => '

The value set for a SIP rule\'s trigger type. Either a phone number or a URI hostname.

', 'SipRuleTargetApplication$SipMediaApplicationId' => '

The ID of a rule\'s target SIP media application.

', 'SpeakerSearchTask$SpeakerSearchTaskStatus' => '

The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

', 'UpdateSipMediaApplicationCallRequest$SipMediaApplicationId' => '

The ID of the SIP media application handling the call.

', 'UpdateSipMediaApplicationCallRequest$TransactionId' => '

The ID of the call transaction.

', 'UpdateSipMediaApplicationRequest$SipMediaApplicationId' => '

The SIP media application ID.

', 'UpdateSipRuleRequest$SipRuleId' => '

The SIP rule ID.

', 'UpdateVoiceConnectorGroupRequest$VoiceConnectorGroupId' => '

The Voice Connector ID.

', 'UpdateVoiceConnectorRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ValidateE911AddressRequest$AwsAccountId' => '

The AWS account ID.

', 'VoiceConnector$VoiceConnectorId' => '

The Voice Connector\'s ID.

', 'VoiceConnector$VoiceConnectorArn' => '

The ARN of the Voice Connector.

', 'VoiceConnectorGroup$VoiceConnectorGroupId' => '

The ID of a Voice Connector group.

', 'VoiceConnectorGroup$VoiceConnectorGroupArn' => '

The ARN of the Voice Connector group.

', 'VoiceConnectorItem$VoiceConnectorId' => '

The Voice Connector ID.

', 'VoiceToneAnalysisTask$VoiceToneAnalysisTaskStatus' => '

The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

', ], ], 'NonEmptyString128' => [ 'base' => NULL, 'refs' => [ 'CallDetails$VoiceConnectorId' => '

The Voice Connector ID.

', 'CreateProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'DeleteProxySessionRequest$ProxySessionId' => '

The proxy session ID.

', 'DeleteVoiceConnectorProxyRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetProxySessionRequest$ProxySessionId' => '

The proxy session ID.

', 'GetSpeakerSearchTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceConnectorProxyRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'GetVoiceToneAnalysisTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ListProxySessionsRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'ProxySession$VoiceConnectorId' => '

The Voice Connector ID.

', 'ProxySession$ProxySessionId' => '

The proxy session ID.

', 'PutVoiceConnectorProxyRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StartSpeakerSearchTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StartVoiceToneAnalysisTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StopSpeakerSearchTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'StopVoiceToneAnalysisTaskRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'UpdateProxySessionRequest$VoiceConnectorId' => '

The Voice Connector ID.

', 'UpdateProxySessionRequest$ProxySessionId' => '

The proxy session ID.

', ], ], 'NonEmptyString256' => [ 'base' => NULL, 'refs' => [ 'CallDetails$TransactionId' => '

The transaction ID of a Voice Connector call.

', 'CreateVoiceProfileRequest$SpeakerSearchTaskId' => '

The ID of the speaker search task.

', 'DeleteVoiceProfileDomainRequest$VoiceProfileDomainId' => '

The voice profile domain ID.

', 'DeleteVoiceProfileRequest$VoiceProfileId' => '

The voice profile ID.

', 'GetSpeakerSearchTaskRequest$SpeakerSearchTaskId' => '

The ID of the speaker search task.

', 'GetVoiceProfileDomainRequest$VoiceProfileDomainId' => '

The voice profile domain ID.

', 'GetVoiceProfileRequest$VoiceProfileId' => '

The voice profile ID.

', 'GetVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId' => '

The ID of the voice tone anlysis task.

', 'ListVoiceProfilesRequest$VoiceProfileDomainId' => '

The ID of the voice profile domain.

', 'SpeakerSearchDetails$VoiceprintGenerationStatus' => '

The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..

', 'SpeakerSearchResult$VoiceProfileId' => '

The voice profile ID.

', 'SpeakerSearchTask$SpeakerSearchTaskId' => '

The speaker search task ID.

', 'StartSpeakerSearchTaskRequest$TransactionId' => '

The transaction ID of the call being analyzed.

', 'StartSpeakerSearchTaskRequest$VoiceProfileDomainId' => '

The ID of the voice profile domain that will store the voice profile.

', 'StartVoiceToneAnalysisTaskRequest$TransactionId' => '

The transaction ID.

', 'StopSpeakerSearchTaskRequest$SpeakerSearchTaskId' => '

The speaker search task ID.

', 'StopVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId' => '

The ID of the voice tone analysis task.

', 'UpdateVoiceProfileDomainRequest$VoiceProfileDomainId' => '

The domain ID.

', 'UpdateVoiceProfileRequest$VoiceProfileId' => '

The profile ID.

', 'UpdateVoiceProfileRequest$SpeakerSearchTaskId' => '

The ID of the speaker search task.

', 'VoiceProfile$VoiceProfileId' => '

The ID of the voice profile.

', 'VoiceProfile$VoiceProfileDomainId' => '

The ID of the domain that contains the voice profile.

', 'VoiceProfileDomain$VoiceProfileDomainId' => '

The ID of the voice profile domain.

', 'VoiceProfileDomainSummary$VoiceProfileDomainId' => '

The ID of the voice profile domain summary.

', 'VoiceProfileSummary$VoiceProfileId' => '

The ID of the voice profile in a voice profile summary.

', 'VoiceProfileSummary$VoiceProfileDomainId' => '

The ID of the voice profile domain in a voice profile summary.

', 'VoiceToneAnalysisTask$VoiceToneAnalysisTaskId' => '

The ID of the voice tone analysis task.

', ], ], 'NonEmptyStringList' => [ 'base' => NULL, 'refs' => [ 'BatchDeletePhoneNumberRequest$PhoneNumberIds' => '

List of phone number IDs.

', ], ], 'NotFoundException' => [ 'base' => '

The requested resource couldn\'t be found.

', 'refs' => [], ], 'NotificationTarget' => [ 'base' => NULL, 'refs' => [ 'StreamingNotificationTarget$NotificationTarget' => '

The streaming notification target.

', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupRequest$ForceAssociate' => '

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

', 'AssociatePhoneNumbersWithVoiceConnectorRequest$ForceAssociate' => '

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

', 'CreateSipRuleRequest$Disabled' => '

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

', 'PhoneNumberCapabilities$InboundCall' => '

Allows or denies inbound calling for the specified phone number.

', 'PhoneNumberCapabilities$OutboundCall' => '

Allows or denies outbound calling for the specified phone number.

', 'PhoneNumberCapabilities$InboundSMS' => '

Allows or denies inbound SMS messaging for the specified phone number.

', 'PhoneNumberCapabilities$OutboundSMS' => '

Allows or denies outbound SMS messaging for the specified phone number.

', 'PhoneNumberCapabilities$InboundMMS' => '

Allows or denies inbound MMS messaging for the specified phone number.

', 'PhoneNumberCapabilities$OutboundMMS' => '

Allows or denies inbound MMS messaging for the specified phone number.

', 'UpdateSipRuleRequest$Disabled' => '

The new value that indicates whether the rule is disabled.

', ], ], 'NumberSelectionBehavior' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$NumberSelectionBehavior' => '

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

', 'ProxySession$NumberSelectionBehavior' => '

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

', ], ], 'OrderedPhoneNumber' => [ 'base' => '

A phone number for which an order has been placed.

', 'refs' => [ 'OrderedPhoneNumberList$member' => NULL, ], ], 'OrderedPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberOrder$OrderedPhoneNumbers' => '

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

', ], ], 'OrderedPhoneNumberStatus' => [ 'base' => NULL, 'refs' => [ 'OrderedPhoneNumber$Status' => '

The phone number status.

', ], ], 'Origination' => [ 'base' => '

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice Connector.

The parameters listed below are not required, but you must use at least one.

', 'refs' => [ 'GetVoiceConnectorOriginationResponse$Origination' => '

The origination setting details.

', 'PutVoiceConnectorOriginationRequest$Origination' => '

The origination settings being updated.

', 'PutVoiceConnectorOriginationResponse$Origination' => '

The updated origination settings.

', ], ], 'OriginationRoute' => [ 'base' => '

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

The parameters listed below are not required, but you must use at least one.

', 'refs' => [ 'OriginationRouteList$member' => NULL, ], ], 'OriginationRouteList' => [ 'base' => NULL, 'refs' => [ 'Origination$Routes' => '

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

', ], ], 'OriginationRoutePriority' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Priority' => '

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

', ], ], 'OriginationRouteProtocol' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Protocol' => '

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

', ], ], 'OriginationRouteWeight' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Weight' => '

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

', ], ], 'Participant' => [ 'base' => '

The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.

', 'refs' => [ 'Participants$member' => NULL, ], ], 'ParticipantPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$ParticipantPhoneNumbers' => '

The participant phone numbers.

', ], ], 'Participants' => [ 'base' => NULL, 'refs' => [ 'ProxySession$Participants' => '

The proxy session participants.

', ], ], 'PhoneNumber' => [ 'base' => '

A phone number used to call an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetPhoneNumberResponse$PhoneNumber' => '

The phone number details.

', 'PhoneNumberList$member' => NULL, 'RestorePhoneNumberResponse$PhoneNumber' => '

The restored phone number.

', 'UpdatePhoneNumberResponse$PhoneNumber' => '

The updated phone number details.

', ], ], 'PhoneNumberAssociation' => [ 'base' => '

The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

', 'refs' => [ 'PhoneNumberAssociationList$member' => NULL, ], ], 'PhoneNumberAssociationList' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$Associations' => '

The phone number\'s associations.

', ], ], 'PhoneNumberAssociationName' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersRequest$FilterName' => '

The filter to limit the number of results.

', 'PhoneNumberAssociation$Name' => '

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

', ], ], 'PhoneNumberCapabilities' => [ 'base' => '

The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and outbound calling, and text messaging.

', 'refs' => [ 'PhoneNumber$Capabilities' => '

The phone number\'s capabilities.

', ], ], 'PhoneNumberCountriesList' => [ 'base' => NULL, 'refs' => [ 'ListSupportedPhoneNumberCountriesResponse$PhoneNumberCountries' => '

The supported phone number countries.

', ], ], 'PhoneNumberCountry' => [ 'base' => '

The phone number\'s country.

', 'refs' => [ 'PhoneNumberCountriesList$member' => NULL, ], ], 'PhoneNumberError' => [ 'base' => '

If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.

', 'refs' => [ 'PhoneNumberErrorList$member' => NULL, ], ], 'PhoneNumberErrorList' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumbersWithVoiceConnectorGroupResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'AssociatePhoneNumbersWithVoiceConnectorResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'BatchDeletePhoneNumberResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'BatchUpdatePhoneNumberResponse$PhoneNumberErrors' => '

A list of failed phone numbers and their error messages.

', 'DisassociatePhoneNumbersFromVoiceConnectorGroupResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', 'DisassociatePhoneNumbersFromVoiceConnectorResponse$PhoneNumberErrors' => '

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

', ], ], 'PhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersResponse$PhoneNumbers' => '

The phone number details.

', ], ], 'PhoneNumberMaxResults' => [ 'base' => NULL, 'refs' => [ 'SearchAvailablePhoneNumbersRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'PhoneNumberName' => [ 'base' => NULL, 'refs' => [ 'CreatePhoneNumberOrderRequest$Name' => '

Specifies the name assigned to one or more phone numbers.

', 'PhoneNumber$Name' => '

The name of the phone number.

', 'UpdatePhoneNumberRequest$Name' => '

Specifies the updated name assigned to one or more phone numbers.

', 'UpdatePhoneNumberRequestItem$Name' => '

The name of the phone number.

', ], ], 'PhoneNumberOrder' => [ 'base' => '

The details of an Amazon Chime SDK phone number order.

', 'refs' => [ 'CreatePhoneNumberOrderResponse$PhoneNumberOrder' => '

The phone number order details.

', 'GetPhoneNumberOrderResponse$PhoneNumberOrder' => '

The phone number order details.

', 'PhoneNumberOrderList$member' => NULL, ], ], 'PhoneNumberOrderList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumberOrdersResponse$PhoneNumberOrders' => '

The phone number order details.

', ], ], 'PhoneNumberOrderStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberOrder$Status' => '

The status of the phone number order.

', ], ], 'PhoneNumberOrderType' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberOrder$OrderType' => '

The type of phone number being ordered, local or toll-free.

', ], ], 'PhoneNumberProductType' => [ 'base' => NULL, 'refs' => [ 'CreatePhoneNumberOrderRequest$ProductType' => '

The phone number product type.

', 'ListPhoneNumbersRequest$ProductType' => '

The phone number product types.

', 'ListSupportedPhoneNumberCountriesRequest$ProductType' => '

The phone number product type.

', 'PhoneNumber$ProductType' => '

The phone number\'s product type.

', 'PhoneNumberOrder$ProductType' => '

The phone number order product type.

', 'UpdatePhoneNumberRequest$ProductType' => '

The product type.

', 'UpdatePhoneNumberRequestItem$ProductType' => '

The product type to update.

', ], ], 'PhoneNumberStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$Status' => '

The phone number\'s status.

', ], ], 'PhoneNumberType' => [ 'base' => NULL, 'refs' => [ 'PhoneNumber$Type' => '

The phone number\'s type.

', 'PhoneNumberTypeList$member' => NULL, 'SearchAvailablePhoneNumbersRequest$PhoneNumberType' => '

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

', ], ], 'PhoneNumberTypeList' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberCountry$SupportedPhoneNumberTypes' => '

The supported phone number types.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'OriginationRoute$Port' => '

The designated origination route port. Defaults to 5060.

', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$ExpiryMinutes' => '

The number of minutes allowed for the proxy session.

', 'ProxySession$ExpiryMinutes' => '

The number of minutes allowed for the proxy session.

', 'UpdateProxySessionRequest$ExpiryMinutes' => '

The number of minutes allowed for the proxy session.

', ], ], 'Proxy' => [ 'base' => '

The proxy configuration for an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetVoiceConnectorProxyResponse$Proxy' => '

The proxy configuration details.

', 'PutVoiceConnectorProxyResponse$Proxy' => '

The proxy configuration details.

', ], ], 'ProxySession' => [ 'base' => '

The proxy session for an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'CreateProxySessionResponse$ProxySession' => '

The proxy session details.

', 'GetProxySessionResponse$ProxySession' => '

The proxy session details.

', 'ProxySessions$member' => NULL, 'UpdateProxySessionResponse$ProxySession' => '

The updated proxy session details.

', ], ], 'ProxySessionNameString' => [ 'base' => NULL, 'refs' => [ 'CreateProxySessionRequest$Name' => '

The name of the proxy session.

', ], ], 'ProxySessionStatus' => [ 'base' => NULL, 'refs' => [ 'ListProxySessionsRequest$Status' => '

The proxy session status.

', 'ProxySession$Status' => '

The proxy session status.

', ], ], 'ProxySessions' => [ 'base' => NULL, 'refs' => [ 'ListProxySessionsResponse$ProxySessions' => '

The proxy sessions\' details.

', ], ], 'PutSipMediaApplicationAlexaSkillConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSipMediaApplicationAlexaSkillConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutSipMediaApplicationLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSipMediaApplicationLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorEmergencyCallingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorEmergencyCallingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorOriginationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorOriginationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorStreamingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorStreamingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorTerminationCredentialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorTerminationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutVoiceConnectorTerminationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceLimitExceededException' => [ 'base' => '

The request exceeds the resource limit.

', 'refs' => [], ], 'RestorePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestorePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResultMax' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumberOrdersRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListPhoneNumbersRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListProxySessionsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListSipMediaApplicationsRequest$MaxResults' => '

The maximum number of results to return in a single call. Defaults to 100.

', 'ListSipRulesRequest$MaxResults' => '

The maximum number of results to return in a single call. Defaults to 100.

', 'ListVoiceConnectorGroupsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListVoiceConnectorsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListVoiceProfileDomainsRequest$MaxResults' => '

The maximum number of results to return in a single call.

', 'ListVoiceProfilesRequest$MaxResults' => '

The maximum number of results in the request.

', ], ], 'SMACreateCallArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationCallRequest$ArgumentsMap' => '

Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"

', ], ], 'SMAUpdateCallArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'UpdateSipMediaApplicationCallRequest$Arguments' => '

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

', ], ], 'SearchAvailablePhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchAvailablePhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Address$streetName' => '

The address street, such as 8th Avenue.

', 'Address$streetSuffix' => '

The address suffix, such as the N in 8th Avenue N.

', 'Address$postDirectional' => '

An address suffix location, such as the S. Unit A in Central Park S. Unit A.

', 'Address$preDirectional' => '

An address prefix location, such as the N in N. Third St.

', 'Address$streetNumber' => '

The numeric portion of an address.

', 'Address$city' => '

The city of an address.

', 'Address$state' => '

The state of an address.

', 'Address$postalCode' => '

The postal code of an address.

', 'Address$postalCodePlus4' => '

The zip + 4 or postal code + 4 of an address.

', 'Address$country' => '

The country of an address.

', 'CandidateAddress$streetInfo' => '

The street information of the candidate address.

', 'CandidateAddress$streetNumber' => '

The numeric portion of the candidate address.

', 'CandidateAddress$city' => '

The city of the candidate address.

', 'CandidateAddress$state' => '

The state of the candidate address.

', 'CandidateAddress$postalCode' => '

The postal code of the candidate address.

', 'CandidateAddress$postalCodePlus4' => '

The zip + 4 or postal code +4 of the candidate address.

', 'CandidateAddress$country' => '

The country of the candidate address.

', 'DeletePhoneNumberRequest$PhoneNumberId' => '

The phone number ID.

', 'GetPhoneNumberRequest$PhoneNumberId' => '

The phone number ID.

', 'PhoneNumber$PhoneNumberId' => '

The phone number\'s ID.

', 'PhoneNumberError$PhoneNumberId' => '

The phone number ID for which the action failed.

', 'RestorePhoneNumberRequest$PhoneNumberId' => '

The ID of the phone number being restored.

', 'UpdatePhoneNumberRequest$PhoneNumberId' => '

The phone number ID.

', 'UpdatePhoneNumberRequestItem$PhoneNumberId' => '

The phone number ID to update.

', 'ValidateE911AddressRequest$StreetNumber' => '

The address street number, such as 200 or 2121.

', 'ValidateE911AddressRequest$StreetInfo' => '

The address street information, such as 8th Avenue.

', 'ValidateE911AddressRequest$City' => '

The address city, such as Portland.

', 'ValidateE911AddressRequest$State' => '

The address state, such as ME.

', 'ValidateE911AddressRequest$Country' => '

The country in the address being validated.

', 'ValidateE911AddressRequest$PostalCode' => '

The dress postal code, such 04352.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'Credential$Username' => '

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

', 'Credential$Password' => '

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

', 'SMACreateCallArgumentsMap$key' => NULL, 'SMACreateCallArgumentsMap$value' => NULL, 'SMAUpdateCallArgumentsMap$key' => NULL, 'SMAUpdateCallArgumentsMap$value' => NULL, 'SensitiveStringList$member' => NULL, 'SipHeadersMap$key' => NULL, 'SipHeadersMap$value' => NULL, ], ], 'SensitiveStringList' => [ 'base' => NULL, 'refs' => [ 'DeleteVoiceConnectorTerminationCredentialsRequest$Usernames' => '

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

', 'ListVoiceConnectorTerminationCredentialsResponse$Usernames' => '

A list of user names.

', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => '

A structure that contains the configuration settings for server-side encryption.

We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.

', 'refs' => [ 'CreateVoiceProfileDomainRequest$ServerSideEncryptionConfiguration' => '

The server-side encryption configuration for the request.

', 'VoiceProfileDomain$ServerSideEncryptionConfiguration' => '

A structure that contains the configuration settings for server-side encryption.

', ], ], 'ServiceFailureException' => [ 'base' => '

The service encountered an unexpected error.

', 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => '

The service is currently unavailable.

', 'refs' => [], ], 'SipApplicationPriority' => [ 'base' => NULL, 'refs' => [ 'SipRuleTargetApplication$Priority' => '

The priority setting of a rule\'s target SIP media application.

', ], ], 'SipHeadersMap' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationCallRequest$SipHeaders' => '

The SIP headers added to an outbound call leg.

', ], ], 'SipMediaApplication' => [ 'base' => '

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

', 'refs' => [ 'CreateSipMediaApplicationResponse$SipMediaApplication' => '

The SIP media application details.

', 'GetSipMediaApplicationResponse$SipMediaApplication' => '

The details of the SIP media application.

', 'SipMediaApplicationList$member' => NULL, 'UpdateSipMediaApplicationResponse$SipMediaApplication' => '

The updated SIP media application’s details.

', ], ], 'SipMediaApplicationAlexaSkillConfiguration' => [ 'base' => '

The Alexa Skill configuration of a SIP media application.

Due to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to the Alexa Smart Properties page.

', 'refs' => [ 'GetSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration' => '

Returns the Alexa Skill configuration.

', 'PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationAlexaSkillConfiguration' => '

The Alexa Skill configuration.

', 'PutSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration' => '

Returns the Alexa Skill configuration.

', ], ], 'SipMediaApplicationCall' => [ 'base' => '

A Call instance for a SIP media application.

', 'refs' => [ 'CreateSipMediaApplicationCallResponse$SipMediaApplicationCall' => '

The actual call.

', 'UpdateSipMediaApplicationCallResponse$SipMediaApplicationCall' => '

A Call instance for a SIP media application.

', ], ], 'SipMediaApplicationEndpoint' => [ 'base' => '

The endpoint assigned to a SIP media application.

', 'refs' => [ 'SipMediaApplicationEndpointList$member' => NULL, ], ], 'SipMediaApplicationEndpointList' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$Endpoints' => '

List of endpoints (Lambda ARNs) specified for the SIP media application.

', 'SipMediaApplication$Endpoints' => '

List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

', 'UpdateSipMediaApplicationRequest$Endpoints' => '

The new set of endpoints for the specified SIP media application.

', ], ], 'SipMediaApplicationList' => [ 'base' => NULL, 'refs' => [ 'ListSipMediaApplicationsResponse$SipMediaApplications' => '

The list of SIP media applications and application details.

', ], ], 'SipMediaApplicationLoggingConfiguration' => [ 'base' => '

The logging configuration of a SIP media application.

', 'refs' => [ 'GetSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration' => '

The actual logging configuration.

', 'PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationLoggingConfiguration' => '

The logging configuration for the specified SIP media application.

', 'PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration' => '

The updated logging configuration for the specified SIP media application.

', ], ], 'SipMediaApplicationName' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$Name' => '

The SIP media application\'s name.

', 'SipMediaApplication$Name' => '

The SIP media application\'s name.

', 'UpdateSipMediaApplicationRequest$Name' => '

The new name for the specified SIP media application.

', ], ], 'SipRule' => [ 'base' => '

The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

', 'refs' => [ 'CreateSipRuleResponse$SipRule' => '

The SIP rule information, including the rule ID, triggers, and target applications.

', 'GetSipRuleResponse$SipRule' => '

The SIP rule details.

', 'SipRuleList$member' => NULL, 'UpdateSipRuleResponse$SipRule' => '

The updated SIP rule details.

', ], ], 'SipRuleList' => [ 'base' => NULL, 'refs' => [ 'ListSipRulesResponse$SipRules' => '

The list of SIP rules and details.

', ], ], 'SipRuleName' => [ 'base' => NULL, 'refs' => [ 'CreateSipRuleRequest$Name' => '

The name of the SIP rule.

', 'SipRule$Name' => '

A SIP rule\'s name.

', 'UpdateSipRuleRequest$Name' => '

The new name for the specified SIP rule.

', ], ], 'SipRuleTargetApplication' => [ 'base' => '

A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

', 'refs' => [ 'SipRuleTargetApplicationList$member' => NULL, ], ], 'SipRuleTargetApplicationList' => [ 'base' => NULL, 'refs' => [ 'CreateSipRuleRequest$TargetApplications' => '

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

', 'SipRule$TargetApplications' => '

The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

', 'UpdateSipRuleRequest$TargetApplications' => '

The new list of target applications.

', ], ], 'SipRuleTriggerType' => [ 'base' => NULL, 'refs' => [ 'CreateSipRuleRequest$TriggerType' => '

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

', 'SipRule$TriggerType' => '

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

', ], ], 'SpeakerSearchDetails' => [ 'base' => '

The details of a speaker search task.

', 'refs' => [ 'SpeakerSearchTask$SpeakerSearchDetails' => '

The details of a speaker search task.

', ], ], 'SpeakerSearchResult' => [ 'base' => '

The result of a speaker search analysis.

', 'refs' => [ 'SpeakerSearchResultList$member' => NULL, ], ], 'SpeakerSearchResultList' => [ 'base' => NULL, 'refs' => [ 'SpeakerSearchDetails$Results' => '

The result value in the speaker search details.

', ], ], 'SpeakerSearchTask' => [ 'base' => '

A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.

', 'refs' => [ 'GetSpeakerSearchTaskResponse$SpeakerSearchTask' => '

The details of the speaker search task.

', 'StartSpeakerSearchTaskResponse$SpeakerSearchTask' => '

The details of the speaker search task.

', ], ], 'StartSpeakerSearchTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartSpeakerSearchTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartVoiceToneAnalysisTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartVoiceToneAnalysisTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSpeakerSearchTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopVoiceToneAnalysisTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StreamingConfiguration' => [ 'base' => '

The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

', 'refs' => [ 'GetVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration' => '

The details of the streaming configuration.

', 'PutVoiceConnectorStreamingConfigurationRequest$StreamingConfiguration' => '

The streaming settings being updated.

', 'PutVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration' => '

The updated streaming settings.

', ], ], 'StreamingNotificationTarget' => [ 'base' => '

The target recipient for a streaming configuration notification.

', 'refs' => [ 'StreamingNotificationTargetList$member' => NULL, ], ], 'StreamingNotificationTargetList' => [ 'base' => NULL, 'refs' => [ 'StreamingConfiguration$StreamingNotificationTargets' => '

The streaming notification targets.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$AwsRegion' => '

The AWS Region assigned to the SIP media application.

', 'ListPhoneNumberOrdersRequest$NextToken' => '

The token used to retrieve the next page of results.

', 'ListPhoneNumberOrdersResponse$NextToken' => '

The token used to retrieve the next page of results.

', 'ListPhoneNumbersRequest$Status' => '

The status of your organization\'s phone numbers.

', 'ListPhoneNumbersRequest$FilterValue' => '

The filter value.

', 'ListPhoneNumbersRequest$NextToken' => '

The token used to return the next page of results.

', 'ListPhoneNumbersResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorGroupsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorGroupsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceConnectorsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceProfileDomainsRequest$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceProfileDomainsResponse$NextToken' => '

The token used to return the next page of results.

', 'ListVoiceProfilesRequest$NextToken' => '

The token used to retrieve the next page of results.

', 'ListVoiceProfilesResponse$NextToken' => '

The token used to retrieve the next page of results.

', 'NonEmptyStringList$member' => NULL, 'OriginationRoute$Host' => '

The FQDN or IP address to contact for origination traffic.

', 'PhoneNumberAssociation$Value' => '

Contains the ID for the entity specified in Name.

', 'PhoneNumberError$ErrorMessage' => '

The error message.

', 'SearchAvailablePhoneNumbersRequest$AreaCode' => '

Confines a search to just the phone numbers associated with the specified area code.

', 'SearchAvailablePhoneNumbersRequest$City' => '

Confines a search to just the phone numbers associated with the specified city.

', 'SearchAvailablePhoneNumbersRequest$State' => '

Confines a search to just the phone numbers associated with the specified state.

', 'SearchAvailablePhoneNumbersRequest$NextToken' => '

The token used to return the next page of results.

', 'SearchAvailablePhoneNumbersResponse$NextToken' => '

The token used to return the next page of results.

', 'SipMediaApplication$AwsRegion' => '

The AWS Region in which the SIP media application is created.

', 'SipRuleTargetApplication$AwsRegion' => '

The AWS Region of a rule\'s target SIP media application.

', 'SpeakerSearchTask$StatusMessage' => '

A detailed message about the status of a speaker search.

', 'StringList$member' => NULL, 'TerminationHealth$Source' => '

The source IP address.

', 'ValidateE911AddressResponse$AddressExternalId' => '

The ID that represents the address.

', 'VoiceConnector$OutboundHostName' => '

The outbound host name for the Voice Connector.

', 'VoiceConnectorSettings$CdrBucket' => '

The S3 bucket that stores the Voice Connector\'s call detail records.

', 'VoiceToneAnalysisTask$StatusMessage' => '

The status of a voice tone analysis task.

', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'ProxySession$Name' => '

The proxy session name.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Proxy$PhoneNumberCountries' => '

The countries for proxy phone numbers to be selected from.

', 'Termination$CidrAllowedList' => '

The IP addresses allowed to make calls, in CIDR format.

', ], ], 'Tag' => [ 'base' => '

Describes a tag applied to a resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag\'s key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The keys of the tags being removed from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateSipMediaApplicationRequest$Tags' => '

The tags assigned to the SIP media application.

', 'CreateVoiceConnectorRequest$Tags' => '

The tags assigned to the Voice Connector.

', 'CreateVoiceProfileDomainRequest$Tags' => '

The tags assigned to the domain.

', 'ListTagsForResourceResponse$Tags' => '

The tags in the list.

', 'TagResourceRequest$Tags' => '

A list of the tags being added to the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag\'s value.

', ], ], 'Termination' => [ 'base' => '

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.

', 'refs' => [ 'GetVoiceConnectorTerminationResponse$Termination' => '

The termination setting details.

', 'PutVoiceConnectorTerminationRequest$Termination' => '

The termination settings to be updated.

', 'PutVoiceConnectorTerminationResponse$Termination' => '

The updated termination settings.

', ], ], 'TerminationHealth' => [ 'base' => '

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

', 'refs' => [ 'GetVoiceConnectorTerminationHealthResponse$TerminationHealth' => '

The termination health details.

', ], ], 'ThrottledClientException' => [ 'base' => '

The number of customer requests exceeds the request rate limit.

', 'refs' => [], ], 'TollFreePrefix' => [ 'base' => NULL, 'refs' => [ 'SearchAvailablePhoneNumbersRequest$TollFreePrefix' => '

Confines a search to just the phone numbers associated with the specified toll-free prefix.

', ], ], 'UnauthorizedClientException' => [ 'base' => '

The client isn\'t authorized to request a resource.

', 'refs' => [], ], 'UnprocessableEntityException' => [ 'base' => '

A well-formed request couldn\'t be followed due to semantic errors.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGlobalSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequestItem' => [ 'base' => '

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

', 'refs' => [ 'UpdatePhoneNumberRequestItemList$member' => NULL, ], ], 'UpdatePhoneNumberRequestItemList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePhoneNumberRequest$UpdatePhoneNumberRequestItems' => '

Lists the phone numbers in the update request.

', ], ], 'UpdatePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProxySessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProxySessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationCallRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationCallResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipMediaApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSipRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVoiceProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidateE911AddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidateE911AddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationResult' => [ 'base' => NULL, 'refs' => [ 'ValidateE911AddressResponse$ValidationResult' => '

Number indicating the result of address validation. 0 means the address was perfect as-is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

', ], ], 'VoiceConnector' => [ 'base' => '

The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.

', 'refs' => [ 'CreateVoiceConnectorResponse$VoiceConnector' => '

The details of the Voice Connector.

', 'GetVoiceConnectorResponse$VoiceConnector' => '

The Voice Connector details.

', 'UpdateVoiceConnectorResponse$VoiceConnector' => '

The updated Voice Connector details.

', 'VoiceConnectorList$member' => NULL, ], ], 'VoiceConnectorAwsRegion' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorRequest$AwsRegion' => '

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

', 'VoiceConnector$AwsRegion' => '

The AWS Region in which the Voice Connector is created. Default: us-east-1.

', 'VoiceConnectorAwsRegionList$member' => NULL, ], ], 'VoiceConnectorAwsRegionList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableVoiceConnectorRegionsResponse$VoiceConnectorRegions' => '

The list of AWS Regions.

', ], ], 'VoiceConnectorGroup' => [ 'base' => '

The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.

', 'refs' => [ 'CreateVoiceConnectorGroupResponse$VoiceConnectorGroup' => '

The details of the Voice Connector group.

', 'GetVoiceConnectorGroupResponse$VoiceConnectorGroup' => '

The details of the Voice Connector group.

', 'UpdateVoiceConnectorGroupResponse$VoiceConnectorGroup' => '

The updated Voice Connector group.

', 'VoiceConnectorGroupList$member' => NULL, ], ], 'VoiceConnectorGroupList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceConnectorGroupsResponse$VoiceConnectorGroups' => '

The details of the Voice Connector groups.

', ], ], 'VoiceConnectorGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorGroupRequest$Name' => '

The name of the Voice Connector group.

', 'UpdateVoiceConnectorGroupRequest$Name' => '

The name of the Voice Connector group.

', 'VoiceConnectorGroup$Name' => '

The name of a Voice Connector group.

', ], ], 'VoiceConnectorItem' => [ 'base' => '

For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

', 'refs' => [ 'VoiceConnectorItemList$member' => NULL, ], ], 'VoiceConnectorItemList' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorGroupRequest$VoiceConnectorItems' => '

Lists the Voice Connectors that inbound calls are routed to.

', 'UpdateVoiceConnectorGroupRequest$VoiceConnectorItems' => '

The VoiceConnectorItems to associate with the Voice Connector group.

', 'VoiceConnectorGroup$VoiceConnectorItems' => '

The Voice Connectors to which you route inbound calls.

', ], ], 'VoiceConnectorItemPriority' => [ 'base' => NULL, 'refs' => [ 'VoiceConnectorItem$Priority' => '

The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

', ], ], 'VoiceConnectorList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceConnectorsResponse$VoiceConnectors' => '

The details of the Voice Connectors.

', ], ], 'VoiceConnectorName' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceConnectorRequest$Name' => '

The name of the Voice Connector.

', 'UpdateVoiceConnectorRequest$Name' => '

The name of the Voice Connector.

', 'VoiceConnector$Name' => '

The Voice Connector\'s name.

', ], ], 'VoiceConnectorSettings' => [ 'base' => '

The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

', 'refs' => [ 'GetGlobalSettingsResponse$VoiceConnector' => '

The Voice Connector settings.

', 'UpdateGlobalSettingsRequest$VoiceConnector' => '

The Voice Connector settings.

', ], ], 'VoiceProfile' => [ 'base' => '

The combination of a voice print and caller ID.

', 'refs' => [ 'CreateVoiceProfileResponse$VoiceProfile' => '

The requested voice profile.

', 'GetVoiceProfileResponse$VoiceProfile' => '

The voice profile details.

', 'UpdateVoiceProfileResponse$VoiceProfile' => '

The updated voice profile settings.

', ], ], 'VoiceProfileDomain' => [ 'base' => '

A collection of voice profiles.

', 'refs' => [ 'CreateVoiceProfileDomainResponse$VoiceProfileDomain' => '

The requested voice profile domain.

', 'GetVoiceProfileDomainResponse$VoiceProfileDomain' => '

The details of the voice profile domain.

', 'UpdateVoiceProfileDomainResponse$VoiceProfileDomain' => '

The updated details of the voice profile domain.

', ], ], 'VoiceProfileDomainDescription' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceProfileDomainRequest$Description' => '

A description of the voice profile domain.

', 'UpdateVoiceProfileDomainRequest$Description' => '

The description of the voice profile domain.

', 'VoiceProfileDomain$Description' => '

The description of the voice profile domain.

', 'VoiceProfileDomainSummary$Description' => '

Describes the voice profile domain summary.

', ], ], 'VoiceProfileDomainName' => [ 'base' => NULL, 'refs' => [ 'CreateVoiceProfileDomainRequest$Name' => '

The name of the voice profile domain.

', 'UpdateVoiceProfileDomainRequest$Name' => '

The name of the voice profile domain.

', 'VoiceProfileDomain$Name' => '

The name of the voice profile domain.

', 'VoiceProfileDomainSummary$Name' => '

The name of the voice profile domain summary.

', ], ], 'VoiceProfileDomainSummary' => [ 'base' => '

A high-level overview of a voice profile domain.

', 'refs' => [ 'VoiceProfileDomainSummaryList$member' => NULL, ], ], 'VoiceProfileDomainSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceProfileDomainsResponse$VoiceProfileDomains' => '

The list of voice profile domains.

', ], ], 'VoiceProfileSummary' => [ 'base' => '

A high-level summary of a voice profile.

', 'refs' => [ 'VoiceProfileSummaryList$member' => NULL, ], ], 'VoiceProfileSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVoiceProfilesResponse$VoiceProfiles' => '

The list of voice profiles.

', ], ], 'VoiceToneAnalysisTask' => [ 'base' => '

A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.

', 'refs' => [ 'GetVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask' => '

The details of the voice tone analysis task.

', 'StartVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask' => '

The details of the voice tone analysis task.

', ], ], ],]; diff --git a/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json b/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json index 70607cca0c..b3a334df4e 100644 --- a/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json +++ b/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -59,7 +58,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -87,13 +85,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -106,7 +105,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -120,7 +118,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -143,7 +140,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -178,11 +174,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -193,16 +187,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -216,14 +213,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -232,15 +227,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -251,16 +245,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -274,7 +271,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -294,11 +290,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -309,20 +303,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -333,18 +329,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] } \ No newline at end of file diff --git a/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json.php b/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json.php index 01e4964ee8..e8425f63ce 100644 --- a/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json.php +++ b/src/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], true, ], ], ], 'rules' => [ [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://voice-chime.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], 'type' => 'tree', ], ],]; diff --git a/src/data/codeartifact/2018-09-22/api-2.json b/src/data/codeartifact/2018-09-22/api-2.json index 878505a3b6..9f8ff4a307 100644 --- a/src/data/codeartifact/2018-09-22/api-2.json +++ b/src/data/codeartifact/2018-09-22/api-2.json @@ -2620,6 +2620,7 @@ "maven", "nuget", "generic", + "ruby", "swift" ] }, diff --git a/src/data/codeartifact/2018-09-22/api-2.json.php b/src/data/codeartifact/2018-09-22/api-2.json.php index 518ae9a9eb..0397a7648f 100644 --- a/src/data/codeartifact/2018-09-22/api-2.json.php +++ b/src/data/codeartifact/2018-09-22/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-09-22', 'endpointPrefix' => 'codeartifact', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'CodeArtifact', 'serviceId' => 'codeartifact', 'signatureVersion' => 'v4', 'signingName' => 'codeartifact', 'uid' => 'codeartifact-2018-09-22', ], 'operations' => [ 'AssociateExternalConnection' => [ 'name' => 'AssociateExternalConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/repository/external-connection', ], 'input' => [ 'shape' => 'AssociateExternalConnectionRequest', ], 'output' => [ 'shape' => 'AssociateExternalConnectionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CopyPackageVersions' => [ 'name' => 'CopyPackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/copy', ], 'input' => [ 'shape' => 'CopyPackageVersionsRequest', ], 'output' => [ 'shape' => 'CopyPackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/domain', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreatePackageGroup' => [ 'name' => 'CreatePackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'CreatePackageGroupRequest', ], 'output' => [ 'shape' => 'CreatePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'CreateRepository' => [ 'name' => 'CreateRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'CreateRepositoryRequest', ], 'output' => [ 'shape' => 'CreateRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/domain', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteDomainPermissionsPolicy' => [ 'name' => 'DeleteDomainPermissionsPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/domain/permissions/policy', ], 'input' => [ 'shape' => 'DeleteDomainPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'DeleteDomainPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/package', ], 'input' => [ 'shape' => 'DeletePackageRequest', ], 'output' => [ 'shape' => 'DeletePackageResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeletePackageGroup' => [ 'name' => 'DeletePackageGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'DeletePackageGroupRequest', ], 'output' => [ 'shape' => 'DeletePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], 'idempotent' => true, ], 'DeletePackageVersions' => [ 'name' => 'DeletePackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/delete', ], 'input' => [ 'shape' => 'DeletePackageVersionsRequest', ], 'output' => [ 'shape' => 'DeletePackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteRepository' => [ 'name' => 'DeleteRepository', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'DeleteRepositoryRequest', ], 'output' => [ 'shape' => 'DeleteRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteRepositoryPermissionsPolicy' => [ 'name' => 'DeleteRepositoryPermissionsPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/repository/permissions/policies', ], 'input' => [ 'shape' => 'DeleteRepositoryPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'DeleteRepositoryPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/domain', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribePackage' => [ 'name' => 'DescribePackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package', ], 'input' => [ 'shape' => 'DescribePackageRequest', ], 'output' => [ 'shape' => 'DescribePackageResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribePackageGroup' => [ 'name' => 'DescribePackageGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'DescribePackageGroupRequest', ], 'output' => [ 'shape' => 'DescribePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribePackageVersion' => [ 'name' => 'DescribePackageVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package/version', ], 'input' => [ 'shape' => 'DescribePackageVersionRequest', ], 'output' => [ 'shape' => 'DescribePackageVersionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeRepository' => [ 'name' => 'DescribeRepository', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'DescribeRepositoryRequest', ], 'output' => [ 'shape' => 'DescribeRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DisassociateExternalConnection' => [ 'name' => 'DisassociateExternalConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/repository/external-connection', ], 'input' => [ 'shape' => 'DisassociateExternalConnectionRequest', ], 'output' => [ 'shape' => 'DisassociateExternalConnectionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DisposePackageVersions' => [ 'name' => 'DisposePackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/dispose', ], 'input' => [ 'shape' => 'DisposePackageVersionsRequest', ], 'output' => [ 'shape' => 'DisposePackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetAssociatedPackageGroup' => [ 'name' => 'GetAssociatedPackageGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/get-associated-package-group', ], 'input' => [ 'shape' => 'GetAssociatedPackageGroupRequest', ], 'output' => [ 'shape' => 'GetAssociatedPackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAuthorizationToken' => [ 'name' => 'GetAuthorizationToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/authorization-token', ], 'input' => [ 'shape' => 'GetAuthorizationTokenRequest', ], 'output' => [ 'shape' => 'GetAuthorizationTokenResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetDomainPermissionsPolicy' => [ 'name' => 'GetDomainPermissionsPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/domain/permissions/policy', ], 'input' => [ 'shape' => 'GetDomainPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'GetDomainPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetPackageVersionAsset' => [ 'name' => 'GetPackageVersionAsset', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package/version/asset', ], 'input' => [ 'shape' => 'GetPackageVersionAssetRequest', ], 'output' => [ 'shape' => 'GetPackageVersionAssetResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetPackageVersionReadme' => [ 'name' => 'GetPackageVersionReadme', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package/version/readme', ], 'input' => [ 'shape' => 'GetPackageVersionReadmeRequest', ], 'output' => [ 'shape' => 'GetPackageVersionReadmeResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetRepositoryEndpoint' => [ 'name' => 'GetRepositoryEndpoint', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/repository/endpoint', ], 'input' => [ 'shape' => 'GetRepositoryEndpointRequest', ], 'output' => [ 'shape' => 'GetRepositoryEndpointResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetRepositoryPermissionsPolicy' => [ 'name' => 'GetRepositoryPermissionsPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/repository/permissions/policy', ], 'input' => [ 'shape' => 'GetRepositoryPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'GetRepositoryPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListAllowedRepositoriesForGroup' => [ 'name' => 'ListAllowedRepositoriesForGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package-group-allowed-repositories', ], 'input' => [ 'shape' => 'ListAllowedRepositoriesForGroupRequest', ], 'output' => [ 'shape' => 'ListAllowedRepositoriesForGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAssociatedPackages' => [ 'name' => 'ListAssociatedPackages', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/list-associated-packages', ], 'input' => [ 'shape' => 'ListAssociatedPackagesRequest', ], 'output' => [ 'shape' => 'ListAssociatedPackagesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/domains', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackageGroups' => [ 'name' => 'ListPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package-groups', ], 'input' => [ 'shape' => 'ListPackageGroupsRequest', ], 'output' => [ 'shape' => 'ListPackageGroupsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListPackageVersionAssets' => [ 'name' => 'ListPackageVersionAssets', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/version/assets', ], 'input' => [ 'shape' => 'ListPackageVersionAssetsRequest', ], 'output' => [ 'shape' => 'ListPackageVersionAssetsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackageVersionDependencies' => [ 'name' => 'ListPackageVersionDependencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/version/dependencies', ], 'input' => [ 'shape' => 'ListPackageVersionDependenciesRequest', ], 'output' => [ 'shape' => 'ListPackageVersionDependenciesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackageVersions' => [ 'name' => 'ListPackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions', ], 'input' => [ 'shape' => 'ListPackageVersionsRequest', ], 'output' => [ 'shape' => 'ListPackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackages' => [ 'name' => 'ListPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/packages', ], 'input' => [ 'shape' => 'ListPackagesRequest', ], 'output' => [ 'shape' => 'ListPackagesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListRepositories' => [ 'name' => 'ListRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/repositories', ], 'input' => [ 'shape' => 'ListRepositoriesRequest', ], 'output' => [ 'shape' => 'ListRepositoriesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListRepositoriesInDomain' => [ 'name' => 'ListRepositoriesInDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/domain/repositories', ], 'input' => [ 'shape' => 'ListRepositoriesInDomainRequest', ], 'output' => [ 'shape' => 'ListRepositoriesInDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListSubPackageGroups' => [ 'name' => 'ListSubPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package-groups/sub-groups', ], 'input' => [ 'shape' => 'ListSubPackageGroupsRequest', ], 'output' => [ 'shape' => 'ListSubPackageGroupsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/tags', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PublishPackageVersion' => [ 'name' => 'PublishPackageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/version/publish', ], 'input' => [ 'shape' => 'PublishPackageVersionRequest', ], 'output' => [ 'shape' => 'PublishPackageVersionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PutDomainPermissionsPolicy' => [ 'name' => 'PutDomainPermissionsPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/domain/permissions/policy', ], 'input' => [ 'shape' => 'PutDomainPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'PutDomainPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PutPackageOriginConfiguration' => [ 'name' => 'PutPackageOriginConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package', ], 'input' => [ 'shape' => 'PutPackageOriginConfigurationRequest', ], 'output' => [ 'shape' => 'PutPackageOriginConfigurationResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PutRepositoryPermissionsPolicy' => [ 'name' => 'PutRepositoryPermissionsPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/repository/permissions/policy', ], 'input' => [ 'shape' => 'PutRepositoryPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'PutRepositoryPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/tag', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/untag', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackageGroup' => [ 'name' => 'UpdatePackageGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'UpdatePackageGroupRequest', ], 'output' => [ 'shape' => 'UpdatePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'UpdatePackageGroupOriginConfiguration' => [ 'name' => 'UpdatePackageGroupOriginConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/package-group-origin-configuration', ], 'input' => [ 'shape' => 'UpdatePackageGroupOriginConfigurationRequest', ], 'output' => [ 'shape' => 'UpdatePackageGroupOriginConfigurationResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'UpdatePackageVersionsStatus' => [ 'name' => 'UpdatePackageVersionsStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/update_status', ], 'input' => [ 'shape' => 'UpdatePackageVersionsStatusRequest', ], 'output' => [ 'shape' => 'UpdatePackageVersionsStatusResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateRepository' => [ 'name' => 'UpdateRepository', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'UpdateRepositoryRequest', ], 'output' => [ 'shape' => 'UpdateRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[0-9]{12}', ], 'AllowPublish' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', ], ], 'AllowUpstream' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', ], ], 'Arn' => [ 'type' => 'string', 'max' => 1011, 'min' => 1, 'pattern' => '\\S+', ], 'Asset' => [ 'type' => 'blob', 'streaming' => true, ], 'AssetHashes' => [ 'type' => 'map', 'key' => [ 'shape' => 'HashAlgorithm', ], 'value' => [ 'shape' => 'HashValue', ], ], 'AssetName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '\\P{C}+', ], 'AssetSummary' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'AssetName', ], 'size' => [ 'shape' => 'LongOptional', ], 'hashes' => [ 'shape' => 'AssetHashes', ], ], ], 'AssetSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetSummary', ], ], 'AssociateExternalConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'externalConnection', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'externalConnection' => [ 'shape' => 'ExternalConnectionName', 'location' => 'querystring', 'locationName' => 'external-connection', ], ], ], 'AssociateExternalConnectionResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'AssociatedPackage' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'associationType' => [ 'shape' => 'PackageGroupAssociationType', ], ], ], 'AssociatedPackageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociatedPackage', ], ], 'AuthorizationTokenDurationSeconds' => [ 'type' => 'long', 'max' => 43200, 'min' => 0, ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'CopyPackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'sourceRepository', 'destinationRepository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'sourceRepository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'source-repository', ], 'destinationRepository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'destination-repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'versionRevisions' => [ 'shape' => 'PackageVersionRevisionMap', ], 'allowOverwrite' => [ 'shape' => 'BooleanOptional', ], 'includeFromUpstream' => [ 'shape' => 'BooleanOptional', ], ], ], 'CopyPackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'encryptionKey' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'DomainDescription', ], ], ], 'CreatePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreatePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'CreateRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'description' => [ 'shape' => 'Description', ], 'upstreams' => [ 'shape' => 'UpstreamRepositoryList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'DeleteDomainPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', 'location' => 'querystring', 'locationName' => 'policy-revision', ], ], ], 'DeleteDomainPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], ], ], 'DeleteDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'DomainDescription', ], ], ], 'DeletePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'package-group', ], ], ], 'DeletePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'DeletePackageRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], ], ], 'DeletePackageResult' => [ 'type' => 'structure', 'members' => [ 'deletedPackage' => [ 'shape' => 'PackageSummary', ], ], ], 'DeletePackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'versions', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'expectedStatus' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'DeletePackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'DeleteRepositoryPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', 'location' => 'querystring', 'locationName' => 'policy-revision', ], ], ], 'DeleteRepositoryPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'DeleteRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], ], ], 'DeleteRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], ], ], 'DescribeDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'DomainDescription', ], ], ], 'DescribePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], ], ], 'DescribePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'DescribePackageRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], ], ], 'DescribePackageResult' => [ 'type' => 'structure', 'required' => [ 'package', ], 'members' => [ 'package' => [ 'shape' => 'PackageDescription', ], ], ], 'DescribePackageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'DescribePackageVersionResult' => [ 'type' => 'structure', 'required' => [ 'packageVersion', ], 'members' => [ 'packageVersion' => [ 'shape' => 'PackageVersionDescription', ], ], ], 'DescribeRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], ], ], 'DescribeRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '\\P{C}*', ], 'DisassociateExternalConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'externalConnection', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'externalConnection' => [ 'shape' => 'ExternalConnectionName', 'location' => 'querystring', 'locationName' => 'external-connection', ], ], ], 'DisassociateExternalConnectionResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'DisposePackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'versions', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'versionRevisions' => [ 'shape' => 'PackageVersionRevisionMap', ], 'expectedStatus' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'DisposePackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'DomainDescription' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DomainName', ], 'owner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'DomainStatus', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'encryptionKey' => [ 'shape' => 'Arn', ], 'repositoryCount' => [ 'shape' => 'Integer', ], 'assetSizeBytes' => [ 'shape' => 'Long', ], 's3BucketArn' => [ 'shape' => 'Arn', ], ], ], 'DomainEntryPoint' => [ 'type' => 'structure', 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], 'externalConnectionName' => [ 'shape' => 'ExternalConnectionName', ], ], ], 'DomainName' => [ 'type' => 'string', 'max' => 50, 'min' => 2, 'pattern' => '[a-z][a-z0-9\\-]{0,48}[a-z0-9]', ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleted', ], ], 'DomainSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DomainName', ], 'owner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'DomainStatus', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'encryptionKey' => [ 'shape' => 'Arn', ], ], ], 'DomainSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainSummary', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ExternalConnectionName' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}', ], 'ExternalConnectionStatus' => [ 'type' => 'string', 'enum' => [ 'Available', ], ], 'GetAssociatedPackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], ], ], 'GetAssociatedPackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], 'associationType' => [ 'shape' => 'PackageGroupAssociationType', ], ], ], 'GetAuthorizationTokenRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'durationSeconds' => [ 'shape' => 'AuthorizationTokenDurationSeconds', 'location' => 'querystring', 'locationName' => 'duration', ], ], ], 'GetAuthorizationTokenResult' => [ 'type' => 'structure', 'members' => [ 'authorizationToken' => [ 'shape' => 'String', ], 'expiration' => [ 'shape' => 'Timestamp', ], ], 'sensitive' => true, ], 'GetDomainPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], ], ], 'GetDomainPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'GetPackageVersionAssetRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', 'asset', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'asset' => [ 'shape' => 'AssetName', 'location' => 'querystring', 'locationName' => 'asset', ], 'packageVersionRevision' => [ 'shape' => 'PackageVersionRevision', 'location' => 'querystring', 'locationName' => 'revision', ], ], ], 'GetPackageVersionAssetResult' => [ 'type' => 'structure', 'members' => [ 'asset' => [ 'shape' => 'Asset', ], 'assetName' => [ 'shape' => 'AssetName', 'location' => 'header', 'locationName' => 'X-AssetName', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'header', 'locationName' => 'X-PackageVersion', ], 'packageVersionRevision' => [ 'shape' => 'PackageVersionRevision', 'location' => 'header', 'locationName' => 'X-PackageVersionRevision', ], ], 'payload' => 'asset', ], 'GetPackageVersionReadmeRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'GetPackageVersionReadmeResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'readme' => [ 'shape' => 'String', ], ], ], 'GetRepositoryEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], ], ], 'GetRepositoryEndpointResult' => [ 'type' => 'structure', 'members' => [ 'repositoryEndpoint' => [ 'shape' => 'String', ], ], ], 'GetRepositoryPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], ], ], 'GetRepositoryPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'HashAlgorithm' => [ 'type' => 'string', 'enum' => [ 'MD5', 'SHA-1', 'SHA-256', 'SHA-512', ], ], 'HashValue' => [ 'type' => 'string', 'max' => 512, 'min' => 32, 'pattern' => '[0-9a-f]+', ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'LicenseInfo' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'String', ], ], ], 'LicenseInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LicenseInfo', ], ], 'ListAllowedRepositoriesForGroupMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListAllowedRepositoriesForGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', 'originRestrictionType', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'originRestrictionType' => [ 'shape' => 'PackageGroupOriginRestrictionType', 'location' => 'querystring', 'locationName' => 'originRestrictionType', ], 'maxResults' => [ 'shape' => 'ListAllowedRepositoriesForGroupMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListAllowedRepositoriesForGroupResult' => [ 'type' => 'structure', 'members' => [ 'allowedRepositories' => [ 'shape' => 'RepositoryNameList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListAssociatedPackagesRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'maxResults' => [ 'shape' => 'ListPackagesMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'preview' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'preview', ], ], ], 'ListAssociatedPackagesResult' => [ 'type' => 'structure', 'members' => [ 'packages' => [ 'shape' => 'AssociatedPackageList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDomainsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListDomainsMaxResults', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDomainsResult' => [ 'type' => 'structure', 'members' => [ 'domains' => [ 'shape' => 'DomainSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPackageGroupsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackageGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'maxResults' => [ 'shape' => 'ListPackageGroupsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'prefix' => [ 'shape' => 'PackageGroupPatternPrefix', 'location' => 'querystring', 'locationName' => 'prefix', ], ], ], 'ListPackageGroupsResult' => [ 'type' => 'structure', 'members' => [ 'packageGroups' => [ 'shape' => 'PackageGroupSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPackageVersionAssetsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackageVersionAssetsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'maxResults' => [ 'shape' => 'ListPackageVersionAssetsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListPackageVersionAssetsResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'assets' => [ 'shape' => 'AssetSummaryList', ], ], ], 'ListPackageVersionDependenciesRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListPackageVersionDependenciesResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'dependencies' => [ 'shape' => 'PackageDependencyList', ], ], ], 'ListPackageVersionsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'status' => [ 'shape' => 'PackageVersionStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'sortBy' => [ 'shape' => 'PackageVersionSortType', 'location' => 'querystring', 'locationName' => 'sortBy', ], 'maxResults' => [ 'shape' => 'ListPackageVersionsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'originType' => [ 'shape' => 'PackageVersionOriginType', 'location' => 'querystring', 'locationName' => 'originType', ], ], ], 'ListPackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'defaultDisplayVersion' => [ 'shape' => 'PackageVersion', ], 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'versions' => [ 'shape' => 'PackageVersionSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPackagesMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackagesRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'packagePrefix' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package-prefix', ], 'maxResults' => [ 'shape' => 'ListPackagesMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'publish' => [ 'shape' => 'AllowPublish', 'location' => 'querystring', 'locationName' => 'publish', ], 'upstream' => [ 'shape' => 'AllowUpstream', 'location' => 'querystring', 'locationName' => 'upstream', ], ], ], 'ListPackagesResult' => [ 'type' => 'structure', 'members' => [ 'packages' => [ 'shape' => 'PackageSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRepositoriesInDomainMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListRepositoriesInDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'administratorAccount' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'administrator-account', ], 'repositoryPrefix' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository-prefix', ], 'maxResults' => [ 'shape' => 'ListRepositoriesInDomainMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListRepositoriesInDomainResult' => [ 'type' => 'structure', 'members' => [ 'repositories' => [ 'shape' => 'RepositorySummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRepositoriesMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListRepositoriesRequest' => [ 'type' => 'structure', 'members' => [ 'repositoryPrefix' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository-prefix', ], 'maxResults' => [ 'shape' => 'ListRepositoriesMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListRepositoriesResult' => [ 'type' => 'structure', 'members' => [ 'repositories' => [ 'shape' => 'RepositorySummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSubPackageGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'maxResults' => [ 'shape' => 'ListPackageGroupsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListSubPackageGroupsResult' => [ 'type' => 'structure', 'members' => [ 'packageGroups' => [ 'shape' => 'PackageGroupSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagList', ], ], ], 'Long' => [ 'type' => 'long', ], 'LongOptional' => [ 'type' => 'long', ], 'OriginRestrictions' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], 'value' => [ 'shape' => 'PackageGroupOriginRestrictionMode', ], ], 'PackageDependency' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'dependencyType' => [ 'shape' => 'String', ], 'versionRequirement' => [ 'shape' => 'String', ], ], ], 'PackageDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageDependency', ], ], 'PackageDescription' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'name' => [ 'shape' => 'PackageName', ], 'originConfiguration' => [ 'shape' => 'PackageOriginConfiguration', ], ], ], 'PackageFormat' => [ 'type' => 'string', 'enum' => [ 'npm', 'pypi', 'maven', 'nuget', 'generic', 'swift', ], ], 'PackageGroupAllowedRepository' => [ 'type' => 'structure', 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], 'originRestrictionType' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], ], ], 'PackageGroupAllowedRepositoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageGroupAllowedRepository', ], ], 'PackageGroupAllowedRepositoryUpdate' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupAllowedRepositoryUpdateType', ], 'value' => [ 'shape' => 'RepositoryNameList', ], ], 'PackageGroupAllowedRepositoryUpdateType' => [ 'type' => 'string', 'enum' => [ 'ADDED', 'REMOVED', ], ], 'PackageGroupAllowedRepositoryUpdates' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], 'value' => [ 'shape' => 'PackageGroupAllowedRepositoryUpdate', ], ], 'PackageGroupAssociationType' => [ 'type' => 'string', 'enum' => [ 'STRONG', 'WEAK', ], ], 'PackageGroupContactInfo' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '\\P{C}*', ], 'PackageGroupDescription' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'pattern' => [ 'shape' => 'PackageGroupPattern', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], 'originConfiguration' => [ 'shape' => 'PackageGroupOriginConfiguration', ], 'parent' => [ 'shape' => 'PackageGroupReference', ], ], ], 'PackageGroupOriginConfiguration' => [ 'type' => 'structure', 'members' => [ 'restrictions' => [ 'shape' => 'PackageGroupOriginRestrictions', ], ], ], 'PackageGroupOriginRestriction' => [ 'type' => 'structure', 'members' => [ 'mode' => [ 'shape' => 'PackageGroupOriginRestrictionMode', ], 'effectiveMode' => [ 'shape' => 'PackageGroupOriginRestrictionMode', ], 'inheritedFrom' => [ 'shape' => 'PackageGroupReference', ], 'repositoriesCount' => [ 'shape' => 'LongOptional', ], ], ], 'PackageGroupOriginRestrictionMode' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'ALLOW_SPECIFIC_REPOSITORIES', 'BLOCK', 'INHERIT', ], ], 'PackageGroupOriginRestrictionType' => [ 'type' => 'string', 'enum' => [ 'EXTERNAL_UPSTREAM', 'INTERNAL_UPSTREAM', 'PUBLISH', ], ], 'PackageGroupOriginRestrictions' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], 'value' => [ 'shape' => 'PackageGroupOriginRestriction', ], ], 'PackageGroupPattern' => [ 'type' => 'string', 'max' => 520, 'min' => 2, 'pattern' => '[^\\p{C}\\p{IsWhitespace}]+', ], 'PackageGroupPatternPrefix' => [ 'type' => 'string', 'max' => 520, 'min' => 0, 'pattern' => '\\P{C}*', ], 'PackageGroupReference' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'pattern' => [ 'shape' => 'PackageGroupPattern', ], ], ], 'PackageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'pattern' => [ 'shape' => 'PackageGroupPattern', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], 'originConfiguration' => [ 'shape' => 'PackageGroupOriginConfiguration', ], 'parent' => [ 'shape' => 'PackageGroupReference', ], ], ], 'PackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageGroupSummary', ], ], 'PackageName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[^#/\\s]+', ], 'PackageNamespace' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[^#/\\s]+', ], 'PackageOriginConfiguration' => [ 'type' => 'structure', 'members' => [ 'restrictions' => [ 'shape' => 'PackageOriginRestrictions', ], ], ], 'PackageOriginRestrictions' => [ 'type' => 'structure', 'required' => [ 'publish', 'upstream', ], 'members' => [ 'publish' => [ 'shape' => 'AllowPublish', ], 'upstream' => [ 'shape' => 'AllowUpstream', ], ], ], 'PackageSummary' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'originConfiguration' => [ 'shape' => 'PackageOriginConfiguration', ], ], ], 'PackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageSummary', ], ], 'PackageVersion' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[^#/\\s]+', ], 'PackageVersionDescription' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'packageName' => [ 'shape' => 'PackageName', ], 'displayName' => [ 'shape' => 'String255', ], 'version' => [ 'shape' => 'PackageVersion', ], 'summary' => [ 'shape' => 'String', ], 'homePage' => [ 'shape' => 'String', ], 'sourceCodeRepository' => [ 'shape' => 'String', ], 'publishedTime' => [ 'shape' => 'Timestamp', ], 'licenses' => [ 'shape' => 'LicenseInfoList', ], 'revision' => [ 'shape' => 'PackageVersionRevision', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], 'origin' => [ 'shape' => 'PackageVersionOrigin', ], ], ], 'PackageVersionError' => [ 'type' => 'structure', 'members' => [ 'errorCode' => [ 'shape' => 'PackageVersionErrorCode', ], 'errorMessage' => [ 'shape' => 'ErrorMessage', ], ], ], 'PackageVersionErrorCode' => [ 'type' => 'string', 'enum' => [ 'ALREADY_EXISTS', 'MISMATCHED_REVISION', 'MISMATCHED_STATUS', 'NOT_ALLOWED', 'NOT_FOUND', 'SKIPPED', ], ], 'PackageVersionErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageVersion', ], 'value' => [ 'shape' => 'PackageVersionError', ], ], 'PackageVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersion', ], 'max' => 100, ], 'PackageVersionOrigin' => [ 'type' => 'structure', 'members' => [ 'domainEntryPoint' => [ 'shape' => 'DomainEntryPoint', ], 'originType' => [ 'shape' => 'PackageVersionOriginType', ], ], ], 'PackageVersionOriginType' => [ 'type' => 'string', 'enum' => [ 'INTERNAL', 'EXTERNAL', 'UNKNOWN', ], ], 'PackageVersionRevision' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '\\S+', ], 'PackageVersionRevisionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageVersion', ], 'value' => [ 'shape' => 'PackageVersionRevision', ], ], 'PackageVersionSortType' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED_TIME', ], ], 'PackageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'Published', 'Unfinished', 'Unlisted', 'Archived', 'Disposed', 'Deleted', ], ], 'PackageVersionSummary' => [ 'type' => 'structure', 'required' => [ 'version', 'status', ], 'members' => [ 'version' => [ 'shape' => 'PackageVersion', ], 'revision' => [ 'shape' => 'PackageVersionRevision', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], 'origin' => [ 'shape' => 'PackageVersionOrigin', ], ], ], 'PackageVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersionSummary', ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, 'pattern' => '\\S+', ], 'PolicyDocument' => [ 'type' => 'string', 'max' => 7168, 'min' => 1, 'pattern' => '[\\P{C}\\s]+', ], 'PolicyRevision' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '\\S+', ], 'PublishPackageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', 'assetContent', 'assetName', 'assetSHA256', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'assetContent' => [ 'shape' => 'Asset', ], 'assetName' => [ 'shape' => 'AssetName', 'location' => 'querystring', 'locationName' => 'asset', ], 'assetSHA256' => [ 'shape' => 'SHA256', 'location' => 'header', 'locationName' => 'x-amz-content-sha256', ], 'unfinished' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'unfinished', ], ], 'payload' => 'assetContent', ], 'PublishPackageVersionResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], 'asset' => [ 'shape' => 'AssetSummary', ], ], ], 'PutDomainPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'policyDocument', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], ], ], 'PutDomainPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'PutPackageOriginConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'restrictions', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'restrictions' => [ 'shape' => 'PackageOriginRestrictions', ], ], ], 'PutPackageOriginConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'originConfiguration' => [ 'shape' => 'PackageOriginConfiguration', ], ], ], 'PutRepositoryPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'policyDocument', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], ], ], 'PutRepositoryPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'RepositoryDescription' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RepositoryName', ], 'administratorAccount' => [ 'shape' => 'AccountId', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'description' => [ 'shape' => 'Description', ], 'upstreams' => [ 'shape' => 'UpstreamRepositoryInfoList', ], 'externalConnections' => [ 'shape' => 'RepositoryExternalConnectionInfoList', ], 'createdTime' => [ 'shape' => 'Timestamp', ], ], ], 'RepositoryExternalConnectionInfo' => [ 'type' => 'structure', 'members' => [ 'externalConnectionName' => [ 'shape' => 'ExternalConnectionName', ], 'packageFormat' => [ 'shape' => 'PackageFormat', ], 'status' => [ 'shape' => 'ExternalConnectionStatus', ], ], ], 'RepositoryExternalConnectionInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RepositoryExternalConnectionInfo', ], ], 'RepositoryName' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}', ], 'RepositoryNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RepositoryName', ], ], 'RepositorySummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RepositoryName', ], 'administratorAccount' => [ 'shape' => 'AccountId', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'description' => [ 'shape' => 'Description', ], 'createdTime' => [ 'shape' => 'Timestamp', ], ], ], 'RepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RepositorySummary', ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourcePolicy' => [ 'type' => 'structure', 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'revision' => [ 'shape' => 'PolicyRevision', ], 'document' => [ 'shape' => 'PolicyDocument', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'domain', 'repository', 'package', 'package-version', 'asset', ], ], 'RetryAfterSeconds' => [ 'type' => 'integer', ], 'SHA256' => [ 'type' => 'string', 'max' => 64, 'min' => 64, 'pattern' => '[0-9a-f]+', ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'String255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'SuccessfulPackageVersionInfo' => [ 'type' => 'structure', 'members' => [ 'revision' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'SuccessfulPackageVersionInfoMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageVersion', ], 'value' => [ 'shape' => 'SuccessfulPackageVersionInfo', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '\\P{C}+', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '\\P{C}*', ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'retryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', 'location' => 'header', 'locationName' => 'Retry-After', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePackageGroupOriginConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'restrictions' => [ 'shape' => 'OriginRestrictions', ], 'addAllowedRepositories' => [ 'shape' => 'PackageGroupAllowedRepositoryList', ], 'removeAllowedRepositories' => [ 'shape' => 'PackageGroupAllowedRepositoryList', ], ], ], 'UpdatePackageGroupOriginConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], 'allowedRepositoryUpdates' => [ 'shape' => 'PackageGroupAllowedRepositoryUpdates', ], ], ], 'UpdatePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdatePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'UpdatePackageVersionsStatusRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'versions', 'targetStatus', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'versionRevisions' => [ 'shape' => 'PackageVersionRevisionMap', ], 'expectedStatus' => [ 'shape' => 'PackageVersionStatus', ], 'targetStatus' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'UpdatePackageVersionsStatusResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'UpdateRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'description' => [ 'shape' => 'Description', ], 'upstreams' => [ 'shape' => 'UpstreamRepositoryList', ], ], ], 'UpdateRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'UpstreamRepository' => [ 'type' => 'structure', 'required' => [ 'repositoryName', ], 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], ], ], 'UpstreamRepositoryInfo' => [ 'type' => 'structure', 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], ], ], 'UpstreamRepositoryInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpstreamRepositoryInfo', ], ], 'UpstreamRepositoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpstreamRepository', ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CANNOT_PARSE', 'ENCRYPTION_KEY_ERROR', 'FIELD_VALIDATION_FAILED', 'UNKNOWN_OPERATION', 'OTHER', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-09-22', 'endpointPrefix' => 'codeartifact', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'CodeArtifact', 'serviceId' => 'codeartifact', 'signatureVersion' => 'v4', 'signingName' => 'codeartifact', 'uid' => 'codeartifact-2018-09-22', ], 'operations' => [ 'AssociateExternalConnection' => [ 'name' => 'AssociateExternalConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/repository/external-connection', ], 'input' => [ 'shape' => 'AssociateExternalConnectionRequest', ], 'output' => [ 'shape' => 'AssociateExternalConnectionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CopyPackageVersions' => [ 'name' => 'CopyPackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/copy', ], 'input' => [ 'shape' => 'CopyPackageVersionsRequest', ], 'output' => [ 'shape' => 'CopyPackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/domain', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreatePackageGroup' => [ 'name' => 'CreatePackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'CreatePackageGroupRequest', ], 'output' => [ 'shape' => 'CreatePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'CreateRepository' => [ 'name' => 'CreateRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'CreateRepositoryRequest', ], 'output' => [ 'shape' => 'CreateRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/domain', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteDomainPermissionsPolicy' => [ 'name' => 'DeleteDomainPermissionsPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/domain/permissions/policy', ], 'input' => [ 'shape' => 'DeleteDomainPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'DeleteDomainPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/package', ], 'input' => [ 'shape' => 'DeletePackageRequest', ], 'output' => [ 'shape' => 'DeletePackageResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeletePackageGroup' => [ 'name' => 'DeletePackageGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'DeletePackageGroupRequest', ], 'output' => [ 'shape' => 'DeletePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], 'idempotent' => true, ], 'DeletePackageVersions' => [ 'name' => 'DeletePackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/delete', ], 'input' => [ 'shape' => 'DeletePackageVersionsRequest', ], 'output' => [ 'shape' => 'DeletePackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteRepository' => [ 'name' => 'DeleteRepository', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'DeleteRepositoryRequest', ], 'output' => [ 'shape' => 'DeleteRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteRepositoryPermissionsPolicy' => [ 'name' => 'DeleteRepositoryPermissionsPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/repository/permissions/policies', ], 'input' => [ 'shape' => 'DeleteRepositoryPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'DeleteRepositoryPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/domain', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribePackage' => [ 'name' => 'DescribePackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package', ], 'input' => [ 'shape' => 'DescribePackageRequest', ], 'output' => [ 'shape' => 'DescribePackageResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribePackageGroup' => [ 'name' => 'DescribePackageGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'DescribePackageGroupRequest', ], 'output' => [ 'shape' => 'DescribePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribePackageVersion' => [ 'name' => 'DescribePackageVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package/version', ], 'input' => [ 'shape' => 'DescribePackageVersionRequest', ], 'output' => [ 'shape' => 'DescribePackageVersionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeRepository' => [ 'name' => 'DescribeRepository', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'DescribeRepositoryRequest', ], 'output' => [ 'shape' => 'DescribeRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DisassociateExternalConnection' => [ 'name' => 'DisassociateExternalConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/repository/external-connection', ], 'input' => [ 'shape' => 'DisassociateExternalConnectionRequest', ], 'output' => [ 'shape' => 'DisassociateExternalConnectionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DisposePackageVersions' => [ 'name' => 'DisposePackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/dispose', ], 'input' => [ 'shape' => 'DisposePackageVersionsRequest', ], 'output' => [ 'shape' => 'DisposePackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetAssociatedPackageGroup' => [ 'name' => 'GetAssociatedPackageGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/get-associated-package-group', ], 'input' => [ 'shape' => 'GetAssociatedPackageGroupRequest', ], 'output' => [ 'shape' => 'GetAssociatedPackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAuthorizationToken' => [ 'name' => 'GetAuthorizationToken', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/authorization-token', ], 'input' => [ 'shape' => 'GetAuthorizationTokenRequest', ], 'output' => [ 'shape' => 'GetAuthorizationTokenResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetDomainPermissionsPolicy' => [ 'name' => 'GetDomainPermissionsPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/domain/permissions/policy', ], 'input' => [ 'shape' => 'GetDomainPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'GetDomainPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetPackageVersionAsset' => [ 'name' => 'GetPackageVersionAsset', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package/version/asset', ], 'input' => [ 'shape' => 'GetPackageVersionAssetRequest', ], 'output' => [ 'shape' => 'GetPackageVersionAssetResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetPackageVersionReadme' => [ 'name' => 'GetPackageVersionReadme', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package/version/readme', ], 'input' => [ 'shape' => 'GetPackageVersionReadmeRequest', ], 'output' => [ 'shape' => 'GetPackageVersionReadmeResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetRepositoryEndpoint' => [ 'name' => 'GetRepositoryEndpoint', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/repository/endpoint', ], 'input' => [ 'shape' => 'GetRepositoryEndpointRequest', ], 'output' => [ 'shape' => 'GetRepositoryEndpointResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetRepositoryPermissionsPolicy' => [ 'name' => 'GetRepositoryPermissionsPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/repository/permissions/policy', ], 'input' => [ 'shape' => 'GetRepositoryPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'GetRepositoryPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListAllowedRepositoriesForGroup' => [ 'name' => 'ListAllowedRepositoriesForGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/package-group-allowed-repositories', ], 'input' => [ 'shape' => 'ListAllowedRepositoriesForGroupRequest', ], 'output' => [ 'shape' => 'ListAllowedRepositoriesForGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAssociatedPackages' => [ 'name' => 'ListAssociatedPackages', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/list-associated-packages', ], 'input' => [ 'shape' => 'ListAssociatedPackagesRequest', ], 'output' => [ 'shape' => 'ListAssociatedPackagesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/domains', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackageGroups' => [ 'name' => 'ListPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package-groups', ], 'input' => [ 'shape' => 'ListPackageGroupsRequest', ], 'output' => [ 'shape' => 'ListPackageGroupsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListPackageVersionAssets' => [ 'name' => 'ListPackageVersionAssets', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/version/assets', ], 'input' => [ 'shape' => 'ListPackageVersionAssetsRequest', ], 'output' => [ 'shape' => 'ListPackageVersionAssetsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackageVersionDependencies' => [ 'name' => 'ListPackageVersionDependencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/version/dependencies', ], 'input' => [ 'shape' => 'ListPackageVersionDependenciesRequest', ], 'output' => [ 'shape' => 'ListPackageVersionDependenciesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackageVersions' => [ 'name' => 'ListPackageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions', ], 'input' => [ 'shape' => 'ListPackageVersionsRequest', ], 'output' => [ 'shape' => 'ListPackageVersionsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackages' => [ 'name' => 'ListPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/packages', ], 'input' => [ 'shape' => 'ListPackagesRequest', ], 'output' => [ 'shape' => 'ListPackagesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListRepositories' => [ 'name' => 'ListRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/repositories', ], 'input' => [ 'shape' => 'ListRepositoriesRequest', ], 'output' => [ 'shape' => 'ListRepositoriesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListRepositoriesInDomain' => [ 'name' => 'ListRepositoriesInDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/domain/repositories', ], 'input' => [ 'shape' => 'ListRepositoriesInDomainRequest', ], 'output' => [ 'shape' => 'ListRepositoriesInDomainResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListSubPackageGroups' => [ 'name' => 'ListSubPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package-groups/sub-groups', ], 'input' => [ 'shape' => 'ListSubPackageGroupsRequest', ], 'output' => [ 'shape' => 'ListSubPackageGroupsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/tags', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PublishPackageVersion' => [ 'name' => 'PublishPackageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/version/publish', ], 'input' => [ 'shape' => 'PublishPackageVersionRequest', ], 'output' => [ 'shape' => 'PublishPackageVersionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PutDomainPermissionsPolicy' => [ 'name' => 'PutDomainPermissionsPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/domain/permissions/policy', ], 'input' => [ 'shape' => 'PutDomainPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'PutDomainPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PutPackageOriginConfiguration' => [ 'name' => 'PutPackageOriginConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package', ], 'input' => [ 'shape' => 'PutPackageOriginConfigurationRequest', ], 'output' => [ 'shape' => 'PutPackageOriginConfigurationResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'PutRepositoryPermissionsPolicy' => [ 'name' => 'PutRepositoryPermissionsPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/repository/permissions/policy', ], 'input' => [ 'shape' => 'PutRepositoryPermissionsPolicyRequest', ], 'output' => [ 'shape' => 'PutRepositoryPermissionsPolicyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/tag', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/untag', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackageGroup' => [ 'name' => 'UpdatePackageGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/package-group', ], 'input' => [ 'shape' => 'UpdatePackageGroupRequest', ], 'output' => [ 'shape' => 'UpdatePackageGroupResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'UpdatePackageGroupOriginConfiguration' => [ 'name' => 'UpdatePackageGroupOriginConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/package-group-origin-configuration', ], 'input' => [ 'shape' => 'UpdatePackageGroupOriginConfigurationRequest', ], 'output' => [ 'shape' => 'UpdatePackageGroupOriginConfigurationResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'UpdatePackageVersionsStatus' => [ 'name' => 'UpdatePackageVersionsStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/package/versions/update_status', ], 'input' => [ 'shape' => 'UpdatePackageVersionsStatusRequest', ], 'output' => [ 'shape' => 'UpdatePackageVersionsStatusResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateRepository' => [ 'name' => 'UpdateRepository', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v1/repository', ], 'input' => [ 'shape' => 'UpdateRepositoryRequest', ], 'output' => [ 'shape' => 'UpdateRepositoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[0-9]{12}', ], 'AllowPublish' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', ], ], 'AllowUpstream' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', ], ], 'Arn' => [ 'type' => 'string', 'max' => 1011, 'min' => 1, 'pattern' => '\\S+', ], 'Asset' => [ 'type' => 'blob', 'streaming' => true, ], 'AssetHashes' => [ 'type' => 'map', 'key' => [ 'shape' => 'HashAlgorithm', ], 'value' => [ 'shape' => 'HashValue', ], ], 'AssetName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '\\P{C}+', ], 'AssetSummary' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'AssetName', ], 'size' => [ 'shape' => 'LongOptional', ], 'hashes' => [ 'shape' => 'AssetHashes', ], ], ], 'AssetSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetSummary', ], ], 'AssociateExternalConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'externalConnection', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'externalConnection' => [ 'shape' => 'ExternalConnectionName', 'location' => 'querystring', 'locationName' => 'external-connection', ], ], ], 'AssociateExternalConnectionResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'AssociatedPackage' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'associationType' => [ 'shape' => 'PackageGroupAssociationType', ], ], ], 'AssociatedPackageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociatedPackage', ], ], 'AuthorizationTokenDurationSeconds' => [ 'type' => 'long', 'max' => 43200, 'min' => 0, ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'CopyPackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'sourceRepository', 'destinationRepository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'sourceRepository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'source-repository', ], 'destinationRepository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'destination-repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'versionRevisions' => [ 'shape' => 'PackageVersionRevisionMap', ], 'allowOverwrite' => [ 'shape' => 'BooleanOptional', ], 'includeFromUpstream' => [ 'shape' => 'BooleanOptional', ], ], ], 'CopyPackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'encryptionKey' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'DomainDescription', ], ], ], 'CreatePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreatePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'CreateRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'description' => [ 'shape' => 'Description', ], 'upstreams' => [ 'shape' => 'UpstreamRepositoryList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'DeleteDomainPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', 'location' => 'querystring', 'locationName' => 'policy-revision', ], ], ], 'DeleteDomainPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], ], ], 'DeleteDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'DomainDescription', ], ], ], 'DeletePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'package-group', ], ], ], 'DeletePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'DeletePackageRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], ], ], 'DeletePackageResult' => [ 'type' => 'structure', 'members' => [ 'deletedPackage' => [ 'shape' => 'PackageSummary', ], ], ], 'DeletePackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'versions', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'expectedStatus' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'DeletePackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'DeleteRepositoryPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', 'location' => 'querystring', 'locationName' => 'policy-revision', ], ], ], 'DeleteRepositoryPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'DeleteRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], ], ], 'DeleteRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], ], ], 'DescribeDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'DomainDescription', ], ], ], 'DescribePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], ], ], 'DescribePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'DescribePackageRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], ], ], 'DescribePackageResult' => [ 'type' => 'structure', 'required' => [ 'package', ], 'members' => [ 'package' => [ 'shape' => 'PackageDescription', ], ], ], 'DescribePackageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'DescribePackageVersionResult' => [ 'type' => 'structure', 'required' => [ 'packageVersion', ], 'members' => [ 'packageVersion' => [ 'shape' => 'PackageVersionDescription', ], ], ], 'DescribeRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], ], ], 'DescribeRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '\\P{C}*', ], 'DisassociateExternalConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'externalConnection', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'externalConnection' => [ 'shape' => 'ExternalConnectionName', 'location' => 'querystring', 'locationName' => 'external-connection', ], ], ], 'DisassociateExternalConnectionResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'DisposePackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'versions', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'versionRevisions' => [ 'shape' => 'PackageVersionRevisionMap', ], 'expectedStatus' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'DisposePackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'DomainDescription' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DomainName', ], 'owner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'DomainStatus', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'encryptionKey' => [ 'shape' => 'Arn', ], 'repositoryCount' => [ 'shape' => 'Integer', ], 'assetSizeBytes' => [ 'shape' => 'Long', ], 's3BucketArn' => [ 'shape' => 'Arn', ], ], ], 'DomainEntryPoint' => [ 'type' => 'structure', 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], 'externalConnectionName' => [ 'shape' => 'ExternalConnectionName', ], ], ], 'DomainName' => [ 'type' => 'string', 'max' => 50, 'min' => 2, 'pattern' => '[a-z][a-z0-9\\-]{0,48}[a-z0-9]', ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleted', ], ], 'DomainSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DomainName', ], 'owner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'DomainStatus', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'encryptionKey' => [ 'shape' => 'Arn', ], ], ], 'DomainSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainSummary', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ExternalConnectionName' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}', ], 'ExternalConnectionStatus' => [ 'type' => 'string', 'enum' => [ 'Available', ], ], 'GetAssociatedPackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], ], ], 'GetAssociatedPackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], 'associationType' => [ 'shape' => 'PackageGroupAssociationType', ], ], ], 'GetAuthorizationTokenRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'durationSeconds' => [ 'shape' => 'AuthorizationTokenDurationSeconds', 'location' => 'querystring', 'locationName' => 'duration', ], ], ], 'GetAuthorizationTokenResult' => [ 'type' => 'structure', 'members' => [ 'authorizationToken' => [ 'shape' => 'String', ], 'expiration' => [ 'shape' => 'Timestamp', ], ], 'sensitive' => true, ], 'GetDomainPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], ], ], 'GetDomainPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'GetPackageVersionAssetRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', 'asset', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'asset' => [ 'shape' => 'AssetName', 'location' => 'querystring', 'locationName' => 'asset', ], 'packageVersionRevision' => [ 'shape' => 'PackageVersionRevision', 'location' => 'querystring', 'locationName' => 'revision', ], ], ], 'GetPackageVersionAssetResult' => [ 'type' => 'structure', 'members' => [ 'asset' => [ 'shape' => 'Asset', ], 'assetName' => [ 'shape' => 'AssetName', 'location' => 'header', 'locationName' => 'X-AssetName', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'header', 'locationName' => 'X-PackageVersion', ], 'packageVersionRevision' => [ 'shape' => 'PackageVersionRevision', 'location' => 'header', 'locationName' => 'X-PackageVersionRevision', ], ], 'payload' => 'asset', ], 'GetPackageVersionReadmeRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'GetPackageVersionReadmeResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'readme' => [ 'shape' => 'String', ], ], ], 'GetRepositoryEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], ], ], 'GetRepositoryEndpointResult' => [ 'type' => 'structure', 'members' => [ 'repositoryEndpoint' => [ 'shape' => 'String', ], ], ], 'GetRepositoryPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], ], ], 'GetRepositoryPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'HashAlgorithm' => [ 'type' => 'string', 'enum' => [ 'MD5', 'SHA-1', 'SHA-256', 'SHA-512', ], ], 'HashValue' => [ 'type' => 'string', 'max' => 512, 'min' => 32, 'pattern' => '[0-9a-f]+', ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'LicenseInfo' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'String', ], ], ], 'LicenseInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LicenseInfo', ], ], 'ListAllowedRepositoriesForGroupMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListAllowedRepositoriesForGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', 'originRestrictionType', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'originRestrictionType' => [ 'shape' => 'PackageGroupOriginRestrictionType', 'location' => 'querystring', 'locationName' => 'originRestrictionType', ], 'maxResults' => [ 'shape' => 'ListAllowedRepositoriesForGroupMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListAllowedRepositoriesForGroupResult' => [ 'type' => 'structure', 'members' => [ 'allowedRepositories' => [ 'shape' => 'RepositoryNameList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListAssociatedPackagesRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'maxResults' => [ 'shape' => 'ListPackagesMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'preview' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'preview', ], ], ], 'ListAssociatedPackagesResult' => [ 'type' => 'structure', 'members' => [ 'packages' => [ 'shape' => 'AssociatedPackageList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDomainsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListDomainsMaxResults', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDomainsResult' => [ 'type' => 'structure', 'members' => [ 'domains' => [ 'shape' => 'DomainSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPackageGroupsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackageGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'maxResults' => [ 'shape' => 'ListPackageGroupsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'prefix' => [ 'shape' => 'PackageGroupPatternPrefix', 'location' => 'querystring', 'locationName' => 'prefix', ], ], ], 'ListPackageGroupsResult' => [ 'type' => 'structure', 'members' => [ 'packageGroups' => [ 'shape' => 'PackageGroupSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPackageVersionAssetsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackageVersionAssetsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'maxResults' => [ 'shape' => 'ListPackageVersionAssetsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListPackageVersionAssetsResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'assets' => [ 'shape' => 'AssetSummaryList', ], ], ], 'ListPackageVersionDependenciesRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListPackageVersionDependenciesResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'dependencies' => [ 'shape' => 'PackageDependencyList', ], ], ], 'ListPackageVersionsMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'status' => [ 'shape' => 'PackageVersionStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'sortBy' => [ 'shape' => 'PackageVersionSortType', 'location' => 'querystring', 'locationName' => 'sortBy', ], 'maxResults' => [ 'shape' => 'ListPackageVersionsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'originType' => [ 'shape' => 'PackageVersionOriginType', 'location' => 'querystring', 'locationName' => 'originType', ], ], ], 'ListPackageVersionsResult' => [ 'type' => 'structure', 'members' => [ 'defaultDisplayVersion' => [ 'shape' => 'PackageVersion', ], 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'versions' => [ 'shape' => 'PackageVersionSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPackagesMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListPackagesRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'packagePrefix' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package-prefix', ], 'maxResults' => [ 'shape' => 'ListPackagesMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], 'publish' => [ 'shape' => 'AllowPublish', 'location' => 'querystring', 'locationName' => 'publish', ], 'upstream' => [ 'shape' => 'AllowUpstream', 'location' => 'querystring', 'locationName' => 'upstream', ], ], ], 'ListPackagesResult' => [ 'type' => 'structure', 'members' => [ 'packages' => [ 'shape' => 'PackageSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRepositoriesInDomainMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListRepositoriesInDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domain', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'administratorAccount' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'administrator-account', ], 'repositoryPrefix' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository-prefix', ], 'maxResults' => [ 'shape' => 'ListRepositoriesInDomainMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListRepositoriesInDomainResult' => [ 'type' => 'structure', 'members' => [ 'repositories' => [ 'shape' => 'RepositorySummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRepositoriesMaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'ListRepositoriesRequest' => [ 'type' => 'structure', 'members' => [ 'repositoryPrefix' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository-prefix', ], 'maxResults' => [ 'shape' => 'ListRepositoriesMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListRepositoriesResult' => [ 'type' => 'structure', 'members' => [ 'repositories' => [ 'shape' => 'RepositorySummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSubPackageGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'maxResults' => [ 'shape' => 'ListPackageGroupsMaxResults', 'location' => 'querystring', 'locationName' => 'max-results', ], 'nextToken' => [ 'shape' => 'PaginationToken', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListSubPackageGroupsResult' => [ 'type' => 'structure', 'members' => [ 'packageGroups' => [ 'shape' => 'PackageGroupSummaryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagList', ], ], ], 'Long' => [ 'type' => 'long', ], 'LongOptional' => [ 'type' => 'long', ], 'OriginRestrictions' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], 'value' => [ 'shape' => 'PackageGroupOriginRestrictionMode', ], ], 'PackageDependency' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'dependencyType' => [ 'shape' => 'String', ], 'versionRequirement' => [ 'shape' => 'String', ], ], ], 'PackageDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageDependency', ], ], 'PackageDescription' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'name' => [ 'shape' => 'PackageName', ], 'originConfiguration' => [ 'shape' => 'PackageOriginConfiguration', ], ], ], 'PackageFormat' => [ 'type' => 'string', 'enum' => [ 'npm', 'pypi', 'maven', 'nuget', 'generic', 'ruby', 'swift', ], ], 'PackageGroupAllowedRepository' => [ 'type' => 'structure', 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], 'originRestrictionType' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], ], ], 'PackageGroupAllowedRepositoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageGroupAllowedRepository', ], ], 'PackageGroupAllowedRepositoryUpdate' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupAllowedRepositoryUpdateType', ], 'value' => [ 'shape' => 'RepositoryNameList', ], ], 'PackageGroupAllowedRepositoryUpdateType' => [ 'type' => 'string', 'enum' => [ 'ADDED', 'REMOVED', ], ], 'PackageGroupAllowedRepositoryUpdates' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], 'value' => [ 'shape' => 'PackageGroupAllowedRepositoryUpdate', ], ], 'PackageGroupAssociationType' => [ 'type' => 'string', 'enum' => [ 'STRONG', 'WEAK', ], ], 'PackageGroupContactInfo' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '\\P{C}*', ], 'PackageGroupDescription' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'pattern' => [ 'shape' => 'PackageGroupPattern', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], 'originConfiguration' => [ 'shape' => 'PackageGroupOriginConfiguration', ], 'parent' => [ 'shape' => 'PackageGroupReference', ], ], ], 'PackageGroupOriginConfiguration' => [ 'type' => 'structure', 'members' => [ 'restrictions' => [ 'shape' => 'PackageGroupOriginRestrictions', ], ], ], 'PackageGroupOriginRestriction' => [ 'type' => 'structure', 'members' => [ 'mode' => [ 'shape' => 'PackageGroupOriginRestrictionMode', ], 'effectiveMode' => [ 'shape' => 'PackageGroupOriginRestrictionMode', ], 'inheritedFrom' => [ 'shape' => 'PackageGroupReference', ], 'repositoriesCount' => [ 'shape' => 'LongOptional', ], ], ], 'PackageGroupOriginRestrictionMode' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'ALLOW_SPECIFIC_REPOSITORIES', 'BLOCK', 'INHERIT', ], ], 'PackageGroupOriginRestrictionType' => [ 'type' => 'string', 'enum' => [ 'EXTERNAL_UPSTREAM', 'INTERNAL_UPSTREAM', 'PUBLISH', ], ], 'PackageGroupOriginRestrictions' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageGroupOriginRestrictionType', ], 'value' => [ 'shape' => 'PackageGroupOriginRestriction', ], ], 'PackageGroupPattern' => [ 'type' => 'string', 'max' => 520, 'min' => 2, 'pattern' => '[^\\p{C}\\p{IsWhitespace}]+', ], 'PackageGroupPatternPrefix' => [ 'type' => 'string', 'max' => 520, 'min' => 0, 'pattern' => '\\P{C}*', ], 'PackageGroupReference' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'pattern' => [ 'shape' => 'PackageGroupPattern', ], ], ], 'PackageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'pattern' => [ 'shape' => 'PackageGroupPattern', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'createdTime' => [ 'shape' => 'Timestamp', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], 'originConfiguration' => [ 'shape' => 'PackageGroupOriginConfiguration', ], 'parent' => [ 'shape' => 'PackageGroupReference', ], ], ], 'PackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageGroupSummary', ], ], 'PackageName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[^#/\\s]+', ], 'PackageNamespace' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[^#/\\s]+', ], 'PackageOriginConfiguration' => [ 'type' => 'structure', 'members' => [ 'restrictions' => [ 'shape' => 'PackageOriginRestrictions', ], ], ], 'PackageOriginRestrictions' => [ 'type' => 'structure', 'required' => [ 'publish', 'upstream', ], 'members' => [ 'publish' => [ 'shape' => 'AllowPublish', ], 'upstream' => [ 'shape' => 'AllowUpstream', ], ], ], 'PackageSummary' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'originConfiguration' => [ 'shape' => 'PackageOriginConfiguration', ], ], ], 'PackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageSummary', ], ], 'PackageVersion' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[^#/\\s]+', ], 'PackageVersionDescription' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'packageName' => [ 'shape' => 'PackageName', ], 'displayName' => [ 'shape' => 'String255', ], 'version' => [ 'shape' => 'PackageVersion', ], 'summary' => [ 'shape' => 'String', ], 'homePage' => [ 'shape' => 'String', ], 'sourceCodeRepository' => [ 'shape' => 'String', ], 'publishedTime' => [ 'shape' => 'Timestamp', ], 'licenses' => [ 'shape' => 'LicenseInfoList', ], 'revision' => [ 'shape' => 'PackageVersionRevision', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], 'origin' => [ 'shape' => 'PackageVersionOrigin', ], ], ], 'PackageVersionError' => [ 'type' => 'structure', 'members' => [ 'errorCode' => [ 'shape' => 'PackageVersionErrorCode', ], 'errorMessage' => [ 'shape' => 'ErrorMessage', ], ], ], 'PackageVersionErrorCode' => [ 'type' => 'string', 'enum' => [ 'ALREADY_EXISTS', 'MISMATCHED_REVISION', 'MISMATCHED_STATUS', 'NOT_ALLOWED', 'NOT_FOUND', 'SKIPPED', ], ], 'PackageVersionErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageVersion', ], 'value' => [ 'shape' => 'PackageVersionError', ], ], 'PackageVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersion', ], 'max' => 100, ], 'PackageVersionOrigin' => [ 'type' => 'structure', 'members' => [ 'domainEntryPoint' => [ 'shape' => 'DomainEntryPoint', ], 'originType' => [ 'shape' => 'PackageVersionOriginType', ], ], ], 'PackageVersionOriginType' => [ 'type' => 'string', 'enum' => [ 'INTERNAL', 'EXTERNAL', 'UNKNOWN', ], ], 'PackageVersionRevision' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '\\S+', ], 'PackageVersionRevisionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageVersion', ], 'value' => [ 'shape' => 'PackageVersionRevision', ], ], 'PackageVersionSortType' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED_TIME', ], ], 'PackageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'Published', 'Unfinished', 'Unlisted', 'Archived', 'Disposed', 'Deleted', ], ], 'PackageVersionSummary' => [ 'type' => 'structure', 'required' => [ 'version', 'status', ], 'members' => [ 'version' => [ 'shape' => 'PackageVersion', ], 'revision' => [ 'shape' => 'PackageVersionRevision', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], 'origin' => [ 'shape' => 'PackageVersionOrigin', ], ], ], 'PackageVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersionSummary', ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, 'pattern' => '\\S+', ], 'PolicyDocument' => [ 'type' => 'string', 'max' => 7168, 'min' => 1, 'pattern' => '[\\P{C}\\s]+', ], 'PolicyRevision' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '\\S+', ], 'PublishPackageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'packageVersion', 'assetContent', 'assetName', 'assetSHA256', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'packageVersion' => [ 'shape' => 'PackageVersion', 'location' => 'querystring', 'locationName' => 'version', ], 'assetContent' => [ 'shape' => 'Asset', ], 'assetName' => [ 'shape' => 'AssetName', 'location' => 'querystring', 'locationName' => 'asset', ], 'assetSHA256' => [ 'shape' => 'SHA256', 'location' => 'header', 'locationName' => 'x-amz-content-sha256', ], 'unfinished' => [ 'shape' => 'BooleanOptional', 'location' => 'querystring', 'locationName' => 'unfinished', ], ], 'payload' => 'assetContent', ], 'PublishPackageVersionResult' => [ 'type' => 'structure', 'members' => [ 'format' => [ 'shape' => 'PackageFormat', ], 'namespace' => [ 'shape' => 'PackageNamespace', ], 'package' => [ 'shape' => 'PackageName', ], 'version' => [ 'shape' => 'PackageVersion', ], 'versionRevision' => [ 'shape' => 'PackageVersionRevision', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], 'asset' => [ 'shape' => 'AssetSummary', ], ], ], 'PutDomainPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'policyDocument', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], ], ], 'PutDomainPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'PutPackageOriginConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'restrictions', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'restrictions' => [ 'shape' => 'PackageOriginRestrictions', ], ], ], 'PutPackageOriginConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'originConfiguration' => [ 'shape' => 'PackageOriginConfiguration', ], ], ], 'PutRepositoryPermissionsPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'policyDocument', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'policyRevision' => [ 'shape' => 'PolicyRevision', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], ], ], 'PutRepositoryPermissionsPolicyResult' => [ 'type' => 'structure', 'members' => [ 'policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'RepositoryDescription' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RepositoryName', ], 'administratorAccount' => [ 'shape' => 'AccountId', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'description' => [ 'shape' => 'Description', ], 'upstreams' => [ 'shape' => 'UpstreamRepositoryInfoList', ], 'externalConnections' => [ 'shape' => 'RepositoryExternalConnectionInfoList', ], 'createdTime' => [ 'shape' => 'Timestamp', ], ], ], 'RepositoryExternalConnectionInfo' => [ 'type' => 'structure', 'members' => [ 'externalConnectionName' => [ 'shape' => 'ExternalConnectionName', ], 'packageFormat' => [ 'shape' => 'PackageFormat', ], 'status' => [ 'shape' => 'ExternalConnectionStatus', ], ], ], 'RepositoryExternalConnectionInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RepositoryExternalConnectionInfo', ], ], 'RepositoryName' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}', ], 'RepositoryNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RepositoryName', ], ], 'RepositorySummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RepositoryName', ], 'administratorAccount' => [ 'shape' => 'AccountId', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainOwner' => [ 'shape' => 'AccountId', ], 'arn' => [ 'shape' => 'Arn', ], 'description' => [ 'shape' => 'Description', ], 'createdTime' => [ 'shape' => 'Timestamp', ], ], ], 'RepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RepositorySummary', ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourcePolicy' => [ 'type' => 'structure', 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'revision' => [ 'shape' => 'PolicyRevision', ], 'document' => [ 'shape' => 'PolicyDocument', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'domain', 'repository', 'package', 'package-version', 'asset', ], ], 'RetryAfterSeconds' => [ 'type' => 'integer', ], 'SHA256' => [ 'type' => 'string', 'max' => 64, 'min' => 64, 'pattern' => '[0-9a-f]+', ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'String255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'SuccessfulPackageVersionInfo' => [ 'type' => 'structure', 'members' => [ 'revision' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'SuccessfulPackageVersionInfoMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PackageVersion', ], 'value' => [ 'shape' => 'SuccessfulPackageVersionInfo', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '\\P{C}+', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '\\P{C}*', ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'retryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', 'location' => 'header', 'locationName' => 'Retry-After', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePackageGroupOriginConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', 'location' => 'querystring', 'locationName' => 'package-group', ], 'restrictions' => [ 'shape' => 'OriginRestrictions', ], 'addAllowedRepositories' => [ 'shape' => 'PackageGroupAllowedRepositoryList', ], 'removeAllowedRepositories' => [ 'shape' => 'PackageGroupAllowedRepositoryList', ], ], ], 'UpdatePackageGroupOriginConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], 'allowedRepositoryUpdates' => [ 'shape' => 'PackageGroupAllowedRepositoryUpdates', ], ], ], 'UpdatePackageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'packageGroup', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'packageGroup' => [ 'shape' => 'PackageGroupPattern', ], 'contactInfo' => [ 'shape' => 'PackageGroupContactInfo', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdatePackageGroupResult' => [ 'type' => 'structure', 'members' => [ 'packageGroup' => [ 'shape' => 'PackageGroupDescription', ], ], ], 'UpdatePackageVersionsStatusRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', 'format', 'package', 'versions', 'targetStatus', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'format' => [ 'shape' => 'PackageFormat', 'location' => 'querystring', 'locationName' => 'format', ], 'namespace' => [ 'shape' => 'PackageNamespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'package' => [ 'shape' => 'PackageName', 'location' => 'querystring', 'locationName' => 'package', ], 'versions' => [ 'shape' => 'PackageVersionList', ], 'versionRevisions' => [ 'shape' => 'PackageVersionRevisionMap', ], 'expectedStatus' => [ 'shape' => 'PackageVersionStatus', ], 'targetStatus' => [ 'shape' => 'PackageVersionStatus', ], ], ], 'UpdatePackageVersionsStatusResult' => [ 'type' => 'structure', 'members' => [ 'successfulVersions' => [ 'shape' => 'SuccessfulPackageVersionInfoMap', ], 'failedVersions' => [ 'shape' => 'PackageVersionErrorMap', ], ], ], 'UpdateRepositoryRequest' => [ 'type' => 'structure', 'required' => [ 'domain', 'repository', ], 'members' => [ 'domain' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domain', ], 'domainOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'domain-owner', ], 'repository' => [ 'shape' => 'RepositoryName', 'location' => 'querystring', 'locationName' => 'repository', ], 'description' => [ 'shape' => 'Description', ], 'upstreams' => [ 'shape' => 'UpstreamRepositoryList', ], ], ], 'UpdateRepositoryResult' => [ 'type' => 'structure', 'members' => [ 'repository' => [ 'shape' => 'RepositoryDescription', ], ], ], 'UpstreamRepository' => [ 'type' => 'structure', 'required' => [ 'repositoryName', ], 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], ], ], 'UpstreamRepositoryInfo' => [ 'type' => 'structure', 'members' => [ 'repositoryName' => [ 'shape' => 'RepositoryName', ], ], ], 'UpstreamRepositoryInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpstreamRepositoryInfo', ], ], 'UpstreamRepositoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpstreamRepository', ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CANNOT_PARSE', 'ENCRYPTION_KEY_ERROR', 'FIELD_VALIDATION_FAILED', 'UNKNOWN_OPERATION', 'OTHER', ], ], ],]; diff --git a/src/data/codeartifact/2018-09-22/docs-2.json b/src/data/codeartifact/2018-09-22/docs-2.json index 4038638d8c..ebf16b8553 100644 --- a/src/data/codeartifact/2018-09-22/docs-2.json +++ b/src/data/codeartifact/2018-09-22/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact concepts

CodeArtifact supported API operations

", + "service": "

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact concepts

CodeArtifact supported API operations

", "operations": { "AssociateExternalConnection": "

Adds an existing external connection to a repository. One external connection is allowed per repository.

A repository can have one or more upstream repositories, or an external connection.

", "CopyPackageVersions": "

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

", @@ -26,7 +26,7 @@ "GetDomainPermissionsPolicy": "

Returns the resource policy attached to the specified domain.

The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.

", "GetPackageVersionAsset": "

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

", "GetPackageVersionReadme": "

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

", - "GetRepositoryEndpoint": "

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

", + "GetRepositoryEndpoint": "

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

", "GetRepositoryPermissionsPolicy": "

Returns the resource policy that is set on a repository.

", "ListAllowedRepositoriesForGroup": "

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.

", "ListAssociatedPackages": "

Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

", @@ -1040,32 +1040,32 @@ "PackageNamespace": { "base": null, "refs": { - "AssociatedPackage$namespace": "

The namespace of the associated package. The package component that specifies its namespace depends on its type. For example:

", - "CopyPackageVersionsRequest$namespace": "

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

The namespace is required when copying package versions of the following formats:

 ", - "DeletePackageRequest$namespace": "

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting packages of the following formats:

 ", - "DeletePackageVersionsRequest$namespace": "

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ", - "DescribePackageRequest$namespace": "

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting packages of the following formats:

 ", - "DescribePackageVersionRequest$namespace": "

The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting package versions of the following formats:

 ", - "DisposePackageVersionsRequest$namespace": "

The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:

The namespace is required when disposing package versions of the following formats:

 ", - "GetAssociatedPackageGroupRequest$namespace": "

The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from packages of the following formats:

 ", - "GetPackageVersionAssetRequest$namespace": "

The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting assets from package versions of the following formats:

 ", - "GetPackageVersionReadmeRequest$namespace": "

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

 ", - "GetPackageVersionReadmeResult$namespace": "

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

", - "ListPackageVersionAssetsRequest$namespace": "

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

The namespace is required requesting assets from package versions of the following formats:

 ", - "ListPackageVersionAssetsResult$namespace": "

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

", - "ListPackageVersionDependenciesRequest$namespace": "

The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:

The namespace is required when listing dependencies from package versions of the following formats:

 ", - "ListPackageVersionDependenciesResult$namespace": "

The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example:

", - "ListPackageVersionsRequest$namespace": "

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ", - "ListPackageVersionsResult$namespace": "

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

", - "ListPackagesRequest$namespace": "

The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

Each package format uses namespace as follows:

", - "PackageDependency$namespace": "

The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:

", - "PackageDescription$namespace": "

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

", - "PackageSummary$namespace": "

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

", - "PackageVersionDescription$namespace": "

The namespace of the package version. The package component that specifies its namespace depends on its type. For example:

", + "AssociatedPackage$namespace": "

The namespace of the associated package. The package component that specifies its namespace depends on its type. For example:

", + "CopyPackageVersionsRequest$namespace": "

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

The namespace is required when copying package versions of the following formats:

 ", + "DeletePackageRequest$namespace": "

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting packages of the following formats:

 ", + "DeletePackageVersionsRequest$namespace": "

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ", + "DescribePackageRequest$namespace": "

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting packages of the following formats:

 ", + "DescribePackageVersionRequest$namespace": "

The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting package versions of the following formats:

 ", + "DisposePackageVersionsRequest$namespace": "

The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:

The namespace is required when disposing package versions of the following formats:

 ", + "GetAssociatedPackageGroupRequest$namespace": "

The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from packages of the following formats:

 ", + "GetPackageVersionAssetRequest$namespace": "

The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting assets from package versions of the following formats:

 ", + "GetPackageVersionReadmeRequest$namespace": "

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

 ", + "GetPackageVersionReadmeResult$namespace": "

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

", + "ListPackageVersionAssetsRequest$namespace": "

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

The namespace is required requesting assets from package versions of the following formats:

 ", + "ListPackageVersionAssetsResult$namespace": "

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

", + "ListPackageVersionDependenciesRequest$namespace": "

The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:

The namespace is required when listing dependencies from package versions of the following formats:

 ", + "ListPackageVersionDependenciesResult$namespace": "

The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example:

", + "ListPackageVersionsRequest$namespace": "

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ", + "ListPackageVersionsResult$namespace": "

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

", + "ListPackagesRequest$namespace": "

The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

Each package format uses namespace as follows:

", + "PackageDependency$namespace": "

The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:

", + "PackageDescription$namespace": "

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

", + "PackageSummary$namespace": "

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

", + "PackageVersionDescription$namespace": "

The namespace of the package version. The package component that specifies its namespace depends on its type. For example:

", "PublishPackageVersionRequest$namespace": "

The namespace of the package version to publish.

", "PublishPackageVersionResult$namespace": "

The namespace of the package version.

", - "PutPackageOriginConfigurationRequest$namespace": "

The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:

", - "UpdatePackageVersionsStatusRequest$namespace": "

The namespace of the package version to be updated. The package component that specifies its namespace depends on its type. For example:

" + "PutPackageOriginConfigurationRequest$namespace": "

The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:

", + "UpdatePackageVersionsStatusRequest$namespace": "

The namespace of the package version to be updated. The package component that specifies its namespace depends on its type. For example:

" } }, "PackageOriginConfiguration": { diff --git a/src/data/codeartifact/2018-09-22/docs-2.json.php b/src/data/codeartifact/2018-09-22/docs-2.json.php index 0f6876ed7a..b3059b2ebe 100644 --- a/src/data/codeartifact/2018-09-22/docs-2.json.php +++ b/src/data/codeartifact/2018-09-22/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact concepts

CodeArtifact supported API operations

', 'operations' => [ 'AssociateExternalConnection' => '

Adds an existing external connection to a repository. One external connection is allowed per repository.

A repository can have one or more upstream repositories, or an external connection.

', 'CopyPackageVersions' => '

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

', 'CreateDomain' => '

Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it\'s in multiple repositories.

Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.

', 'CreatePackageGroup' => '

Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.

', 'CreateRepository' => '

Creates a repository.

', 'DeleteDomain' => '

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

', 'DeleteDomainPermissionsPolicy' => '

Deletes the resource policy set on a domain.

', 'DeletePackage' => '

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.

', 'DeletePackageGroup' => '

Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group\'s direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.

', 'DeletePackageVersions' => '

Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don\'t show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.

', 'DeleteRepository' => '

Deletes a repository.

', 'DeleteRepositoryPermissionsPolicy' => '

Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.

Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

', 'DescribeDomain' => '

Returns a DomainDescription object that contains information about the requested domain.

', 'DescribePackage' => '

Returns a PackageDescription object that contains information about the requested package.

', 'DescribePackageGroup' => '

Returns a PackageGroupDescription object that contains information about the requested package group.

', 'DescribePackageVersion' => '

Returns a PackageVersionDescription object that contains information about the requested package version.

', 'DescribeRepository' => '

Returns a RepositoryDescription object that contains detailed information about the requested repository.

', 'DisassociateExternalConnection' => '

Removes an existing external connection from a repository.

', 'DisposePackageVersions' => '

Deletes the assets in package versions and sets the package versions\' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.

To view information about a disposed package version, use DescribePackageVersion.

', 'GetAssociatedPackageGroup' => '

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group\'s origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.

For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'GetAuthorizationToken' => '

Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.

The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.

See Using IAM Roles for more information on controlling session duration.

', 'GetDomainPermissionsPolicy' => '

Returns the resource policy attached to the specified domain.

The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.

', 'GetPackageVersionAsset' => '

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

', 'GetPackageVersionReadme' => '

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

', 'GetRepositoryEndpoint' => '

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

', 'GetRepositoryPermissionsPolicy' => '

Returns the resource policy that is set on a repository.

', 'ListAllowedRepositoriesForGroup' => '

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.

', 'ListAssociatedPackages' => '

Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'ListDomains' => '

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

', 'ListPackageGroups' => '

Returns a list of package groups in the requested domain.

', 'ListPackageVersionAssets' => '

Returns a list of AssetSummary objects for assets in a package version.

', 'ListPackageVersionDependencies' => '

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

', 'ListPackageVersions' => '

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.

', 'ListPackages' => '

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

', 'ListRepositories' => '

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.

', 'ListRepositoriesInDomain' => '

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.

', 'ListSubPackageGroups' => '

Returns a list of direct children of the specified package group.

For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'ListTagsForResource' => '

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

', 'PublishPackageVersion' => '

Creates a new package version containing one or more assets (or files).

The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished.

Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.

', 'PutDomainPermissionsPolicy' => '

Sets a resource policy on a domain that specifies permissions to access it.

When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

', 'PutPackageOriginConfiguration' => '

Sets the package origin configuration for a package.

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.

PutPackageOriginConfiguration can be called on a package that doesn\'t yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.

', 'PutRepositoryPermissionsPolicy' => '

Sets the resource policy on a repository that specifies permissions to access it.

When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.

', 'TagResource' => '

Adds or updates tags for a resource in CodeArtifact.

', 'UntagResource' => '

Removes tags from a resource in CodeArtifact.

', 'UpdatePackageGroup' => '

Updates a package group. This API cannot be used to update a package group\'s origin configuration or pattern. To update a package group\'s origin configuration, use UpdatePackageGroupOriginConfiguration.

', 'UpdatePackageGroupOriginConfiguration' => '

Updates the package origin configuration for a package group.

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.

', 'UpdatePackageVersionsStatus' => '

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.

', 'UpdateRepository' => '

Update the properties of a repository.

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

The operation did not succeed because of an unauthorized access attempt.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'CopyPackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'CreatePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'CreateRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteDomainPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteDomainRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeletePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeletePackageRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeletePackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteRepositoryPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribeDomainRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribePackageRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribePackageVersionRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribeRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DisassociateExternalConnectionRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DisposePackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DomainDescription$owner' => '

The Amazon Web Services account ID that owns the domain.

', 'DomainSummary$owner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetAssociatedPackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetAuthorizationTokenRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetDomainPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetPackageVersionAssetRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetPackageVersionReadmeRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetRepositoryEndpointRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

', 'GetRepositoryPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListAllowedRepositoriesForGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListAssociatedPackagesRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageGroupsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageVersionAssetsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageVersionDependenciesRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackagesRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListRepositoriesInDomainRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListRepositoriesInDomainRequest$administratorAccount' => '

Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.

', 'ListSubPackageGroupsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PackageGroupDescription$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PackageGroupSummary$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PublishPackageVersionRequest$domainOwner' => '

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

', 'PutDomainPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PutPackageOriginConfigurationRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PutRepositoryPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'RepositoryDescription$administratorAccount' => '

The 12-digit account number of the Amazon Web Services account that manages the repository.

', 'RepositoryDescription$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

', 'RepositorySummary$administratorAccount' => '

The Amazon Web Services account ID that manages the repository.

', 'RepositorySummary$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdatePackageGroupOriginConfigurationRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdatePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdatePackageVersionsStatusRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdateRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', ], ], 'AllowPublish' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$publish' => '

The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

', 'PackageOriginRestrictions$publish' => '

The package origin configuration that determines if new versions of the package can be published directly to the repository.

', ], ], 'AllowUpstream' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$upstream' => '

The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

', 'PackageOriginRestrictions$upstream' => '

The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$encryptionKey' => '

The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

', 'DomainDescription$arn' => '

The Amazon Resource Name (ARN) of the domain.

', 'DomainDescription$encryptionKey' => '

The ARN of an Key Management Service (KMS) key associated with a domain.

', 'DomainDescription$s3BucketArn' => '

The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

', 'DomainSummary$arn' => '

The ARN of the domain.

', 'DomainSummary$encryptionKey' => '

The key used to encrypt the domain.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to get tags for.

', 'PackageGroupDescription$arn' => '

The ARN of the package group.

', 'PackageGroupReference$arn' => '

The ARN of the package group.

', 'PackageGroupSummary$arn' => '

The ARN of the package group.

', 'RepositoryDescription$arn' => '

The Amazon Resource Name (ARN) of the repository.

', 'RepositorySummary$arn' => '

The ARN of the repository.

', 'ResourcePolicy$resourceArn' => '

The ARN of the resource associated with the resource policy

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

', ], ], 'Asset' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionAssetResult$asset' => '

The binary file, or asset, that is downloaded.

', 'PublishPackageVersionRequest$assetContent' => '

The content of the asset to publish.

', ], ], 'AssetHashes' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$hashes' => '

The hashes of the asset.

', ], ], 'AssetName' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$name' => '

The name of the asset.

', 'GetPackageVersionAssetRequest$asset' => '

The name of the requested asset.

', 'GetPackageVersionAssetResult$assetName' => '

The name of the asset that is downloaded.

', 'PublishPackageVersionRequest$assetName' => '

The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . `

', ], ], 'AssetSummary' => [ 'base' => '

Contains details about a package version asset.

', 'refs' => [ 'AssetSummaryList$member' => NULL, 'PublishPackageVersionResult$asset' => '

An AssetSummary for the published asset.

', ], ], 'AssetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionAssetsResult$assets' => '

The returned list of AssetSummary objects.

', ], ], 'AssociateExternalConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateExternalConnectionResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociatedPackage' => [ 'base' => '

A package associated with a package group.

', 'refs' => [ 'AssociatedPackageList$member' => NULL, ], ], 'AssociatedPackageList' => [ 'base' => NULL, 'refs' => [ 'ListAssociatedPackagesResult$packages' => '

The list of packages associated with the requested package group.

', ], ], 'AuthorizationTokenDurationSeconds' => [ 'base' => NULL, 'refs' => [ 'GetAuthorizationTokenRequest$durationSeconds' => '

The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user\'s role\'s temporary credentials.

', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$allowOverwrite' => '

Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

', 'CopyPackageVersionsRequest$includeFromUpstream' => '

Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

', 'ListAssociatedPackagesRequest$preview' => '

When this flag is included, ListAssociatedPackages will return a list of packages that would be associated with a package group, even if it does not exist.

', 'PublishPackageVersionRequest$unfinished' => '

Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).

Valid values: unfinished

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

The operation did not succeed because prerequisites are not met.

', 'refs' => [], ], 'CopyPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyPackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreatePackageGroupRequest$description' => '

A description of the package group.

', 'CreateRepositoryRequest$description' => '

A description of the created repository.

', 'PackageGroupDescription$description' => '

The description of the package group.

', 'PackageGroupSummary$description' => '

The description of the package group.

', 'RepositoryDescription$description' => '

A text description of the repository.

', 'RepositorySummary$description' => '

The description of the repository.

', 'UpdatePackageGroupRequest$description' => '

The description you want to update the requested package group with.

', 'UpdateRepositoryRequest$description' => '

An updated repository description.

', ], ], 'DisassociateExternalConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateExternalConnectionResult' => [ 'base' => NULL, 'refs' => [], ], 'DisposePackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisposePackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DomainDescription' => [ 'base' => '

Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.

', 'refs' => [ 'CreateDomainResult$domain' => '

Contains information about the created domain after processing the request.

', 'DeleteDomainResult$domain' => '

Contains information about the deleted domain after processing the request.

', 'DescribeDomainResult$domain' => NULL, ], ], 'DomainEntryPoint' => [ 'base' => '

Information about how a package originally entered the CodeArtifact domain. For packages published directly to CodeArtifact, the entry point is the repository it was published to. For packages ingested from an external repository, the entry point is the external connection that it was ingested from. An external connection is a CodeArtifact repository that is connected to an external repository such as the npm registry or NuGet gallery.

If a package version exists in a repository and is updated, for example if a package of the same version is added with additional assets, the package version\'s DomainEntryPoint will not change from the original package version\'s value.

', 'refs' => [ 'PackageVersionOrigin$domainEntryPoint' => '

A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$domain' => '

The name of the domain that contains the repository.

', 'CopyPackageVersionsRequest$domain' => '

The name of the domain that contains the source and destination repositories.

', 'CreateDomainRequest$domain' => '

The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

', 'CreatePackageGroupRequest$domain' => '

The name of the domain in which you want to create a package group.

', 'CreateRepositoryRequest$domain' => '

The name of the domain that contains the created repository.

', 'DeleteDomainPermissionsPolicyRequest$domain' => '

The name of the domain associated with the resource policy to be deleted.

', 'DeleteDomainRequest$domain' => '

The name of the domain to delete.

', 'DeletePackageGroupRequest$domain' => '

The domain that contains the package group to be deleted.

', 'DeletePackageRequest$domain' => '

The name of the domain that contains the package to delete.

', 'DeletePackageVersionsRequest$domain' => '

The name of the domain that contains the package to delete.

', 'DeleteRepositoryPermissionsPolicyRequest$domain' => '

The name of the domain that contains the repository associated with the resource policy to be deleted.

', 'DeleteRepositoryRequest$domain' => '

The name of the domain that contains the repository to delete.

', 'DescribeDomainRequest$domain' => '

A string that specifies the name of the requested domain.

', 'DescribePackageGroupRequest$domain' => '

The name of the domain that contains the package group.

', 'DescribePackageRequest$domain' => '

The name of the domain that contains the repository that contains the package.

', 'DescribePackageVersionRequest$domain' => '

The name of the domain that contains the repository that contains the package version.

', 'DescribeRepositoryRequest$domain' => '

The name of the domain that contains the repository to describe.

', 'DisassociateExternalConnectionRequest$domain' => '

The name of the domain that contains the repository from which to remove the external repository.

', 'DisposePackageVersionsRequest$domain' => '

The name of the domain that contains the repository you want to dispose.

', 'DomainDescription$name' => '

The name of the domain.

', 'DomainSummary$name' => '

The name of the domain.

', 'GetAssociatedPackageGroupRequest$domain' => '

The name of the domain that contains the package from which to get the associated package group.

', 'GetAuthorizationTokenRequest$domain' => '

The name of the domain that is in scope for the generated authorization token.

', 'GetDomainPermissionsPolicyRequest$domain' => '

The name of the domain to which the resource policy is attached.

', 'GetPackageVersionAssetRequest$domain' => '

The name of the domain that contains the repository that contains the package version with the requested asset.

', 'GetPackageVersionReadmeRequest$domain' => '

The name of the domain that contains the repository that contains the package version with the requested readme file.

', 'GetRepositoryEndpointRequest$domain' => '

The name of the domain that contains the repository.

', 'GetRepositoryPermissionsPolicyRequest$domain' => '

The name of the domain containing the repository whose associated resource policy is to be retrieved.

', 'ListAllowedRepositoriesForGroupRequest$domain' => '

The name of the domain that contains the package group from which to list allowed repositories.

', 'ListAssociatedPackagesRequest$domain' => '

The name of the domain that contains the package group from which to list associated packages.

', 'ListPackageGroupsRequest$domain' => '

The domain for which you want to list package groups.

', 'ListPackageVersionAssetsRequest$domain' => '

The name of the domain that contains the repository associated with the package version assets.

', 'ListPackageVersionDependenciesRequest$domain' => '

The name of the domain that contains the repository that contains the requested package version dependencies.

', 'ListPackageVersionsRequest$domain' => '

The name of the domain that contains the repository that contains the requested package versions.

', 'ListPackagesRequest$domain' => '

The name of the domain that contains the repository that contains the requested packages.

', 'ListRepositoriesInDomainRequest$domain' => '

The name of the domain that contains the returned list of repositories.

', 'ListSubPackageGroupsRequest$domain' => '

The name of the domain which contains the package group from which to list sub package groups.

', 'PackageGroupDescription$domainName' => '

The name of the domain that contains the package group.

', 'PackageGroupSummary$domainName' => '

The domain that contains the package group.

', 'PublishPackageVersionRequest$domain' => '

The name of the domain that contains the repository that contains the package version to publish.

', 'PutDomainPermissionsPolicyRequest$domain' => '

The name of the domain on which to set the resource policy.

', 'PutPackageOriginConfigurationRequest$domain' => '

The name of the domain that contains the repository that contains the package.

', 'PutRepositoryPermissionsPolicyRequest$domain' => '

The name of the domain containing the repository to set the resource policy on.

', 'RepositoryDescription$domainName' => '

The name of the domain that contains the repository.

', 'RepositorySummary$domainName' => '

The name of the domain that contains the repository.

', 'UpdatePackageGroupOriginConfigurationRequest$domain' => '

The name of the domain which contains the package group for which to update the origin configuration.

', 'UpdatePackageGroupRequest$domain' => '

The name of the domain which contains the package group to be updated.

', 'UpdatePackageVersionsStatusRequest$domain' => '

The name of the domain that contains the repository that contains the package versions with a status to be updated.

', 'UpdateRepositoryRequest$domain' => '

The name of the domain associated with the repository to update.

', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$status' => '

The current status of a domain.

', 'DomainSummary$status' => '

A string that contains the status of the domain.

', ], ], 'DomainSummary' => [ 'base' => '

Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.

', 'refs' => [ 'DomainSummaryList$member' => NULL, ], ], 'DomainSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResult$domains' => '

The returned list of DomainSummary objects.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionError$errorMessage' => '

The error message associated with the error.

', ], ], 'ExternalConnectionName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$externalConnection' => '

The name of the external connection to add to the repository. The following values are supported:

', 'DisassociateExternalConnectionRequest$externalConnection' => '

The name of the external connection to be removed from the repository.

', 'DomainEntryPoint$externalConnectionName' => '

The name of the external connection that a package was ingested from.

', 'RepositoryExternalConnectionInfo$externalConnectionName' => '

The name of the external connection associated with a repository.

', ], ], 'ExternalConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'RepositoryExternalConnectionInfo$status' => '

The status of the external connection of a repository. There is one valid value, Available.

', ], ], 'GetAssociatedPackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAssociatedPackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'GetAuthorizationTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAuthorizationTokenResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionAssetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionAssetResult' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionReadmeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionReadmeResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryEndpointResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'HashAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AssetHashes$key' => NULL, ], ], 'HashValue' => [ 'base' => NULL, 'refs' => [ 'AssetHashes$value' => NULL, ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$repositoryCount' => '

The number of repositories in the domain.

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

The operation did not succeed because of an error that occurred inside CodeArtifact.

', 'refs' => [], ], 'LicenseInfo' => [ 'base' => '

Details of the license data.

', 'refs' => [ 'LicenseInfoList$member' => NULL, ], ], 'LicenseInfoList' => [ 'base' => NULL, 'refs' => [ 'PackageVersionDescription$licenses' => '

Information about licenses associated with the package version.

', ], ], 'ListAllowedRepositoriesForGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListAllowedRepositoriesForGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAllowedRepositoriesForGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociatedPackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociatedPackagesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDomainsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageGroupsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageGroupsRequest$maxResults' => '

The maximum number of results to return per page.

', 'ListSubPackageGroupsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionAssetsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionAssetsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackageVersionAssetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionAssetsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionDependenciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionDependenciesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAssociatedPackagesRequest$maxResults' => '

The maximum number of results to return per page.

', 'ListPackagesRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesInDomainMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesInDomainRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListRepositoriesInDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesInDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListRepositoriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListSubPackageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubPackageGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$assetSizeBytes' => '

The total size of all assets in the domain.

', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$size' => '

The size of the asset.

', 'PackageGroupOriginRestriction$repositoriesCount' => '

The number of repositories in the allowed repository list.

', ], ], 'OriginRestrictions' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageGroupOriginConfigurationRequest$restrictions' => '

The origin configuration settings that determine how package versions can enter repositories.

', ], ], 'PackageDependency' => [ 'base' => '

Details about a package dependency.

', 'refs' => [ 'PackageDependencyList$member' => NULL, ], ], 'PackageDependencyList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionDependenciesResult$dependencies' => '

The returned list of PackageDependency objects.

', ], ], 'PackageDescription' => [ 'base' => '

Details about a package.

', 'refs' => [ 'DescribePackageResult$package' => '

A PackageDescription object that contains information about the requested package.

', ], ], 'PackageFormat' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$format' => '

A format that specifies the type of the associated package.

', 'CopyPackageVersionsRequest$format' => '

The format of the package versions to be copied.

', 'DeletePackageRequest$format' => '

The format of the requested package to delete.

', 'DeletePackageVersionsRequest$format' => '

The format of the package versions to delete.

', 'DescribePackageRequest$format' => '

A format that specifies the type of the requested package.

', 'DescribePackageVersionRequest$format' => '

A format that specifies the type of the requested package version.

', 'DisposePackageVersionsRequest$format' => '

A format that specifies the type of package versions you want to dispose.

', 'GetAssociatedPackageGroupRequest$format' => '

The format of the package from which to get the associated package group.

', 'GetPackageVersionAssetRequest$format' => '

A format that specifies the type of the package version with the requested asset file.

', 'GetPackageVersionReadmeRequest$format' => '

A format that specifies the type of the package version with the requested readme file.

', 'GetPackageVersionReadmeResult$format' => '

The format of the package with the requested readme file.

', 'GetRepositoryEndpointRequest$format' => '

Returns which endpoint of a repository to return. A repository has one endpoint for each package format.

', 'ListPackageVersionAssetsRequest$format' => '

The format of the package that contains the requested package version assets.

', 'ListPackageVersionAssetsResult$format' => '

The format of the package that contains the requested package version assets.

', 'ListPackageVersionDependenciesRequest$format' => '

The format of the package with the requested dependencies.

', 'ListPackageVersionDependenciesResult$format' => '

A format that specifies the type of the package that contains the returned dependencies.

', 'ListPackageVersionsRequest$format' => '

The format of the package versions you want to list.

', 'ListPackageVersionsResult$format' => '

A format of the package.

', 'ListPackagesRequest$format' => '

The format used to filter requested packages. Only packages from the provided format will be returned.

', 'PackageDescription$format' => '

A format that specifies the type of the package.

', 'PackageSummary$format' => '

The format of the package.

', 'PackageVersionDescription$format' => '

The format of the package version.

', 'PublishPackageVersionRequest$format' => '

A format that specifies the type of the package version with the requested asset file.

The only supported value is generic.

', 'PublishPackageVersionResult$format' => '

The format of the package version.

', 'PutPackageOriginConfigurationRequest$format' => '

A format that specifies the type of the package to be updated.

', 'RepositoryExternalConnectionInfo$packageFormat' => '

The package format associated with a repository\'s external connection. The valid package formats are:

', 'UpdatePackageVersionsStatusRequest$format' => '

A format that specifies the type of the package with the statuses to update.

', ], ], 'PackageGroupAllowedRepository' => [ 'base' => '

Details about an allowed repository for a package group, including its name and origin configuration.

', 'refs' => [ 'PackageGroupAllowedRepositoryList$member' => NULL, ], ], 'PackageGroupAllowedRepositoryList' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageGroupOriginConfigurationRequest$addAllowedRepositories' => '

The repository name and restrictions to add to the allowed repository list of the specified package group.

', 'UpdatePackageGroupOriginConfigurationRequest$removeAllowedRepositories' => '

The repository name and restrictions to remove from the allowed repository list of the specified package group.

', ], ], 'PackageGroupAllowedRepositoryUpdate' => [ 'base' => NULL, 'refs' => [ 'PackageGroupAllowedRepositoryUpdates$value' => NULL, ], ], 'PackageGroupAllowedRepositoryUpdateType' => [ 'base' => NULL, 'refs' => [ 'PackageGroupAllowedRepositoryUpdate$key' => NULL, ], ], 'PackageGroupAllowedRepositoryUpdates' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageGroupOriginConfigurationResult$allowedRepositoryUpdates' => '

Information about the updated allowed repositories after processing the request.

', ], ], 'PackageGroupAssociationType' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$associationType' => '

Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'GetAssociatedPackageGroupResult$associationType' => '

Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.

', ], ], 'PackageGroupContactInfo' => [ 'base' => NULL, 'refs' => [ 'CreatePackageGroupRequest$contactInfo' => '

The contact information for the created package group.

', 'PackageGroupDescription$contactInfo' => '

The contact information of the package group.

', 'PackageGroupSummary$contactInfo' => '

The contact information of the package group.

', 'UpdatePackageGroupRequest$contactInfo' => '

Contact information which you want to update the requested package group with.

', ], ], 'PackageGroupDescription' => [ 'base' => '

The description of the package group.

', 'refs' => [ 'CreatePackageGroupResult$packageGroup' => '

Information about the created package group after processing the request.

', 'DeletePackageGroupResult$packageGroup' => '

Information about the deleted package group after processing the request.

', 'DescribePackageGroupResult$packageGroup' => '

A PackageGroupDescription object that contains information about the requested package group.

', 'GetAssociatedPackageGroupResult$packageGroup' => '

The package group that is associated with the requested package.

', 'UpdatePackageGroupOriginConfigurationResult$packageGroup' => '

The package group and information about it after processing the request.

', 'UpdatePackageGroupResult$packageGroup' => '

The package group and information about it after the request has been processed.

', ], ], 'PackageGroupOriginConfiguration' => [ 'base' => '

The package group origin configuration that determines how package versions can enter repositories.

', 'refs' => [ 'PackageGroupDescription$originConfiguration' => '

The package group origin configuration that determines how package versions can enter repositories.

', 'PackageGroupSummary$originConfiguration' => '

Details about the package origin configuration of a package group.

', ], ], 'PackageGroupOriginRestriction' => [ 'base' => '

Contains information about the configured restrictions of the origin controls of a package group.

', 'refs' => [ 'PackageGroupOriginRestrictions$value' => NULL, ], ], 'PackageGroupOriginRestrictionMode' => [ 'base' => NULL, 'refs' => [ 'OriginRestrictions$value' => NULL, 'PackageGroupOriginRestriction$mode' => '

The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

', 'PackageGroupOriginRestriction$effectiveMode' => '

The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

', ], ], 'PackageGroupOriginRestrictionType' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupRequest$originRestrictionType' => '

The origin configuration restriction type of which to list allowed repositories.

', 'OriginRestrictions$key' => NULL, 'PackageGroupAllowedRepository$originRestrictionType' => '

The origin configuration restriction type of the allowed repository.

', 'PackageGroupAllowedRepositoryUpdates$key' => NULL, 'PackageGroupOriginRestrictions$key' => NULL, ], ], 'PackageGroupOriginRestrictions' => [ 'base' => NULL, 'refs' => [ 'PackageGroupOriginConfiguration$restrictions' => '

The origin configuration settings that determine how package versions can enter repositories.

', ], ], 'PackageGroupPattern' => [ 'base' => NULL, 'refs' => [ 'CreatePackageGroupRequest$packageGroup' => '

The pattern of the package group to create. The pattern is also the identifier of the package group.

', 'DescribePackageGroupRequest$packageGroup' => '

The pattern of the requested package group.

', 'ListAllowedRepositoriesForGroupRequest$packageGroup' => '

The pattern of the package group from which to list allowed repositories.

', 'ListAssociatedPackagesRequest$packageGroup' => '

The pattern of the package group from which to list associated packages.

', 'ListSubPackageGroupsRequest$packageGroup' => '

The pattern of the package group from which to list sub package groups.

', 'PackageGroupDescription$pattern' => '

The pattern of the package group. The pattern determines which packages are associated with the package group.

', 'PackageGroupReference$pattern' => '

The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

', 'PackageGroupSummary$pattern' => '

The pattern of the package group. The pattern determines which packages are associated with the package group.

', 'UpdatePackageGroupOriginConfigurationRequest$packageGroup' => '

The pattern of the package group for which to update the origin configuration.

', 'UpdatePackageGroupRequest$packageGroup' => '

The pattern of the package group to be updated.

', ], ], 'PackageGroupPatternPrefix' => [ 'base' => NULL, 'refs' => [ 'ListPackageGroupsRequest$prefix' => '

A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.

', ], ], 'PackageGroupReference' => [ 'base' => '

Information about the identifiers of a package group.

', 'refs' => [ 'PackageGroupDescription$parent' => '

The direct parent package group of the package group.

', 'PackageGroupOriginRestriction$inheritedFrom' => '

The parent package group that the package group origin restrictions are inherited from.

', 'PackageGroupSummary$parent' => '

The direct parent package group of the package group.

', ], ], 'PackageGroupSummary' => [ 'base' => '

Details about a package group.

', 'refs' => [ 'PackageGroupSummaryList$member' => NULL, ], ], 'PackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageGroupsResult$packageGroups' => '

The list of package groups in the requested domain.

', 'ListSubPackageGroupsResult$packageGroups' => '

A list of sub package groups for the requested package group.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$package' => '

The name of the associated package.

', 'CopyPackageVersionsRequest$package' => '

The name of the package that contains the versions to be copied.

', 'DeletePackageRequest$package' => '

The name of the package to delete.

', 'DeletePackageVersionsRequest$package' => '

The name of the package with the versions to delete.

', 'DescribePackageRequest$package' => '

The name of the requested package.

', 'DescribePackageVersionRequest$package' => '

The name of the requested package version.

', 'DisposePackageVersionsRequest$package' => '

The name of the package with the versions you want to dispose.

', 'GetAssociatedPackageGroupRequest$package' => '

The package from which to get the associated package group.

', 'GetPackageVersionAssetRequest$package' => '

The name of the package that contains the requested asset.

', 'GetPackageVersionReadmeRequest$package' => '

The name of the package version that contains the requested readme file.

', 'GetPackageVersionReadmeResult$package' => '

The name of the package that contains the returned readme file.

', 'ListPackageVersionAssetsRequest$package' => '

The name of the package that contains the requested package version assets.

', 'ListPackageVersionAssetsResult$package' => '

The name of the package that contains the requested package version assets.

', 'ListPackageVersionDependenciesRequest$package' => '

The name of the package versions\' package.

', 'ListPackageVersionDependenciesResult$package' => '

The name of the package that contains the returned package versions dependencies.

', 'ListPackageVersionsRequest$package' => '

The name of the package for which you want to request package versions.

', 'ListPackageVersionsResult$package' => '

The name of the package.

', 'ListPackagesRequest$packagePrefix' => '

A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.

', 'PackageDependency$package' => '

The name of the package that this package depends on.

', 'PackageDescription$name' => '

The name of the package.

', 'PackageSummary$package' => '

The name of the package.

', 'PackageVersionDescription$packageName' => '

The name of the requested package.

', 'PublishPackageVersionRequest$package' => '

The name of the package version to publish.

', 'PublishPackageVersionResult$package' => '

The name of the package.

', 'PutPackageOriginConfigurationRequest$package' => '

The name of the package to be updated.

', 'UpdatePackageVersionsStatusRequest$package' => '

The name of the package with the version statuses to update.

', ], ], 'PackageNamespace' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$namespace' => '

The namespace of the associated package. The package component that specifies its namespace depends on its type. For example:

', 'CopyPackageVersionsRequest$namespace' => '

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

The namespace is required when copying package versions of the following formats:

 ', 'DeletePackageRequest$namespace' => '

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting packages of the following formats:

 ', 'DeletePackageVersionsRequest$namespace' => '

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ', 'DescribePackageRequest$namespace' => '

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting packages of the following formats:

 ', 'DescribePackageVersionRequest$namespace' => '

The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting package versions of the following formats:

 ', 'DisposePackageVersionsRequest$namespace' => '

The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:

The namespace is required when disposing package versions of the following formats:

 ', 'GetAssociatedPackageGroupRequest$namespace' => '

The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from packages of the following formats:

 ', 'GetPackageVersionAssetRequest$namespace' => '

The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting assets from package versions of the following formats:

 ', 'GetPackageVersionReadmeRequest$namespace' => '

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

 ', 'GetPackageVersionReadmeResult$namespace' => '

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

', 'ListPackageVersionAssetsRequest$namespace' => '

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

The namespace is required requesting assets from package versions of the following formats:

 ', 'ListPackageVersionAssetsResult$namespace' => '

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

', 'ListPackageVersionDependenciesRequest$namespace' => '

The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:

The namespace is required when listing dependencies from package versions of the following formats:

 ', 'ListPackageVersionDependenciesResult$namespace' => '

The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example:

', 'ListPackageVersionsRequest$namespace' => '

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ', 'ListPackageVersionsResult$namespace' => '

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

', 'ListPackagesRequest$namespace' => '

The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

Each package format uses namespace as follows:

', 'PackageDependency$namespace' => '

The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:

', 'PackageDescription$namespace' => '

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

', 'PackageSummary$namespace' => '

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

', 'PackageVersionDescription$namespace' => '

The namespace of the package version. The package component that specifies its namespace depends on its type. For example:

', 'PublishPackageVersionRequest$namespace' => '

The namespace of the package version to publish.

', 'PublishPackageVersionResult$namespace' => '

The namespace of the package version.

', 'PutPackageOriginConfigurationRequest$namespace' => '

The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:

', 'UpdatePackageVersionsStatusRequest$namespace' => '

The namespace of the package version to be updated. The package component that specifies its namespace depends on its type. For example:

', ], ], 'PackageOriginConfiguration' => [ 'base' => '

Details about the package origin configuration of a package.

', 'refs' => [ 'PackageDescription$originConfiguration' => '

The package origin configuration for the package.

', 'PackageSummary$originConfiguration' => '

A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.

', 'PutPackageOriginConfigurationResult$originConfiguration' => '

A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.

', ], ], 'PackageOriginRestrictions' => [ 'base' => '

Details about the origin restrictions set on the package. The package origin restrictions determine how new versions of a package can be added to a specific repository.

', 'refs' => [ 'PackageOriginConfiguration$restrictions' => '

A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

', 'PutPackageOriginConfigurationRequest$restrictions' => '

A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.

You must include both the desired upstream and publish restrictions.

', ], ], 'PackageSummary' => [ 'base' => '

Details about a package, including its format, namespace, and name.

', 'refs' => [ 'DeletePackageResult$deletedPackage' => NULL, 'PackageSummaryList$member' => NULL, ], ], 'PackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackagesResult$packages' => '

The list of returned PackageSummary objects.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DescribePackageVersionRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionAssetRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionAssetResult$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionReadmeRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionReadmeResult$version' => '

The version of the package with the requested readme file.

', 'ListPackageVersionAssetsRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'ListPackageVersionAssetsResult$version' => '

The version of the package associated with the requested assets.

', 'ListPackageVersionDependenciesRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'ListPackageVersionDependenciesResult$version' => '

The version of the package that is specified in the request.

', 'ListPackageVersionsResult$defaultDisplayVersion' => '

The default package version to display. This depends on the package format:

', 'PackageVersionDescription$version' => '

The version of the package.

', 'PackageVersionErrorMap$key' => NULL, 'PackageVersionList$member' => NULL, 'PackageVersionRevisionMap$key' => NULL, 'PackageVersionSummary$version' => '

Information about a package version.

', 'PublishPackageVersionRequest$packageVersion' => '

The package version to publish (for example, 3.5.2).

', 'PublishPackageVersionResult$version' => '

The version of the package.

', 'SuccessfulPackageVersionInfoMap$key' => NULL, ], ], 'PackageVersionDescription' => [ 'base' => '

Details about a package version.

', 'refs' => [ 'DescribePackageVersionResult$packageVersion' => '

A PackageVersionDescription object that contains information about the requested package version.

', ], ], 'PackageVersionError' => [ 'base' => '

l An error associated with package.

', 'refs' => [ 'PackageVersionErrorMap$value' => NULL, ], ], 'PackageVersionErrorCode' => [ 'base' => NULL, 'refs' => [ 'PackageVersionError$errorCode' => '

The error code associated with the error. Valid error codes are:

', ], ], 'PackageVersionErrorMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsResult$failedVersions' => '

A map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They are:

', 'DeletePackageVersionsResult$failedVersions' => '

A PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are:

', 'DisposePackageVersionsResult$failedVersions' => '

A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:

', 'UpdatePackageVersionsStatusResult$failedVersions' => '

A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

', ], ], 'PackageVersionList' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$versions' => '

The versions of the package to be copied.

You must specify versions or versionRevisions. You cannot specify both.

', 'DeletePackageVersionsRequest$versions' => '

An array of strings that specify the versions of the package to delete.

', 'DisposePackageVersionsRequest$versions' => '

The versions of the package you want to dispose.

', 'UpdatePackageVersionsStatusRequest$versions' => '

An array of strings that specify the versions of the package with the statuses to update.

', ], ], 'PackageVersionOrigin' => [ 'base' => '

Information about how a package version was added to a repository.

', 'refs' => [ 'PackageVersionDescription$origin' => '

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

', 'PackageVersionSummary$origin' => '

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

', ], ], 'PackageVersionOriginType' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$originType' => '

The originType used to filter package versions. Only package versions with the provided originType will be returned.

', 'PackageVersionOrigin$originType' => '

Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection.

', ], ], 'PackageVersionRevision' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionAssetRequest$packageVersionRevision' => '

The name of the package version revision that contains the requested asset.

', 'GetPackageVersionAssetResult$packageVersionRevision' => '

The name of the package version revision that contains the downloaded asset.

', 'GetPackageVersionReadmeResult$versionRevision' => '

The current revision associated with the package version.

', 'ListPackageVersionAssetsResult$versionRevision' => '

The current revision associated with the package version.

', 'ListPackageVersionDependenciesResult$versionRevision' => '

The current revision associated with the package version.

', 'PackageVersionDescription$revision' => '

The revision of the package version.

', 'PackageVersionRevisionMap$value' => NULL, 'PackageVersionSummary$revision' => '

The revision associated with a package version.

', 'PublishPackageVersionResult$versionRevision' => '

The revision of the package version.

', ], ], 'PackageVersionRevisionMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$versionRevisions' => '

A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

You must specify versions or versionRevisions. You cannot specify both.

', 'DisposePackageVersionsRequest$versionRevisions' => '

The revisions of the package versions you want to dispose.

', 'UpdatePackageVersionsStatusRequest$versionRevisions' => '

A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.

', ], ], 'PackageVersionSortType' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$sortBy' => '

How to sort the requested list of package versions.

', ], ], 'PackageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DeletePackageVersionsRequest$expectedStatus' => '

The expected status of the package version to delete.

', 'DisposePackageVersionsRequest$expectedStatus' => '

The expected status of the package version to dispose.

', 'ListPackageVersionsRequest$status' => '

A string that filters the requested package versions by status.

', 'PackageVersionDescription$status' => '

A string that contains the status of the package version.

', 'PackageVersionSummary$status' => '

A string that contains the status of the package version. It can be one of the following:

', 'PublishPackageVersionResult$status' => '

A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.

', 'SuccessfulPackageVersionInfo$status' => '

The status of a package version.

', 'UpdatePackageVersionsStatusRequest$expectedStatus' => '

The package version’s expected status before it is updated. If expectedStatus is provided, the package version\'s status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

', 'UpdatePackageVersionsStatusRequest$targetStatus' => '

The status you want to change the package version status to.

', ], ], 'PackageVersionSummary' => [ 'base' => '

Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.

', 'refs' => [ 'PackageVersionSummaryList$member' => NULL, ], ], 'PackageVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsResult$versions' => '

The returned list of PackageVersionSummary objects.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListAllowedRepositoriesForGroupResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListAssociatedPackagesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListAssociatedPackagesResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListDomainsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListDomainsResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageGroupsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageGroupsResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionAssetsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionAssetsResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListPackageVersionDependenciesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionDependenciesResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionsResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListPackagesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackagesResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListRepositoriesInDomainRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListRepositoriesInDomainResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListRepositoriesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListRepositoriesResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListSubPackageGroupsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListSubPackageGroupsResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', ], ], 'PolicyDocument' => [ 'base' => NULL, 'refs' => [ 'PutDomainPermissionsPolicyRequest$policyDocument' => '

A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

', 'PutRepositoryPermissionsPolicyRequest$policyDocument' => '

A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.

', 'ResourcePolicy$document' => '

The resource policy formatted in JSON.

', ], ], 'PolicyRevision' => [ 'base' => NULL, 'refs' => [ 'DeleteDomainPermissionsPolicyRequest$policyRevision' => '

The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain\'s resource policy.

', 'DeleteRepositoryPermissionsPolicyRequest$policyRevision' => '

The revision of the repository\'s resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository\'s resource policy.

', 'PutDomainPermissionsPolicyRequest$policyRevision' => '

The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain\'s resource policy.

', 'PutRepositoryPermissionsPolicyRequest$policyRevision' => '

Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository\'s resource policy.

', 'ResourcePolicy$revision' => '

The current revision of the resource policy.

', ], ], 'PublishPackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PublishPackageVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'PutDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'PutPackageOriginConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPackageOriginConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'PutRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryDescription' => [ 'base' => '

The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per Amazon Web Services account.

', 'refs' => [ 'AssociateExternalConnectionResult$repository' => '

Information about the connected repository after processing the request.

', 'CreateRepositoryResult$repository' => '

Information about the created repository after processing the request.

', 'DeleteRepositoryResult$repository' => '

Information about the deleted repository after processing the request.

', 'DescribeRepositoryResult$repository' => '

A RepositoryDescription object that contains the requested repository information.

', 'DisassociateExternalConnectionResult$repository' => '

The repository associated with the removed external connection.

', 'UpdateRepositoryResult$repository' => '

The updated repository.

', ], ], 'RepositoryExternalConnectionInfo' => [ 'base' => '

Contains information about the external connection of a repository.

', 'refs' => [ 'RepositoryExternalConnectionInfoList$member' => NULL, ], ], 'RepositoryExternalConnectionInfoList' => [ 'base' => NULL, 'refs' => [ 'RepositoryDescription$externalConnections' => '

An array of external connections associated with the repository.

', ], ], 'RepositoryName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$repository' => '

The name of the repository to which the external connection is added.

', 'CopyPackageVersionsRequest$sourceRepository' => '

The name of the repository that contains the package versions to be copied.

', 'CopyPackageVersionsRequest$destinationRepository' => '

The name of the repository into which package versions are copied.

', 'CreateRepositoryRequest$repository' => '

The name of the repository to create.

', 'DeletePackageRequest$repository' => '

The name of the repository that contains the package to delete.

', 'DeletePackageVersionsRequest$repository' => '

The name of the repository that contains the package versions to delete.

', 'DeleteRepositoryPermissionsPolicyRequest$repository' => '

The name of the repository that is associated with the resource policy to be deleted

', 'DeleteRepositoryRequest$repository' => '

The name of the repository to delete.

', 'DescribePackageRequest$repository' => '

The name of the repository that contains the requested package.

', 'DescribePackageVersionRequest$repository' => '

The name of the repository that contains the package version.

', 'DescribeRepositoryRequest$repository' => '

A string that specifies the name of the requested repository.

', 'DisassociateExternalConnectionRequest$repository' => '

The name of the repository from which the external connection will be removed.

', 'DisposePackageVersionsRequest$repository' => '

The name of the repository that contains the package versions you want to dispose.

', 'DomainEntryPoint$repositoryName' => '

The name of the repository that a package was originally published to.

', 'GetPackageVersionAssetRequest$repository' => '

The repository that contains the package version with the requested asset.

', 'GetPackageVersionReadmeRequest$repository' => '

The repository that contains the package with the requested readme file.

', 'GetRepositoryEndpointRequest$repository' => '

The name of the repository.

', 'GetRepositoryPermissionsPolicyRequest$repository' => '

The name of the repository whose associated resource policy is to be retrieved.

', 'ListPackageVersionAssetsRequest$repository' => '

The name of the repository that contains the package that contains the requested package version assets.

', 'ListPackageVersionDependenciesRequest$repository' => '

The name of the repository that contains the requested package version.

', 'ListPackageVersionsRequest$repository' => '

The name of the repository that contains the requested package versions.

', 'ListPackagesRequest$repository' => '

The name of the repository that contains the requested packages.

', 'ListRepositoriesInDomainRequest$repositoryPrefix' => '

A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

', 'ListRepositoriesRequest$repositoryPrefix' => '

A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

', 'PackageGroupAllowedRepository$repositoryName' => '

The name of the allowed repository.

', 'PublishPackageVersionRequest$repository' => '

The name of the repository that the package version will be published to.

', 'PutPackageOriginConfigurationRequest$repository' => '

The name of the repository that contains the package.

', 'PutRepositoryPermissionsPolicyRequest$repository' => '

The name of the repository to set the resource policy on.

', 'RepositoryDescription$name' => '

The name of the repository.

', 'RepositoryNameList$member' => NULL, 'RepositorySummary$name' => '

The name of the repository.

', 'UpdatePackageVersionsStatusRequest$repository' => '

The repository that contains the package versions with the status you want to update.

', 'UpdateRepositoryRequest$repository' => '

The name of the repository to update.

', 'UpstreamRepository$repositoryName' => '

The name of an upstream repository.

', 'UpstreamRepositoryInfo$repositoryName' => '

The name of an upstream repository.

', ], ], 'RepositoryNameList' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupResult$allowedRepositories' => '

The list of allowed repositories for the package group and origin configuration restriction type.

', 'PackageGroupAllowedRepositoryUpdate$value' => NULL, ], ], 'RepositorySummary' => [ 'base' => '

Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.

', 'refs' => [ 'RepositorySummaryList$member' => NULL, ], ], 'RepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesInDomainResult$repositories' => '

The returned list of repositories.

', 'ListRepositoriesResult$repositories' => '

The returned list of RepositorySummary objects.

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

The operation did not succeed because the resource requested is not found in the service.

', 'refs' => [], ], 'ResourcePolicy' => [ 'base' => '

An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.

', 'refs' => [ 'DeleteDomainPermissionsPolicyResult$policy' => '

Information about the deleted resource policy after processing the request.

', 'DeleteRepositoryPermissionsPolicyResult$policy' => '

Information about the deleted policy after processing the request.

', 'GetDomainPermissionsPolicyResult$policy' => '

The returned resource policy.

', 'GetRepositoryPermissionsPolicyResult$policy' => '

The returned resource policy.

', 'PutDomainPermissionsPolicyResult$policy' => '

The resource policy that was set after processing the request.

', 'PutRepositoryPermissionsPolicyResult$policy' => '

The resource policy that was set after processing the request.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceType' => '

The type of Amazon Web Services resource.

', 'ResourceNotFoundException$resourceType' => '

The type of Amazon Web Services resource.

', 'ServiceQuotaExceededException$resourceType' => '

The type of Amazon Web Services resource.

', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => '

The time period, in seconds, to wait before retrying the request.

', ], ], 'SHA256' => [ 'base' => NULL, 'refs' => [ 'PublishPackageVersionRequest$assetSHA256' => '

The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).

This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.

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

The operation did not succeed because it would have exceeded a service limit for your account.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'ConflictException$resourceId' => '

The ID of the resource.

', 'DeletePackageGroupRequest$packageGroup' => '

The pattern of the package group to be deleted.

', 'GetAuthorizationTokenResult$authorizationToken' => '

The returned authentication token.

', 'GetPackageVersionReadmeResult$readme' => '

The text of the returned readme file.

', 'GetRepositoryEndpointResult$repositoryEndpoint' => '

A string that specifies the URL of the returned endpoint.

', 'InternalServerException$message' => NULL, 'LicenseInfo$name' => '

Name of the license.

', 'LicenseInfo$url' => '

The URL for license data.

', 'PackageDependency$dependencyType' => '

The type of a package dependency. The possible values depend on the package type.

', 'PackageDependency$versionRequirement' => '

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

', 'PackageVersionDescription$summary' => '

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version\'s format.

', 'PackageVersionDescription$homePage' => '

The homepage associated with the package.

', 'PackageVersionDescription$sourceCodeRepository' => '

The repository for the source code in the package version, or the source code used to build it.

', 'ResourceNotFoundException$message' => NULL, 'ResourceNotFoundException$resourceId' => '

The ID of the resource.

', 'ServiceQuotaExceededException$message' => NULL, 'ServiceQuotaExceededException$resourceId' => '

The ID of the resource.

', 'SuccessfulPackageVersionInfo$revision' => '

The revision of a package version.

', 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'String255' => [ 'base' => NULL, 'refs' => [ 'PackageVersionDescription$displayName' => '

The name of the package that is displayed. The displayName varies depending on the package version\'s format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

', ], ], 'SuccessfulPackageVersionInfo' => [ 'base' => '

Contains the revision and status of a package version.

', 'refs' => [ 'SuccessfulPackageVersionInfoMap$value' => NULL, ], ], 'SuccessfulPackageVersionInfoMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsResult$successfulVersions' => '

A list of the package versions that were successfully copied to your repository.

', 'DeletePackageVersionsResult$successfulVersions' => '

A list of the package versions that were successfully deleted. The status of every successful version will be Deleted.

', 'DisposePackageVersionsResult$successfulVersions' => '

A list of the package versions that were successfully disposed.

', 'UpdatePackageVersionsStatusResult$successfulVersions' => '

A list of PackageVersionError objects, one for each package version with a status that failed to update.

', ], ], 'Tag' => [ 'base' => '

A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The tag key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The tag key for each tag that you want to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$tags' => '

One or more tag key-value pairs for the domain.

', 'CreatePackageGroupRequest$tags' => '

One or more tag key-value pairs for the package group.

', 'CreateRepositoryRequest$tags' => '

One or more tag key-value pairs for the repository.

', 'ListTagsForResourceResult$tags' => '

A list of tag key and value pairs associated with the specified resource.

', 'TagResourceRequest$tags' => '

The tags you want to modify or add to the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The tag value.

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

The operation did not succeed because too many requests are sent to the service.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$createdTime' => '

A timestamp that represents the date and time the domain was created.

', 'DomainSummary$createdTime' => '

A timestamp that contains the date and time the domain was created.

', 'GetAuthorizationTokenResult$expiration' => '

A timestamp that specifies the date and time the authorization token expires.

', 'PackageGroupDescription$createdTime' => '

A timestamp that represents the date and time the package group was created.

', 'PackageGroupSummary$createdTime' => '

A timestamp that represents the date and time the repository was created.

', 'PackageVersionDescription$publishedTime' => '

A timestamp that contains the date and time the package version was published.

', 'RepositoryDescription$createdTime' => '

A timestamp that represents the date and time the repository was created.

', 'RepositorySummary$createdTime' => '

A timestamp that represents the date and time the repository was created.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupOriginConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupOriginConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionsStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionsStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpstreamRepository' => [ 'base' => '

Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.

', 'refs' => [ 'UpstreamRepositoryList$member' => NULL, ], ], 'UpstreamRepositoryInfo' => [ 'base' => '

Information about an upstream repository.

', 'refs' => [ 'UpstreamRepositoryInfoList$member' => NULL, ], ], 'UpstreamRepositoryInfoList' => [ 'base' => NULL, 'refs' => [ 'RepositoryDescription$upstreams' => '

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

', ], ], 'UpstreamRepositoryList' => [ 'base' => NULL, 'refs' => [ 'CreateRepositoryRequest$upstreams' => '

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

', 'UpdateRepositoryRequest$upstreams' => '

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

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

The operation did not succeed because a parameter in the request was sent with an invalid value.

', 'refs' => [], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '

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

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact concepts

CodeArtifact supported API operations

', 'operations' => [ 'AssociateExternalConnection' => '

Adds an existing external connection to a repository. One external connection is allowed per repository.

A repository can have one or more upstream repositories, or an external connection.

', 'CopyPackageVersions' => '

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

', 'CreateDomain' => '

Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it\'s in multiple repositories.

Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.

', 'CreatePackageGroup' => '

Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.

', 'CreateRepository' => '

Creates a repository.

', 'DeleteDomain' => '

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

', 'DeleteDomainPermissionsPolicy' => '

Deletes the resource policy set on a domain.

', 'DeletePackage' => '

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.

', 'DeletePackageGroup' => '

Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group\'s direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.

', 'DeletePackageVersions' => '

Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don\'t show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.

', 'DeleteRepository' => '

Deletes a repository.

', 'DeleteRepositoryPermissionsPolicy' => '

Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.

Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

', 'DescribeDomain' => '

Returns a DomainDescription object that contains information about the requested domain.

', 'DescribePackage' => '

Returns a PackageDescription object that contains information about the requested package.

', 'DescribePackageGroup' => '

Returns a PackageGroupDescription object that contains information about the requested package group.

', 'DescribePackageVersion' => '

Returns a PackageVersionDescription object that contains information about the requested package version.

', 'DescribeRepository' => '

Returns a RepositoryDescription object that contains detailed information about the requested repository.

', 'DisassociateExternalConnection' => '

Removes an existing external connection from a repository.

', 'DisposePackageVersions' => '

Deletes the assets in package versions and sets the package versions\' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.

To view information about a disposed package version, use DescribePackageVersion.

', 'GetAssociatedPackageGroup' => '

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group\'s origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.

For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'GetAuthorizationToken' => '

Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.

The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.

See Using IAM Roles for more information on controlling session duration.

', 'GetDomainPermissionsPolicy' => '

Returns the resource policy attached to the specified domain.

The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.

', 'GetPackageVersionAsset' => '

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

', 'GetPackageVersionReadme' => '

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

', 'GetRepositoryEndpoint' => '

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

', 'GetRepositoryPermissionsPolicy' => '

Returns the resource policy that is set on a repository.

', 'ListAllowedRepositoriesForGroup' => '

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.

', 'ListAssociatedPackages' => '

Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'ListDomains' => '

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

', 'ListPackageGroups' => '

Returns a list of package groups in the requested domain.

', 'ListPackageVersionAssets' => '

Returns a list of AssetSummary objects for assets in a package version.

', 'ListPackageVersionDependencies' => '

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

', 'ListPackageVersions' => '

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.

', 'ListPackages' => '

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

', 'ListRepositories' => '

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.

', 'ListRepositoriesInDomain' => '

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.

', 'ListSubPackageGroups' => '

Returns a list of direct children of the specified package group.

For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'ListTagsForResource' => '

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

', 'PublishPackageVersion' => '

Creates a new package version containing one or more assets (or files).

The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished.

Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.

', 'PutDomainPermissionsPolicy' => '

Sets a resource policy on a domain that specifies permissions to access it.

When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

', 'PutPackageOriginConfiguration' => '

Sets the package origin configuration for a package.

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.

PutPackageOriginConfiguration can be called on a package that doesn\'t yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.

', 'PutRepositoryPermissionsPolicy' => '

Sets the resource policy on a repository that specifies permissions to access it.

When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.

', 'TagResource' => '

Adds or updates tags for a resource in CodeArtifact.

', 'UntagResource' => '

Removes tags from a resource in CodeArtifact.

', 'UpdatePackageGroup' => '

Updates a package group. This API cannot be used to update a package group\'s origin configuration or pattern. To update a package group\'s origin configuration, use UpdatePackageGroupOriginConfiguration.

', 'UpdatePackageGroupOriginConfiguration' => '

Updates the package origin configuration for a package group.

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.

', 'UpdatePackageVersionsStatus' => '

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.

', 'UpdateRepository' => '

Update the properties of a repository.

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

The operation did not succeed because of an unauthorized access attempt.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'CopyPackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'CreatePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'CreateRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteDomainPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteDomainRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeletePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeletePackageRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeletePackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteRepositoryPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DeleteRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribeDomainRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribePackageRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribePackageVersionRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DescribeRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DisassociateExternalConnectionRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DisposePackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'DomainDescription$owner' => '

The Amazon Web Services account ID that owns the domain.

', 'DomainSummary$owner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetAssociatedPackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetAuthorizationTokenRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetDomainPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetPackageVersionAssetRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetPackageVersionReadmeRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'GetRepositoryEndpointRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

', 'GetRepositoryPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListAllowedRepositoriesForGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListAssociatedPackagesRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageGroupsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageVersionAssetsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageVersionDependenciesRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackageVersionsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListPackagesRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListRepositoriesInDomainRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'ListRepositoriesInDomainRequest$administratorAccount' => '

Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.

', 'ListSubPackageGroupsRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PackageGroupDescription$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PackageGroupSummary$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PublishPackageVersionRequest$domainOwner' => '

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

', 'PutDomainPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PutPackageOriginConfigurationRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'PutRepositoryPermissionsPolicyRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'RepositoryDescription$administratorAccount' => '

The 12-digit account number of the Amazon Web Services account that manages the repository.

', 'RepositoryDescription$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

', 'RepositorySummary$administratorAccount' => '

The Amazon Web Services account ID that manages the repository.

', 'RepositorySummary$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdatePackageGroupOriginConfigurationRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdatePackageGroupRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdatePackageVersionsStatusRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', 'UpdateRepositoryRequest$domainOwner' => '

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

', ], ], 'AllowPublish' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$publish' => '

The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

', 'PackageOriginRestrictions$publish' => '

The package origin configuration that determines if new versions of the package can be published directly to the repository.

', ], ], 'AllowUpstream' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$upstream' => '

The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

', 'PackageOriginRestrictions$upstream' => '

The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$encryptionKey' => '

The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

', 'DomainDescription$arn' => '

The Amazon Resource Name (ARN) of the domain.

', 'DomainDescription$encryptionKey' => '

The ARN of an Key Management Service (KMS) key associated with a domain.

', 'DomainDescription$s3BucketArn' => '

The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

', 'DomainSummary$arn' => '

The ARN of the domain.

', 'DomainSummary$encryptionKey' => '

The key used to encrypt the domain.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to get tags for.

', 'PackageGroupDescription$arn' => '

The ARN of the package group.

', 'PackageGroupReference$arn' => '

The ARN of the package group.

', 'PackageGroupSummary$arn' => '

The ARN of the package group.

', 'RepositoryDescription$arn' => '

The Amazon Resource Name (ARN) of the repository.

', 'RepositorySummary$arn' => '

The ARN of the repository.

', 'ResourcePolicy$resourceArn' => '

The ARN of the resource associated with the resource policy

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

', ], ], 'Asset' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionAssetResult$asset' => '

The binary file, or asset, that is downloaded.

', 'PublishPackageVersionRequest$assetContent' => '

The content of the asset to publish.

', ], ], 'AssetHashes' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$hashes' => '

The hashes of the asset.

', ], ], 'AssetName' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$name' => '

The name of the asset.

', 'GetPackageVersionAssetRequest$asset' => '

The name of the requested asset.

', 'GetPackageVersionAssetResult$assetName' => '

The name of the asset that is downloaded.

', 'PublishPackageVersionRequest$assetName' => '

The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . `

', ], ], 'AssetSummary' => [ 'base' => '

Contains details about a package version asset.

', 'refs' => [ 'AssetSummaryList$member' => NULL, 'PublishPackageVersionResult$asset' => '

An AssetSummary for the published asset.

', ], ], 'AssetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionAssetsResult$assets' => '

The returned list of AssetSummary objects.

', ], ], 'AssociateExternalConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateExternalConnectionResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociatedPackage' => [ 'base' => '

A package associated with a package group.

', 'refs' => [ 'AssociatedPackageList$member' => NULL, ], ], 'AssociatedPackageList' => [ 'base' => NULL, 'refs' => [ 'ListAssociatedPackagesResult$packages' => '

The list of packages associated with the requested package group.

', ], ], 'AuthorizationTokenDurationSeconds' => [ 'base' => NULL, 'refs' => [ 'GetAuthorizationTokenRequest$durationSeconds' => '

The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user\'s role\'s temporary credentials.

', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$allowOverwrite' => '

Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

', 'CopyPackageVersionsRequest$includeFromUpstream' => '

Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

', 'ListAssociatedPackagesRequest$preview' => '

When this flag is included, ListAssociatedPackages will return a list of packages that would be associated with a package group, even if it does not exist.

', 'PublishPackageVersionRequest$unfinished' => '

Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).

Valid values: unfinished

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

The operation did not succeed because prerequisites are not met.

', 'refs' => [], ], 'CopyPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyPackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreatePackageGroupRequest$description' => '

A description of the package group.

', 'CreateRepositoryRequest$description' => '

A description of the created repository.

', 'PackageGroupDescription$description' => '

The description of the package group.

', 'PackageGroupSummary$description' => '

The description of the package group.

', 'RepositoryDescription$description' => '

A text description of the repository.

', 'RepositorySummary$description' => '

The description of the repository.

', 'UpdatePackageGroupRequest$description' => '

The description you want to update the requested package group with.

', 'UpdateRepositoryRequest$description' => '

An updated repository description.

', ], ], 'DisassociateExternalConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateExternalConnectionResult' => [ 'base' => NULL, 'refs' => [], ], 'DisposePackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisposePackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DomainDescription' => [ 'base' => '

Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.

', 'refs' => [ 'CreateDomainResult$domain' => '

Contains information about the created domain after processing the request.

', 'DeleteDomainResult$domain' => '

Contains information about the deleted domain after processing the request.

', 'DescribeDomainResult$domain' => NULL, ], ], 'DomainEntryPoint' => [ 'base' => '

Information about how a package originally entered the CodeArtifact domain. For packages published directly to CodeArtifact, the entry point is the repository it was published to. For packages ingested from an external repository, the entry point is the external connection that it was ingested from. An external connection is a CodeArtifact repository that is connected to an external repository such as the npm registry or NuGet gallery.

If a package version exists in a repository and is updated, for example if a package of the same version is added with additional assets, the package version\'s DomainEntryPoint will not change from the original package version\'s value.

', 'refs' => [ 'PackageVersionOrigin$domainEntryPoint' => '

A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$domain' => '

The name of the domain that contains the repository.

', 'CopyPackageVersionsRequest$domain' => '

The name of the domain that contains the source and destination repositories.

', 'CreateDomainRequest$domain' => '

The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

', 'CreatePackageGroupRequest$domain' => '

The name of the domain in which you want to create a package group.

', 'CreateRepositoryRequest$domain' => '

The name of the domain that contains the created repository.

', 'DeleteDomainPermissionsPolicyRequest$domain' => '

The name of the domain associated with the resource policy to be deleted.

', 'DeleteDomainRequest$domain' => '

The name of the domain to delete.

', 'DeletePackageGroupRequest$domain' => '

The domain that contains the package group to be deleted.

', 'DeletePackageRequest$domain' => '

The name of the domain that contains the package to delete.

', 'DeletePackageVersionsRequest$domain' => '

The name of the domain that contains the package to delete.

', 'DeleteRepositoryPermissionsPolicyRequest$domain' => '

The name of the domain that contains the repository associated with the resource policy to be deleted.

', 'DeleteRepositoryRequest$domain' => '

The name of the domain that contains the repository to delete.

', 'DescribeDomainRequest$domain' => '

A string that specifies the name of the requested domain.

', 'DescribePackageGroupRequest$domain' => '

The name of the domain that contains the package group.

', 'DescribePackageRequest$domain' => '

The name of the domain that contains the repository that contains the package.

', 'DescribePackageVersionRequest$domain' => '

The name of the domain that contains the repository that contains the package version.

', 'DescribeRepositoryRequest$domain' => '

The name of the domain that contains the repository to describe.

', 'DisassociateExternalConnectionRequest$domain' => '

The name of the domain that contains the repository from which to remove the external repository.

', 'DisposePackageVersionsRequest$domain' => '

The name of the domain that contains the repository you want to dispose.

', 'DomainDescription$name' => '

The name of the domain.

', 'DomainSummary$name' => '

The name of the domain.

', 'GetAssociatedPackageGroupRequest$domain' => '

The name of the domain that contains the package from which to get the associated package group.

', 'GetAuthorizationTokenRequest$domain' => '

The name of the domain that is in scope for the generated authorization token.

', 'GetDomainPermissionsPolicyRequest$domain' => '

The name of the domain to which the resource policy is attached.

', 'GetPackageVersionAssetRequest$domain' => '

The name of the domain that contains the repository that contains the package version with the requested asset.

', 'GetPackageVersionReadmeRequest$domain' => '

The name of the domain that contains the repository that contains the package version with the requested readme file.

', 'GetRepositoryEndpointRequest$domain' => '

The name of the domain that contains the repository.

', 'GetRepositoryPermissionsPolicyRequest$domain' => '

The name of the domain containing the repository whose associated resource policy is to be retrieved.

', 'ListAllowedRepositoriesForGroupRequest$domain' => '

The name of the domain that contains the package group from which to list allowed repositories.

', 'ListAssociatedPackagesRequest$domain' => '

The name of the domain that contains the package group from which to list associated packages.

', 'ListPackageGroupsRequest$domain' => '

The domain for which you want to list package groups.

', 'ListPackageVersionAssetsRequest$domain' => '

The name of the domain that contains the repository associated with the package version assets.

', 'ListPackageVersionDependenciesRequest$domain' => '

The name of the domain that contains the repository that contains the requested package version dependencies.

', 'ListPackageVersionsRequest$domain' => '

The name of the domain that contains the repository that contains the requested package versions.

', 'ListPackagesRequest$domain' => '

The name of the domain that contains the repository that contains the requested packages.

', 'ListRepositoriesInDomainRequest$domain' => '

The name of the domain that contains the returned list of repositories.

', 'ListSubPackageGroupsRequest$domain' => '

The name of the domain which contains the package group from which to list sub package groups.

', 'PackageGroupDescription$domainName' => '

The name of the domain that contains the package group.

', 'PackageGroupSummary$domainName' => '

The domain that contains the package group.

', 'PublishPackageVersionRequest$domain' => '

The name of the domain that contains the repository that contains the package version to publish.

', 'PutDomainPermissionsPolicyRequest$domain' => '

The name of the domain on which to set the resource policy.

', 'PutPackageOriginConfigurationRequest$domain' => '

The name of the domain that contains the repository that contains the package.

', 'PutRepositoryPermissionsPolicyRequest$domain' => '

The name of the domain containing the repository to set the resource policy on.

', 'RepositoryDescription$domainName' => '

The name of the domain that contains the repository.

', 'RepositorySummary$domainName' => '

The name of the domain that contains the repository.

', 'UpdatePackageGroupOriginConfigurationRequest$domain' => '

The name of the domain which contains the package group for which to update the origin configuration.

', 'UpdatePackageGroupRequest$domain' => '

The name of the domain which contains the package group to be updated.

', 'UpdatePackageVersionsStatusRequest$domain' => '

The name of the domain that contains the repository that contains the package versions with a status to be updated.

', 'UpdateRepositoryRequest$domain' => '

The name of the domain associated with the repository to update.

', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$status' => '

The current status of a domain.

', 'DomainSummary$status' => '

A string that contains the status of the domain.

', ], ], 'DomainSummary' => [ 'base' => '

Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.

', 'refs' => [ 'DomainSummaryList$member' => NULL, ], ], 'DomainSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResult$domains' => '

The returned list of DomainSummary objects.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionError$errorMessage' => '

The error message associated with the error.

', ], ], 'ExternalConnectionName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$externalConnection' => '

The name of the external connection to add to the repository. The following values are supported:

', 'DisassociateExternalConnectionRequest$externalConnection' => '

The name of the external connection to be removed from the repository.

', 'DomainEntryPoint$externalConnectionName' => '

The name of the external connection that a package was ingested from.

', 'RepositoryExternalConnectionInfo$externalConnectionName' => '

The name of the external connection associated with a repository.

', ], ], 'ExternalConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'RepositoryExternalConnectionInfo$status' => '

The status of the external connection of a repository. There is one valid value, Available.

', ], ], 'GetAssociatedPackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAssociatedPackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'GetAuthorizationTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAuthorizationTokenResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionAssetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionAssetResult' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionReadmeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPackageVersionReadmeResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryEndpointResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'HashAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AssetHashes$key' => NULL, ], ], 'HashValue' => [ 'base' => NULL, 'refs' => [ 'AssetHashes$value' => NULL, ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$repositoryCount' => '

The number of repositories in the domain.

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

The operation did not succeed because of an error that occurred inside CodeArtifact.

', 'refs' => [], ], 'LicenseInfo' => [ 'base' => '

Details of the license data.

', 'refs' => [ 'LicenseInfoList$member' => NULL, ], ], 'LicenseInfoList' => [ 'base' => NULL, 'refs' => [ 'PackageVersionDescription$licenses' => '

Information about licenses associated with the package version.

', ], ], 'ListAllowedRepositoriesForGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListAllowedRepositoriesForGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAllowedRepositoriesForGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociatedPackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociatedPackagesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDomainsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageGroupsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageGroupsRequest$maxResults' => '

The maximum number of results to return per page.

', 'ListSubPackageGroupsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionAssetsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionAssetsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackageVersionAssetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionAssetsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionDependenciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionDependenciesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAssociatedPackagesRequest$maxResults' => '

The maximum number of results to return per page.

', 'ListPackagesRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListPackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesInDomainMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesInDomainRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListRepositoriesInDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesInDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesRequest$maxResults' => '

The maximum number of results to return per page.

', ], ], 'ListRepositoriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListSubPackageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubPackageGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$assetSizeBytes' => '

The total size of all assets in the domain.

', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$size' => '

The size of the asset.

', 'PackageGroupOriginRestriction$repositoriesCount' => '

The number of repositories in the allowed repository list.

', ], ], 'OriginRestrictions' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageGroupOriginConfigurationRequest$restrictions' => '

The origin configuration settings that determine how package versions can enter repositories.

', ], ], 'PackageDependency' => [ 'base' => '

Details about a package dependency.

', 'refs' => [ 'PackageDependencyList$member' => NULL, ], ], 'PackageDependencyList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionDependenciesResult$dependencies' => '

The returned list of PackageDependency objects.

', ], ], 'PackageDescription' => [ 'base' => '

Details about a package.

', 'refs' => [ 'DescribePackageResult$package' => '

A PackageDescription object that contains information about the requested package.

', ], ], 'PackageFormat' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$format' => '

A format that specifies the type of the associated package.

', 'CopyPackageVersionsRequest$format' => '

The format of the package versions to be copied.

', 'DeletePackageRequest$format' => '

The format of the requested package to delete.

', 'DeletePackageVersionsRequest$format' => '

The format of the package versions to delete.

', 'DescribePackageRequest$format' => '

A format that specifies the type of the requested package.

', 'DescribePackageVersionRequest$format' => '

A format that specifies the type of the requested package version.

', 'DisposePackageVersionsRequest$format' => '

A format that specifies the type of package versions you want to dispose.

', 'GetAssociatedPackageGroupRequest$format' => '

The format of the package from which to get the associated package group.

', 'GetPackageVersionAssetRequest$format' => '

A format that specifies the type of the package version with the requested asset file.

', 'GetPackageVersionReadmeRequest$format' => '

A format that specifies the type of the package version with the requested readme file.

', 'GetPackageVersionReadmeResult$format' => '

The format of the package with the requested readme file.

', 'GetRepositoryEndpointRequest$format' => '

Returns which endpoint of a repository to return. A repository has one endpoint for each package format.

', 'ListPackageVersionAssetsRequest$format' => '

The format of the package that contains the requested package version assets.

', 'ListPackageVersionAssetsResult$format' => '

The format of the package that contains the requested package version assets.

', 'ListPackageVersionDependenciesRequest$format' => '

The format of the package with the requested dependencies.

', 'ListPackageVersionDependenciesResult$format' => '

A format that specifies the type of the package that contains the returned dependencies.

', 'ListPackageVersionsRequest$format' => '

The format of the package versions you want to list.

', 'ListPackageVersionsResult$format' => '

A format of the package.

', 'ListPackagesRequest$format' => '

The format used to filter requested packages. Only packages from the provided format will be returned.

', 'PackageDescription$format' => '

A format that specifies the type of the package.

', 'PackageSummary$format' => '

The format of the package.

', 'PackageVersionDescription$format' => '

The format of the package version.

', 'PublishPackageVersionRequest$format' => '

A format that specifies the type of the package version with the requested asset file.

The only supported value is generic.

', 'PublishPackageVersionResult$format' => '

The format of the package version.

', 'PutPackageOriginConfigurationRequest$format' => '

A format that specifies the type of the package to be updated.

', 'RepositoryExternalConnectionInfo$packageFormat' => '

The package format associated with a repository\'s external connection. The valid package formats are:

', 'UpdatePackageVersionsStatusRequest$format' => '

A format that specifies the type of the package with the statuses to update.

', ], ], 'PackageGroupAllowedRepository' => [ 'base' => '

Details about an allowed repository for a package group, including its name and origin configuration.

', 'refs' => [ 'PackageGroupAllowedRepositoryList$member' => NULL, ], ], 'PackageGroupAllowedRepositoryList' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageGroupOriginConfigurationRequest$addAllowedRepositories' => '

The repository name and restrictions to add to the allowed repository list of the specified package group.

', 'UpdatePackageGroupOriginConfigurationRequest$removeAllowedRepositories' => '

The repository name and restrictions to remove from the allowed repository list of the specified package group.

', ], ], 'PackageGroupAllowedRepositoryUpdate' => [ 'base' => NULL, 'refs' => [ 'PackageGroupAllowedRepositoryUpdates$value' => NULL, ], ], 'PackageGroupAllowedRepositoryUpdateType' => [ 'base' => NULL, 'refs' => [ 'PackageGroupAllowedRepositoryUpdate$key' => NULL, ], ], 'PackageGroupAllowedRepositoryUpdates' => [ 'base' => NULL, 'refs' => [ 'UpdatePackageGroupOriginConfigurationResult$allowedRepositoryUpdates' => '

Information about the updated allowed repositories after processing the request.

', ], ], 'PackageGroupAssociationType' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$associationType' => '

Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

', 'GetAssociatedPackageGroupResult$associationType' => '

Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.

', ], ], 'PackageGroupContactInfo' => [ 'base' => NULL, 'refs' => [ 'CreatePackageGroupRequest$contactInfo' => '

The contact information for the created package group.

', 'PackageGroupDescription$contactInfo' => '

The contact information of the package group.

', 'PackageGroupSummary$contactInfo' => '

The contact information of the package group.

', 'UpdatePackageGroupRequest$contactInfo' => '

Contact information which you want to update the requested package group with.

', ], ], 'PackageGroupDescription' => [ 'base' => '

The description of the package group.

', 'refs' => [ 'CreatePackageGroupResult$packageGroup' => '

Information about the created package group after processing the request.

', 'DeletePackageGroupResult$packageGroup' => '

Information about the deleted package group after processing the request.

', 'DescribePackageGroupResult$packageGroup' => '

A PackageGroupDescription object that contains information about the requested package group.

', 'GetAssociatedPackageGroupResult$packageGroup' => '

The package group that is associated with the requested package.

', 'UpdatePackageGroupOriginConfigurationResult$packageGroup' => '

The package group and information about it after processing the request.

', 'UpdatePackageGroupResult$packageGroup' => '

The package group and information about it after the request has been processed.

', ], ], 'PackageGroupOriginConfiguration' => [ 'base' => '

The package group origin configuration that determines how package versions can enter repositories.

', 'refs' => [ 'PackageGroupDescription$originConfiguration' => '

The package group origin configuration that determines how package versions can enter repositories.

', 'PackageGroupSummary$originConfiguration' => '

Details about the package origin configuration of a package group.

', ], ], 'PackageGroupOriginRestriction' => [ 'base' => '

Contains information about the configured restrictions of the origin controls of a package group.

', 'refs' => [ 'PackageGroupOriginRestrictions$value' => NULL, ], ], 'PackageGroupOriginRestrictionMode' => [ 'base' => NULL, 'refs' => [ 'OriginRestrictions$value' => NULL, 'PackageGroupOriginRestriction$mode' => '

The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

', 'PackageGroupOriginRestriction$effectiveMode' => '

The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

', ], ], 'PackageGroupOriginRestrictionType' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupRequest$originRestrictionType' => '

The origin configuration restriction type of which to list allowed repositories.

', 'OriginRestrictions$key' => NULL, 'PackageGroupAllowedRepository$originRestrictionType' => '

The origin configuration restriction type of the allowed repository.

', 'PackageGroupAllowedRepositoryUpdates$key' => NULL, 'PackageGroupOriginRestrictions$key' => NULL, ], ], 'PackageGroupOriginRestrictions' => [ 'base' => NULL, 'refs' => [ 'PackageGroupOriginConfiguration$restrictions' => '

The origin configuration settings that determine how package versions can enter repositories.

', ], ], 'PackageGroupPattern' => [ 'base' => NULL, 'refs' => [ 'CreatePackageGroupRequest$packageGroup' => '

The pattern of the package group to create. The pattern is also the identifier of the package group.

', 'DescribePackageGroupRequest$packageGroup' => '

The pattern of the requested package group.

', 'ListAllowedRepositoriesForGroupRequest$packageGroup' => '

The pattern of the package group from which to list allowed repositories.

', 'ListAssociatedPackagesRequest$packageGroup' => '

The pattern of the package group from which to list associated packages.

', 'ListSubPackageGroupsRequest$packageGroup' => '

The pattern of the package group from which to list sub package groups.

', 'PackageGroupDescription$pattern' => '

The pattern of the package group. The pattern determines which packages are associated with the package group.

', 'PackageGroupReference$pattern' => '

The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

', 'PackageGroupSummary$pattern' => '

The pattern of the package group. The pattern determines which packages are associated with the package group.

', 'UpdatePackageGroupOriginConfigurationRequest$packageGroup' => '

The pattern of the package group for which to update the origin configuration.

', 'UpdatePackageGroupRequest$packageGroup' => '

The pattern of the package group to be updated.

', ], ], 'PackageGroupPatternPrefix' => [ 'base' => NULL, 'refs' => [ 'ListPackageGroupsRequest$prefix' => '

A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.

', ], ], 'PackageGroupReference' => [ 'base' => '

Information about the identifiers of a package group.

', 'refs' => [ 'PackageGroupDescription$parent' => '

The direct parent package group of the package group.

', 'PackageGroupOriginRestriction$inheritedFrom' => '

The parent package group that the package group origin restrictions are inherited from.

', 'PackageGroupSummary$parent' => '

The direct parent package group of the package group.

', ], ], 'PackageGroupSummary' => [ 'base' => '

Details about a package group.

', 'refs' => [ 'PackageGroupSummaryList$member' => NULL, ], ], 'PackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageGroupsResult$packageGroups' => '

The list of package groups in the requested domain.

', 'ListSubPackageGroupsResult$packageGroups' => '

A list of sub package groups for the requested package group.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$package' => '

The name of the associated package.

', 'CopyPackageVersionsRequest$package' => '

The name of the package that contains the versions to be copied.

', 'DeletePackageRequest$package' => '

The name of the package to delete.

', 'DeletePackageVersionsRequest$package' => '

The name of the package with the versions to delete.

', 'DescribePackageRequest$package' => '

The name of the requested package.

', 'DescribePackageVersionRequest$package' => '

The name of the requested package version.

', 'DisposePackageVersionsRequest$package' => '

The name of the package with the versions you want to dispose.

', 'GetAssociatedPackageGroupRequest$package' => '

The package from which to get the associated package group.

', 'GetPackageVersionAssetRequest$package' => '

The name of the package that contains the requested asset.

', 'GetPackageVersionReadmeRequest$package' => '

The name of the package version that contains the requested readme file.

', 'GetPackageVersionReadmeResult$package' => '

The name of the package that contains the returned readme file.

', 'ListPackageVersionAssetsRequest$package' => '

The name of the package that contains the requested package version assets.

', 'ListPackageVersionAssetsResult$package' => '

The name of the package that contains the requested package version assets.

', 'ListPackageVersionDependenciesRequest$package' => '

The name of the package versions\' package.

', 'ListPackageVersionDependenciesResult$package' => '

The name of the package that contains the returned package versions dependencies.

', 'ListPackageVersionsRequest$package' => '

The name of the package for which you want to request package versions.

', 'ListPackageVersionsResult$package' => '

The name of the package.

', 'ListPackagesRequest$packagePrefix' => '

A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.

', 'PackageDependency$package' => '

The name of the package that this package depends on.

', 'PackageDescription$name' => '

The name of the package.

', 'PackageSummary$package' => '

The name of the package.

', 'PackageVersionDescription$packageName' => '

The name of the requested package.

', 'PublishPackageVersionRequest$package' => '

The name of the package version to publish.

', 'PublishPackageVersionResult$package' => '

The name of the package.

', 'PutPackageOriginConfigurationRequest$package' => '

The name of the package to be updated.

', 'UpdatePackageVersionsStatusRequest$package' => '

The name of the package with the version statuses to update.

', ], ], 'PackageNamespace' => [ 'base' => NULL, 'refs' => [ 'AssociatedPackage$namespace' => '

The namespace of the associated package. The package component that specifies its namespace depends on its type. For example:

', 'CopyPackageVersionsRequest$namespace' => '

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

The namespace is required when copying package versions of the following formats:

 ', 'DeletePackageRequest$namespace' => '

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting packages of the following formats:

 ', 'DeletePackageVersionsRequest$namespace' => '

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ', 'DescribePackageRequest$namespace' => '

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting packages of the following formats:

 ', 'DescribePackageVersionRequest$namespace' => '

The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting package versions of the following formats:

 ', 'DisposePackageVersionsRequest$namespace' => '

The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:

The namespace is required when disposing package versions of the following formats:

 ', 'GetAssociatedPackageGroupRequest$namespace' => '

The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from packages of the following formats:

 ', 'GetPackageVersionAssetRequest$namespace' => '

The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting assets from package versions of the following formats:

 ', 'GetPackageVersionReadmeRequest$namespace' => '

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

 ', 'GetPackageVersionReadmeResult$namespace' => '

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

', 'ListPackageVersionAssetsRequest$namespace' => '

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

The namespace is required requesting assets from package versions of the following formats:

 ', 'ListPackageVersionAssetsResult$namespace' => '

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

', 'ListPackageVersionDependenciesRequest$namespace' => '

The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:

The namespace is required when listing dependencies from package versions of the following formats:

 ', 'ListPackageVersionDependenciesResult$namespace' => '

The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example:

', 'ListPackageVersionsRequest$namespace' => '

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

 ', 'ListPackageVersionsResult$namespace' => '

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

', 'ListPackagesRequest$namespace' => '

The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

Each package format uses namespace as follows:

', 'PackageDependency$namespace' => '

The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:

', 'PackageDescription$namespace' => '

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

', 'PackageSummary$namespace' => '

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

', 'PackageVersionDescription$namespace' => '

The namespace of the package version. The package component that specifies its namespace depends on its type. For example:

', 'PublishPackageVersionRequest$namespace' => '

The namespace of the package version to publish.

', 'PublishPackageVersionResult$namespace' => '

The namespace of the package version.

', 'PutPackageOriginConfigurationRequest$namespace' => '

The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:

', 'UpdatePackageVersionsStatusRequest$namespace' => '

The namespace of the package version to be updated. The package component that specifies its namespace depends on its type. For example:

', ], ], 'PackageOriginConfiguration' => [ 'base' => '

Details about the package origin configuration of a package.

', 'refs' => [ 'PackageDescription$originConfiguration' => '

The package origin configuration for the package.

', 'PackageSummary$originConfiguration' => '

A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.

', 'PutPackageOriginConfigurationResult$originConfiguration' => '

A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.

', ], ], 'PackageOriginRestrictions' => [ 'base' => '

Details about the origin restrictions set on the package. The package origin restrictions determine how new versions of a package can be added to a specific repository.

', 'refs' => [ 'PackageOriginConfiguration$restrictions' => '

A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

', 'PutPackageOriginConfigurationRequest$restrictions' => '

A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.

You must include both the desired upstream and publish restrictions.

', ], ], 'PackageSummary' => [ 'base' => '

Details about a package, including its format, namespace, and name.

', 'refs' => [ 'DeletePackageResult$deletedPackage' => NULL, 'PackageSummaryList$member' => NULL, ], ], 'PackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackagesResult$packages' => '

The list of returned PackageSummary objects.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DescribePackageVersionRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionAssetRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionAssetResult$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionReadmeRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'GetPackageVersionReadmeResult$version' => '

The version of the package with the requested readme file.

', 'ListPackageVersionAssetsRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'ListPackageVersionAssetsResult$version' => '

The version of the package associated with the requested assets.

', 'ListPackageVersionDependenciesRequest$packageVersion' => '

A string that contains the package version (for example, 3.5.2).

', 'ListPackageVersionDependenciesResult$version' => '

The version of the package that is specified in the request.

', 'ListPackageVersionsResult$defaultDisplayVersion' => '

The default package version to display. This depends on the package format:

', 'PackageVersionDescription$version' => '

The version of the package.

', 'PackageVersionErrorMap$key' => NULL, 'PackageVersionList$member' => NULL, 'PackageVersionRevisionMap$key' => NULL, 'PackageVersionSummary$version' => '

Information about a package version.

', 'PublishPackageVersionRequest$packageVersion' => '

The package version to publish (for example, 3.5.2).

', 'PublishPackageVersionResult$version' => '

The version of the package.

', 'SuccessfulPackageVersionInfoMap$key' => NULL, ], ], 'PackageVersionDescription' => [ 'base' => '

Details about a package version.

', 'refs' => [ 'DescribePackageVersionResult$packageVersion' => '

A PackageVersionDescription object that contains information about the requested package version.

', ], ], 'PackageVersionError' => [ 'base' => '

l An error associated with package.

', 'refs' => [ 'PackageVersionErrorMap$value' => NULL, ], ], 'PackageVersionErrorCode' => [ 'base' => NULL, 'refs' => [ 'PackageVersionError$errorCode' => '

The error code associated with the error. Valid error codes are:

', ], ], 'PackageVersionErrorMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsResult$failedVersions' => '

A map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They are:

', 'DeletePackageVersionsResult$failedVersions' => '

A PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are:

', 'DisposePackageVersionsResult$failedVersions' => '

A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:

', 'UpdatePackageVersionsStatusResult$failedVersions' => '

A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

', ], ], 'PackageVersionList' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$versions' => '

The versions of the package to be copied.

You must specify versions or versionRevisions. You cannot specify both.

', 'DeletePackageVersionsRequest$versions' => '

An array of strings that specify the versions of the package to delete.

', 'DisposePackageVersionsRequest$versions' => '

The versions of the package you want to dispose.

', 'UpdatePackageVersionsStatusRequest$versions' => '

An array of strings that specify the versions of the package with the statuses to update.

', ], ], 'PackageVersionOrigin' => [ 'base' => '

Information about how a package version was added to a repository.

', 'refs' => [ 'PackageVersionDescription$origin' => '

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

', 'PackageVersionSummary$origin' => '

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

', ], ], 'PackageVersionOriginType' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$originType' => '

The originType used to filter package versions. Only package versions with the provided originType will be returned.

', 'PackageVersionOrigin$originType' => '

Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection.

', ], ], 'PackageVersionRevision' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionAssetRequest$packageVersionRevision' => '

The name of the package version revision that contains the requested asset.

', 'GetPackageVersionAssetResult$packageVersionRevision' => '

The name of the package version revision that contains the downloaded asset.

', 'GetPackageVersionReadmeResult$versionRevision' => '

The current revision associated with the package version.

', 'ListPackageVersionAssetsResult$versionRevision' => '

The current revision associated with the package version.

', 'ListPackageVersionDependenciesResult$versionRevision' => '

The current revision associated with the package version.

', 'PackageVersionDescription$revision' => '

The revision of the package version.

', 'PackageVersionRevisionMap$value' => NULL, 'PackageVersionSummary$revision' => '

The revision associated with a package version.

', 'PublishPackageVersionResult$versionRevision' => '

The revision of the package version.

', ], ], 'PackageVersionRevisionMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$versionRevisions' => '

A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

You must specify versions or versionRevisions. You cannot specify both.

', 'DisposePackageVersionsRequest$versionRevisions' => '

The revisions of the package versions you want to dispose.

', 'UpdatePackageVersionsStatusRequest$versionRevisions' => '

A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.

', ], ], 'PackageVersionSortType' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$sortBy' => '

How to sort the requested list of package versions.

', ], ], 'PackageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DeletePackageVersionsRequest$expectedStatus' => '

The expected status of the package version to delete.

', 'DisposePackageVersionsRequest$expectedStatus' => '

The expected status of the package version to dispose.

', 'ListPackageVersionsRequest$status' => '

A string that filters the requested package versions by status.

', 'PackageVersionDescription$status' => '

A string that contains the status of the package version.

', 'PackageVersionSummary$status' => '

A string that contains the status of the package version. It can be one of the following:

', 'PublishPackageVersionResult$status' => '

A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.

', 'SuccessfulPackageVersionInfo$status' => '

The status of a package version.

', 'UpdatePackageVersionsStatusRequest$expectedStatus' => '

The package version’s expected status before it is updated. If expectedStatus is provided, the package version\'s status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

', 'UpdatePackageVersionsStatusRequest$targetStatus' => '

The status you want to change the package version status to.

', ], ], 'PackageVersionSummary' => [ 'base' => '

Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.

', 'refs' => [ 'PackageVersionSummaryList$member' => NULL, ], ], 'PackageVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsResult$versions' => '

The returned list of PackageVersionSummary objects.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListAllowedRepositoriesForGroupResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListAssociatedPackagesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListAssociatedPackagesResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListDomainsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListDomainsResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageGroupsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageGroupsResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionAssetsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionAssetsResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListPackageVersionDependenciesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionDependenciesResult$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackageVersionsResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListPackagesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListPackagesResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListRepositoriesInDomainRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListRepositoriesInDomainResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListRepositoriesRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListRepositoriesResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', 'ListSubPackageGroupsRequest$nextToken' => '

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

', 'ListSubPackageGroupsResult$nextToken' => '

If there are additional results, this is the token for the next set of results.

', ], ], 'PolicyDocument' => [ 'base' => NULL, 'refs' => [ 'PutDomainPermissionsPolicyRequest$policyDocument' => '

A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

', 'PutRepositoryPermissionsPolicyRequest$policyDocument' => '

A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.

', 'ResourcePolicy$document' => '

The resource policy formatted in JSON.

', ], ], 'PolicyRevision' => [ 'base' => NULL, 'refs' => [ 'DeleteDomainPermissionsPolicyRequest$policyRevision' => '

The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain\'s resource policy.

', 'DeleteRepositoryPermissionsPolicyRequest$policyRevision' => '

The revision of the repository\'s resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository\'s resource policy.

', 'PutDomainPermissionsPolicyRequest$policyRevision' => '

The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain\'s resource policy.

', 'PutRepositoryPermissionsPolicyRequest$policyRevision' => '

Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository\'s resource policy.

', 'ResourcePolicy$revision' => '

The current revision of the resource policy.

', ], ], 'PublishPackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PublishPackageVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'PutDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'PutPackageOriginConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPackageOriginConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'PutRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryDescription' => [ 'base' => '

The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per Amazon Web Services account.

', 'refs' => [ 'AssociateExternalConnectionResult$repository' => '

Information about the connected repository after processing the request.

', 'CreateRepositoryResult$repository' => '

Information about the created repository after processing the request.

', 'DeleteRepositoryResult$repository' => '

Information about the deleted repository after processing the request.

', 'DescribeRepositoryResult$repository' => '

A RepositoryDescription object that contains the requested repository information.

', 'DisassociateExternalConnectionResult$repository' => '

The repository associated with the removed external connection.

', 'UpdateRepositoryResult$repository' => '

The updated repository.

', ], ], 'RepositoryExternalConnectionInfo' => [ 'base' => '

Contains information about the external connection of a repository.

', 'refs' => [ 'RepositoryExternalConnectionInfoList$member' => NULL, ], ], 'RepositoryExternalConnectionInfoList' => [ 'base' => NULL, 'refs' => [ 'RepositoryDescription$externalConnections' => '

An array of external connections associated with the repository.

', ], ], 'RepositoryName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$repository' => '

The name of the repository to which the external connection is added.

', 'CopyPackageVersionsRequest$sourceRepository' => '

The name of the repository that contains the package versions to be copied.

', 'CopyPackageVersionsRequest$destinationRepository' => '

The name of the repository into which package versions are copied.

', 'CreateRepositoryRequest$repository' => '

The name of the repository to create.

', 'DeletePackageRequest$repository' => '

The name of the repository that contains the package to delete.

', 'DeletePackageVersionsRequest$repository' => '

The name of the repository that contains the package versions to delete.

', 'DeleteRepositoryPermissionsPolicyRequest$repository' => '

The name of the repository that is associated with the resource policy to be deleted

', 'DeleteRepositoryRequest$repository' => '

The name of the repository to delete.

', 'DescribePackageRequest$repository' => '

The name of the repository that contains the requested package.

', 'DescribePackageVersionRequest$repository' => '

The name of the repository that contains the package version.

', 'DescribeRepositoryRequest$repository' => '

A string that specifies the name of the requested repository.

', 'DisassociateExternalConnectionRequest$repository' => '

The name of the repository from which the external connection will be removed.

', 'DisposePackageVersionsRequest$repository' => '

The name of the repository that contains the package versions you want to dispose.

', 'DomainEntryPoint$repositoryName' => '

The name of the repository that a package was originally published to.

', 'GetPackageVersionAssetRequest$repository' => '

The repository that contains the package version with the requested asset.

', 'GetPackageVersionReadmeRequest$repository' => '

The repository that contains the package with the requested readme file.

', 'GetRepositoryEndpointRequest$repository' => '

The name of the repository.

', 'GetRepositoryPermissionsPolicyRequest$repository' => '

The name of the repository whose associated resource policy is to be retrieved.

', 'ListPackageVersionAssetsRequest$repository' => '

The name of the repository that contains the package that contains the requested package version assets.

', 'ListPackageVersionDependenciesRequest$repository' => '

The name of the repository that contains the requested package version.

', 'ListPackageVersionsRequest$repository' => '

The name of the repository that contains the requested package versions.

', 'ListPackagesRequest$repository' => '

The name of the repository that contains the requested packages.

', 'ListRepositoriesInDomainRequest$repositoryPrefix' => '

A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

', 'ListRepositoriesRequest$repositoryPrefix' => '

A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

', 'PackageGroupAllowedRepository$repositoryName' => '

The name of the allowed repository.

', 'PublishPackageVersionRequest$repository' => '

The name of the repository that the package version will be published to.

', 'PutPackageOriginConfigurationRequest$repository' => '

The name of the repository that contains the package.

', 'PutRepositoryPermissionsPolicyRequest$repository' => '

The name of the repository to set the resource policy on.

', 'RepositoryDescription$name' => '

The name of the repository.

', 'RepositoryNameList$member' => NULL, 'RepositorySummary$name' => '

The name of the repository.

', 'UpdatePackageVersionsStatusRequest$repository' => '

The repository that contains the package versions with the status you want to update.

', 'UpdateRepositoryRequest$repository' => '

The name of the repository to update.

', 'UpstreamRepository$repositoryName' => '

The name of an upstream repository.

', 'UpstreamRepositoryInfo$repositoryName' => '

The name of an upstream repository.

', ], ], 'RepositoryNameList' => [ 'base' => NULL, 'refs' => [ 'ListAllowedRepositoriesForGroupResult$allowedRepositories' => '

The list of allowed repositories for the package group and origin configuration restriction type.

', 'PackageGroupAllowedRepositoryUpdate$value' => NULL, ], ], 'RepositorySummary' => [ 'base' => '

Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.

', 'refs' => [ 'RepositorySummaryList$member' => NULL, ], ], 'RepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesInDomainResult$repositories' => '

The returned list of repositories.

', 'ListRepositoriesResult$repositories' => '

The returned list of RepositorySummary objects.

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

The operation did not succeed because the resource requested is not found in the service.

', 'refs' => [], ], 'ResourcePolicy' => [ 'base' => '

An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.

', 'refs' => [ 'DeleteDomainPermissionsPolicyResult$policy' => '

Information about the deleted resource policy after processing the request.

', 'DeleteRepositoryPermissionsPolicyResult$policy' => '

Information about the deleted policy after processing the request.

', 'GetDomainPermissionsPolicyResult$policy' => '

The returned resource policy.

', 'GetRepositoryPermissionsPolicyResult$policy' => '

The returned resource policy.

', 'PutDomainPermissionsPolicyResult$policy' => '

The resource policy that was set after processing the request.

', 'PutRepositoryPermissionsPolicyResult$policy' => '

The resource policy that was set after processing the request.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceType' => '

The type of Amazon Web Services resource.

', 'ResourceNotFoundException$resourceType' => '

The type of Amazon Web Services resource.

', 'ServiceQuotaExceededException$resourceType' => '

The type of Amazon Web Services resource.

', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => '

The time period, in seconds, to wait before retrying the request.

', ], ], 'SHA256' => [ 'base' => NULL, 'refs' => [ 'PublishPackageVersionRequest$assetSHA256' => '

The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).

This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.

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

The operation did not succeed because it would have exceeded a service limit for your account.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'ConflictException$resourceId' => '

The ID of the resource.

', 'DeletePackageGroupRequest$packageGroup' => '

The pattern of the package group to be deleted.

', 'GetAuthorizationTokenResult$authorizationToken' => '

The returned authentication token.

', 'GetPackageVersionReadmeResult$readme' => '

The text of the returned readme file.

', 'GetRepositoryEndpointResult$repositoryEndpoint' => '

A string that specifies the URL of the returned endpoint.

', 'InternalServerException$message' => NULL, 'LicenseInfo$name' => '

Name of the license.

', 'LicenseInfo$url' => '

The URL for license data.

', 'PackageDependency$dependencyType' => '

The type of a package dependency. The possible values depend on the package type.

', 'PackageDependency$versionRequirement' => '

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

', 'PackageVersionDescription$summary' => '

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version\'s format.

', 'PackageVersionDescription$homePage' => '

The homepage associated with the package.

', 'PackageVersionDescription$sourceCodeRepository' => '

The repository for the source code in the package version, or the source code used to build it.

', 'ResourceNotFoundException$message' => NULL, 'ResourceNotFoundException$resourceId' => '

The ID of the resource.

', 'ServiceQuotaExceededException$message' => NULL, 'ServiceQuotaExceededException$resourceId' => '

The ID of the resource.

', 'SuccessfulPackageVersionInfo$revision' => '

The revision of a package version.

', 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'String255' => [ 'base' => NULL, 'refs' => [ 'PackageVersionDescription$displayName' => '

The name of the package that is displayed. The displayName varies depending on the package version\'s format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

', ], ], 'SuccessfulPackageVersionInfo' => [ 'base' => '

Contains the revision and status of a package version.

', 'refs' => [ 'SuccessfulPackageVersionInfoMap$value' => NULL, ], ], 'SuccessfulPackageVersionInfoMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsResult$successfulVersions' => '

A list of the package versions that were successfully copied to your repository.

', 'DeletePackageVersionsResult$successfulVersions' => '

A list of the package versions that were successfully deleted. The status of every successful version will be Deleted.

', 'DisposePackageVersionsResult$successfulVersions' => '

A list of the package versions that were successfully disposed.

', 'UpdatePackageVersionsStatusResult$successfulVersions' => '

A list of PackageVersionError objects, one for each package version with a status that failed to update.

', ], ], 'Tag' => [ 'base' => '

A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The tag key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The tag key for each tag that you want to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$tags' => '

One or more tag key-value pairs for the domain.

', 'CreatePackageGroupRequest$tags' => '

One or more tag key-value pairs for the package group.

', 'CreateRepositoryRequest$tags' => '

One or more tag key-value pairs for the repository.

', 'ListTagsForResourceResult$tags' => '

A list of tag key and value pairs associated with the specified resource.

', 'TagResourceRequest$tags' => '

The tags you want to modify or add to the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The tag value.

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

The operation did not succeed because too many requests are sent to the service.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$createdTime' => '

A timestamp that represents the date and time the domain was created.

', 'DomainSummary$createdTime' => '

A timestamp that contains the date and time the domain was created.

', 'GetAuthorizationTokenResult$expiration' => '

A timestamp that specifies the date and time the authorization token expires.

', 'PackageGroupDescription$createdTime' => '

A timestamp that represents the date and time the package group was created.

', 'PackageGroupSummary$createdTime' => '

A timestamp that represents the date and time the repository was created.

', 'PackageVersionDescription$publishedTime' => '

A timestamp that contains the date and time the package version was published.

', 'RepositoryDescription$createdTime' => '

A timestamp that represents the date and time the repository was created.

', 'RepositorySummary$createdTime' => '

A timestamp that represents the date and time the repository was created.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupOriginConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupOriginConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionsStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionsStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpstreamRepository' => [ 'base' => '

Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.

', 'refs' => [ 'UpstreamRepositoryList$member' => NULL, ], ], 'UpstreamRepositoryInfo' => [ 'base' => '

Information about an upstream repository.

', 'refs' => [ 'UpstreamRepositoryInfoList$member' => NULL, ], ], 'UpstreamRepositoryInfoList' => [ 'base' => NULL, 'refs' => [ 'RepositoryDescription$upstreams' => '

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

', ], ], 'UpstreamRepositoryList' => [ 'base' => NULL, 'refs' => [ 'CreateRepositoryRequest$upstreams' => '

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

', 'UpdateRepositoryRequest$upstreams' => '

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

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

The operation did not succeed because a parameter in the request was sent with an invalid value.

', 'refs' => [], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '

', ], ], ],]; diff --git a/src/data/fms/2018-01-01/api-2.json b/src/data/fms/2018-01-01/api-2.json index a65f6ae9aa..4f729cccb4 100644 --- a/src/data/fms/2018-01-01/api-2.json +++ b/src/data/fms/2018-01-01/api-2.json @@ -2610,7 +2610,8 @@ "StatefulEngineOptions":{ "type":"structure", "members":{ - "RuleOrder":{"shape":"RuleOrder"} + "RuleOrder":{"shape":"RuleOrder"}, + "StreamExceptionPolicy":{"shape":"StreamExceptionPolicy"} } }, "StatefulRuleGroup":{ @@ -2643,6 +2644,15 @@ "max":65535, "min":1 }, + "StreamExceptionPolicy":{ + "type":"string", + "enum":[ + "DROP", + "CONTINUE", + "REJECT", + "FMS_IGNORE" + ] + }, "Tag":{ "type":"structure", "required":[ diff --git a/src/data/fms/2018-01-01/api-2.json.php b/src/data/fms/2018-01-01/api-2.json.php index a69c6fa0c2..ff262fccff 100644 --- a/src/data/fms/2018-01-01/api-2.json.php +++ b/src/data/fms/2018-01-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-01-01', 'endpointPrefix' => 'fms', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'FMS', 'serviceFullName' => 'Firewall Management Service', 'serviceId' => 'FMS', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSFMS_20180101', 'uid' => 'fms-2018-01-01', ], 'operations' => [ 'AssociateAdminAccount' => [ 'name' => 'AssociateAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateAdminAccountRequest', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateThirdPartyFirewall' => [ 'name' => 'AssociateThirdPartyFirewall', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateThirdPartyFirewallRequest', ], 'output' => [ 'shape' => 'AssociateThirdPartyFirewallResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'BatchAssociateResource' => [ 'name' => 'BatchAssociateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchAssociateResourceRequest', ], 'output' => [ 'shape' => 'BatchAssociateResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'BatchDisassociateResource' => [ 'name' => 'BatchDisassociateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDisassociateResourceRequest', ], 'output' => [ 'shape' => 'BatchDisassociateResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeleteAppsList' => [ 'name' => 'DeleteAppsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppsListRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteNotificationChannel' => [ 'name' => 'DeleteNotificationChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotificationChannelRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeletePolicy' => [ 'name' => 'DeletePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePolicyRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'DeleteProtocolsList' => [ 'name' => 'DeleteProtocolsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProtocolsListRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteResourceSet' => [ 'name' => 'DeleteResourceSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceSetRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], ], ], 'DisassociateAdminAccount' => [ 'name' => 'DisassociateAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateAdminAccountRequest', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DisassociateThirdPartyFirewall' => [ 'name' => 'DisassociateThirdPartyFirewall', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateThirdPartyFirewallRequest', ], 'output' => [ 'shape' => 'DisassociateThirdPartyFirewallResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetAdminAccount' => [ 'name' => 'GetAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAdminAccountRequest', ], 'output' => [ 'shape' => 'GetAdminAccountResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetAdminScope' => [ 'name' => 'GetAdminScope', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAdminScopeRequest', ], 'output' => [ 'shape' => 'GetAdminScopeResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'GetAppsList' => [ 'name' => 'GetAppsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAppsListRequest', ], 'output' => [ 'shape' => 'GetAppsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetComplianceDetail' => [ 'name' => 'GetComplianceDetail', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceDetailRequest', ], 'output' => [ 'shape' => 'GetComplianceDetailResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidOperationException', ], ], ], 'GetNotificationChannel' => [ 'name' => 'GetNotificationChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetNotificationChannelRequest', ], 'output' => [ 'shape' => 'GetNotificationChannelResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidTypeException', ], ], ], 'GetProtectionStatus' => [ 'name' => 'GetProtectionStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProtectionStatusRequest', ], 'output' => [ 'shape' => 'GetProtectionStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetProtocolsList' => [ 'name' => 'GetProtocolsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProtocolsListRequest', ], 'output' => [ 'shape' => 'GetProtocolsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetResourceSet' => [ 'name' => 'GetResourceSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourceSetRequest', ], 'output' => [ 'shape' => 'GetResourceSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetThirdPartyFirewallAssociationStatus' => [ 'name' => 'GetThirdPartyFirewallAssociationStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetThirdPartyFirewallAssociationStatusRequest', ], 'output' => [ 'shape' => 'GetThirdPartyFirewallAssociationStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetViolationDetails' => [ 'name' => 'GetViolationDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetViolationDetailsRequest', ], 'output' => [ 'shape' => 'GetViolationDetailsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListAdminAccountsForOrganization' => [ 'name' => 'ListAdminAccountsForOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAdminAccountsForOrganizationRequest', ], 'output' => [ 'shape' => 'ListAdminAccountsForOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'ListAdminsManagingAccount' => [ 'name' => 'ListAdminsManagingAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAdminsManagingAccountRequest', ], 'output' => [ 'shape' => 'ListAdminsManagingAccountResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListAppsLists' => [ 'name' => 'ListAppsLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsListsRequest', ], 'output' => [ 'shape' => 'ListAppsListsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListComplianceStatus' => [ 'name' => 'ListComplianceStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListComplianceStatusRequest', ], 'output' => [ 'shape' => 'ListComplianceStatusResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListDiscoveredResources' => [ 'name' => 'ListDiscoveredResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDiscoveredResourcesRequest', ], 'output' => [ 'shape' => 'ListDiscoveredResourcesResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListMemberAccounts' => [ 'name' => 'ListMemberAccounts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMemberAccountsRequest', ], 'output' => [ 'shape' => 'ListMemberAccountsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListPolicies' => [ 'name' => 'ListPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPoliciesRequest', ], 'output' => [ 'shape' => 'ListPoliciesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListProtocolsLists' => [ 'name' => 'ListProtocolsLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProtocolsListsRequest', ], 'output' => [ 'shape' => 'ListProtocolsListsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListResourceSetResources' => [ 'name' => 'ListResourceSetResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceSetResourcesRequest', ], 'output' => [ 'shape' => 'ListResourceSetResourcesResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListResourceSets' => [ 'name' => 'ListResourceSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceSetsRequest', ], 'output' => [ 'shape' => 'ListResourceSetsResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], ], ], 'ListThirdPartyFirewallFirewallPolicies' => [ 'name' => 'ListThirdPartyFirewallFirewallPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListThirdPartyFirewallFirewallPoliciesRequest', ], 'output' => [ 'shape' => 'ListThirdPartyFirewallFirewallPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutAdminAccount' => [ 'name' => 'PutAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAdminAccountRequest', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'PutAppsList' => [ 'name' => 'PutAppsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAppsListRequest', ], 'output' => [ 'shape' => 'PutAppsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutNotificationChannel' => [ 'name' => 'PutNotificationChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutNotificationChannelRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutPolicy' => [ 'name' => 'PutPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutPolicyRequest', ], 'output' => [ 'shape' => 'PutPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidTypeException', ], ], ], 'PutProtocolsList' => [ 'name' => 'PutProtocolsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutProtocolsListRequest', ], 'output' => [ 'shape' => 'PutProtocolsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutResourceSet' => [ 'name' => 'PutResourceSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResourceSetRequest', ], 'output' => [ 'shape' => 'PutResourceSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], ], ], ], 'shapes' => [ 'AWSAccountId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9]+$', ], 'AWSAccountIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSAccountId', ], ], 'AWSRegion' => [ 'type' => 'string', 'max' => 32, 'min' => 6, 'pattern' => '^(af|ap|ca|eu|il|me|mx|sa|us|cn|us-gov)-\\w+-\\d+$', ], 'AWSRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSRegion', ], 'max' => 64, 'min' => 0, ], 'AccountIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSAccountId', ], ], 'AccountRoleStatus' => [ 'type' => 'string', 'enum' => [ 'READY', 'CREATING', 'PENDING_DELETION', 'DELETING', 'DELETED', ], ], 'AccountScope' => [ 'type' => 'structure', 'members' => [ 'Accounts' => [ 'shape' => 'AccountIdList', ], 'AllAccountsEnabled' => [ 'shape' => 'Boolean', ], 'ExcludeSpecifiedAccounts' => [ 'shape' => 'Boolean', ], ], ], 'ActionTarget' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Description' => [ 'shape' => 'LengthBoundedString', ], ], ], 'AdminAccountSummary' => [ 'type' => 'structure', 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], 'DefaultAdmin' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'OrganizationStatus', ], ], ], 'AdminAccountSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdminAccountSummary', ], ], 'AdminScope' => [ 'type' => 'structure', 'members' => [ 'AccountScope' => [ 'shape' => 'AccountScope', ], 'OrganizationalUnitScope' => [ 'shape' => 'OrganizationalUnitScope', ], 'RegionScope' => [ 'shape' => 'RegionScope', ], 'PolicyTypeScope' => [ 'shape' => 'PolicyTypeScope', ], ], ], 'App' => [ 'type' => 'structure', 'required' => [ 'AppName', 'Protocol', 'Port', ], 'members' => [ 'AppName' => [ 'shape' => 'ResourceName', ], 'Protocol' => [ 'shape' => 'Protocol', ], 'Port' => [ 'shape' => 'IPPortNumber', ], ], ], 'AppsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'App', ], ], 'AppsListData' => [ 'type' => 'structure', 'required' => [ 'ListName', 'AppsList', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'ListUpdateToken' => [ 'shape' => 'UpdateToken', ], 'CreateTime' => [ 'shape' => 'TimeStamp', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'AppsList' => [ 'shape' => 'AppsList', ], 'PreviousAppsList' => [ 'shape' => 'PreviousAppsList', ], ], ], 'AppsListDataSummary' => [ 'type' => 'structure', 'members' => [ 'ListArn' => [ 'shape' => 'ResourceArn', ], 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'AppsList' => [ 'shape' => 'AppsList', ], ], ], 'AppsListsData' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppsListDataSummary', ], ], 'AssociateAdminAccountRequest' => [ 'type' => 'structure', 'required' => [ 'AdminAccount', ], 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], ], ], 'AssociateThirdPartyFirewallRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], ], ], 'AssociateThirdPartyFirewallResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallStatus' => [ 'shape' => 'ThirdPartyFirewallAssociationStatus', ], ], ], 'AwsEc2InstanceViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'AwsEc2NetworkInterfaceViolations' => [ 'shape' => 'AwsEc2NetworkInterfaceViolations', ], ], ], 'AwsEc2NetworkInterfaceViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolatingSecurityGroups' => [ 'shape' => 'ResourceIdList', ], ], ], 'AwsEc2NetworkInterfaceViolations' => [ 'type' => 'list', 'member' => [ 'shape' => 'AwsEc2NetworkInterfaceViolation', ], ], 'AwsVPCSecurityGroupViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], 'PartialMatches' => [ 'shape' => 'PartialMatches', ], 'PossibleSecurityGroupRemediationActions' => [ 'shape' => 'SecurityGroupRemediationActions', ], ], ], 'Base62Id' => [ 'type' => 'string', 'max' => 22, 'min' => 22, 'pattern' => '^[a-z0-9A-Z]{22}$', ], 'BasicInteger' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => -2147483648, ], 'BatchAssociateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'Items', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'Items' => [ 'shape' => 'IdentifierList', ], ], ], 'BatchAssociateResourceResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'FailedItems', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'FailedItems' => [ 'shape' => 'FailedItemList', ], ], ], 'BatchDisassociateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'Items', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'Items' => [ 'shape' => 'IdentifierList', ], ], ], 'BatchDisassociateResourceResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'FailedItems', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'FailedItems' => [ 'shape' => 'FailedItemList', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'CIDR' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[a-f0-9:./]+', ], 'ComplianceViolator' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ViolationReason' => [ 'shape' => 'ViolationReason', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'Metadata' => [ 'shape' => 'ComplianceViolatorMetadata', ], ], ], 'ComplianceViolatorMetadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'LengthBoundedString', ], 'value' => [ 'shape' => 'LengthBoundedString', ], ], 'ComplianceViolators' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceViolator', ], ], 'CreateNetworkAclAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'Vpc' => [ 'shape' => 'ActionTarget', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'CreateNetworkAclEntriesAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'NetworkAclId' => [ 'shape' => 'ActionTarget', ], 'NetworkAclEntriesToBeCreated' => [ 'shape' => 'EntriesDescription', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'CustomerPolicyScopeId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'CustomerPolicyScopeIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerPolicyScopeId', ], ], 'CustomerPolicyScopeIdType' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'ORG_UNIT', ], ], 'CustomerPolicyScopeMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerPolicyScopeIdType', ], 'value' => [ 'shape' => 'CustomerPolicyScopeIdList', ], ], 'CustomerPolicyStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'OUT_OF_ADMIN_SCOPE', ], ], 'DeleteAppsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], ], ], 'DeleteNetworkAclEntriesAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'NetworkAclId' => [ 'shape' => 'ActionTarget', ], 'NetworkAclEntriesToBeDeleted' => [ 'shape' => 'EntriesDescription', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'DeleteNotificationChannelRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeletePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'DeleteAllPolicyResources' => [ 'shape' => 'Boolean', ], ], ], 'DeleteProtocolsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], ], ], 'DeleteResourceSetRequest' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'Base62Id', ], ], ], 'DependentServiceName' => [ 'type' => 'string', 'enum' => [ 'AWSCONFIG', 'AWSWAF', 'AWSSHIELD_ADVANCED', 'AWSVPC', ], ], 'Description' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'DestinationType' => [ 'type' => 'string', 'enum' => [ 'IPV4', 'IPV6', 'PREFIX_LIST', ], ], 'DetailedInfo' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=,+\\-@]*)$', ], 'DisassociateAdminAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateThirdPartyFirewallRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], ], ], 'DisassociateThirdPartyFirewallResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallStatus' => [ 'shape' => 'ThirdPartyFirewallAssociationStatus', ], ], ], 'DiscoveredResource' => [ 'type' => 'structure', 'members' => [ 'URI' => [ 'shape' => 'Identifier', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], 'Type' => [ 'shape' => 'ResourceType', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'DiscoveredResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiscoveredResource', ], ], 'DnsDuplicateRuleGroupViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], ], ], 'DnsRuleGroupLimitExceededViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], 'NumberOfRuleGroupsAlreadyAssociated' => [ 'shape' => 'BasicInteger', ], ], ], 'DnsRuleGroupPriorities' => [ 'type' => 'list', 'member' => [ 'shape' => 'DnsRuleGroupPriority', ], ], 'DnsRuleGroupPriority' => [ 'type' => 'integer', 'max' => 10000, 'min' => 0, ], 'DnsRuleGroupPriorityConflictViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], 'ConflictingPriority' => [ 'shape' => 'DnsRuleGroupPriority', ], 'ConflictingPolicyId' => [ 'shape' => 'PolicyId', ], 'UnavailablePriorities' => [ 'shape' => 'DnsRuleGroupPriorities', ], ], ], 'EC2AssociateRouteTableAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], 'SubnetId' => [ 'shape' => 'ActionTarget', ], 'GatewayId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2CopyRouteTableAction' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'VpcId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2CreateRouteAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'DestinationCidrBlock' => [ 'shape' => 'CIDR', ], 'DestinationPrefixListId' => [ 'shape' => 'ResourceId', ], 'DestinationIpv6CidrBlock' => [ 'shape' => 'CIDR', ], 'VpcEndpointId' => [ 'shape' => 'ActionTarget', ], 'GatewayId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2CreateRouteTableAction' => [ 'type' => 'structure', 'required' => [ 'VpcId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'VpcId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2DeleteRouteAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'DestinationCidrBlock' => [ 'shape' => 'CIDR', ], 'DestinationPrefixListId' => [ 'shape' => 'ResourceId', ], 'DestinationIpv6CidrBlock' => [ 'shape' => 'CIDR', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2ReplaceRouteAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'DestinationCidrBlock' => [ 'shape' => 'CIDR', ], 'DestinationPrefixListId' => [ 'shape' => 'ResourceId', ], 'DestinationIpv6CidrBlock' => [ 'shape' => 'CIDR', ], 'GatewayId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2ReplaceRouteTableAssociationAction' => [ 'type' => 'structure', 'required' => [ 'AssociationId', 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'AssociationId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EntriesDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryDescription', ], ], 'EntriesWithConflicts' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryDescription', ], ], 'EntryDescription' => [ 'type' => 'structure', 'members' => [ 'EntryDetail' => [ 'shape' => 'NetworkAclEntry', ], 'EntryRuleNumber' => [ 'shape' => 'IntegerObjectMinimum0', ], 'EntryType' => [ 'shape' => 'EntryType', ], ], ], 'EntryType' => [ 'type' => 'string', 'enum' => [ 'FMS_MANAGED_FIRST_ENTRY', 'FMS_MANAGED_LAST_ENTRY', 'CUSTOM_ENTRY', ], ], 'EntryViolation' => [ 'type' => 'structure', 'members' => [ 'ExpectedEntry' => [ 'shape' => 'EntryDescription', ], 'ExpectedEvaluationOrder' => [ 'shape' => 'LengthBoundedString', ], 'ActualEvaluationOrder' => [ 'shape' => 'LengthBoundedString', ], 'EntryAtExpectedEvaluationOrder' => [ 'shape' => 'EntryDescription', ], 'EntriesWithConflicts' => [ 'shape' => 'EntriesWithConflicts', ], 'EntryViolationReasons' => [ 'shape' => 'EntryViolationReasons', ], ], ], 'EntryViolationReason' => [ 'type' => 'string', 'enum' => [ 'MISSING_EXPECTED_ENTRY', 'INCORRECT_ENTRY_ORDER', 'ENTRY_CONFLICT', ], ], 'EntryViolationReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryViolationReason', ], ], 'EntryViolations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryViolation', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'EvaluationResult' => [ 'type' => 'structure', 'members' => [ 'ComplianceStatus' => [ 'shape' => 'PolicyComplianceStatusType', ], 'ViolatorCount' => [ 'shape' => 'ResourceCount', ], 'EvaluationLimitExceeded' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationResult', ], ], 'ExpectedRoute' => [ 'type' => 'structure', 'members' => [ 'IpV4Cidr' => [ 'shape' => 'CIDR', ], 'PrefixListId' => [ 'shape' => 'CIDR', ], 'IpV6Cidr' => [ 'shape' => 'CIDR', ], 'ContributingSubnets' => [ 'shape' => 'ResourceIdList', ], 'AllowedTargets' => [ 'shape' => 'LengthBoundedStringList', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], ], ], 'ExpectedRoutes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExpectedRoute', ], ], 'FMSPolicyUpdateFirewallCreationConfigAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'FirewallCreationConfig' => [ 'shape' => 'ManagedServiceData', ], ], ], 'FailedItem' => [ 'type' => 'structure', 'members' => [ 'URI' => [ 'shape' => 'Identifier', ], 'Reason' => [ 'shape' => 'FailedItemReason', ], ], ], 'FailedItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedItem', ], ], 'FailedItemReason' => [ 'type' => 'string', 'enum' => [ 'NOT_VALID_ARN', 'NOT_VALID_PARTITION', 'NOT_VALID_REGION', 'NOT_VALID_SERVICE', 'NOT_VALID_RESOURCE_TYPE', 'NOT_VALID_ACCOUNT_ID', ], ], 'FirewallDeploymentModel' => [ 'type' => 'string', 'enum' => [ 'CENTRALIZED', 'DISTRIBUTED', ], ], 'FirewallPolicyId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'FirewallPolicyName' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'FirewallSubnetIsOutOfScopeViolation' => [ 'type' => 'structure', 'members' => [ 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'SubnetAvailabilityZoneId' => [ 'shape' => 'LengthBoundedString', ], 'VpcEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'FirewallSubnetMissingVPCEndpointViolation' => [ 'type' => 'structure', 'members' => [ 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'SubnetAvailabilityZoneId' => [ 'shape' => 'LengthBoundedString', ], ], ], 'GetAdminAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetAdminAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], 'RoleStatus' => [ 'shape' => 'AccountRoleStatus', ], ], ], 'GetAdminScopeRequest' => [ 'type' => 'structure', 'required' => [ 'AdminAccount', ], 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], ], ], 'GetAdminScopeResponse' => [ 'type' => 'structure', 'members' => [ 'AdminScope' => [ 'shape' => 'AdminScope', ], 'Status' => [ 'shape' => 'OrganizationStatus', ], ], ], 'GetAppsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'DefaultList' => [ 'shape' => 'Boolean', ], ], ], 'GetAppsListResponse' => [ 'type' => 'structure', 'members' => [ 'AppsList' => [ 'shape' => 'AppsListData', ], 'AppsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetComplianceDetailRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', 'MemberAccount', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], ], ], 'GetComplianceDetailResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyComplianceDetail' => [ 'shape' => 'PolicyComplianceDetail', ], ], ], 'GetNotificationChannelRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetNotificationChannelResponse' => [ 'type' => 'structure', 'members' => [ 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'SnsRoleName' => [ 'shape' => 'ResourceArn', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], 'PolicyArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetProtectionStatusRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccountId' => [ 'shape' => 'AWSAccountId', ], 'StartTime' => [ 'shape' => 'TimeStamp', ], 'EndTime' => [ 'shape' => 'TimeStamp', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'GetProtectionStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccountId' => [ 'shape' => 'AWSAccountId', ], 'ServiceType' => [ 'shape' => 'SecurityServiceType', ], 'Data' => [ 'shape' => 'ProtectionData', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'GetProtocolsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'DefaultList' => [ 'shape' => 'Boolean', ], ], ], 'GetProtocolsListResponse' => [ 'type' => 'structure', 'members' => [ 'ProtocolsList' => [ 'shape' => 'ProtocolsListData', ], 'ProtocolsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetResourceSetRequest' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'Base62Id', ], ], ], 'GetResourceSetResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSet', 'ResourceSetArn', ], 'members' => [ 'ResourceSet' => [ 'shape' => 'ResourceSet', ], 'ResourceSetArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetThirdPartyFirewallAssociationStatusRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], ], ], 'GetThirdPartyFirewallAssociationStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallStatus' => [ 'shape' => 'ThirdPartyFirewallAssociationStatus', ], 'MarketplaceOnboardingStatus' => [ 'shape' => 'MarketplaceSubscriptionOnboardingStatus', ], ], ], 'GetViolationDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', 'MemberAccount', 'ResourceId', 'ResourceType', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], ], ], 'GetViolationDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'ViolationDetail' => [ 'shape' => 'ViolationDetail', ], ], ], 'IPPortNumber' => [ 'type' => 'long', 'max' => 65535, 'min' => 0, ], 'IPPortNumberInteger' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'Identifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'IdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Identifier', ], ], 'IntegerObject' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => -2147483648, ], 'IntegerObjectMinimum0' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => 0, ], 'InternalErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidNetworkAclEntriesViolation' => [ 'type' => 'structure', 'members' => [ 'Vpc' => [ 'shape' => 'ResourceId', ], 'Subnet' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'CurrentAssociatedNetworkAcl' => [ 'shape' => 'ResourceId', ], 'EntryViolations' => [ 'shape' => 'EntryViolations', ], ], ], 'InvalidOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'IssueInfoMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'DependentServiceName', ], 'value' => [ 'shape' => 'DetailedInfo', ], ], 'LengthBoundedNonEmptyString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'LengthBoundedString' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'LengthBoundedStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LengthBoundedString', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ListAdminAccountsForOrganizationRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListAdminAccountsForOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccounts' => [ 'shape' => 'AdminAccountSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListAdminsManagingAccountRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListAdminsManagingAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccounts' => [ 'shape' => 'AccountIdList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListAppsListsRequest' => [ 'type' => 'structure', 'required' => [ 'MaxResults', ], 'members' => [ 'DefaultLists' => [ 'shape' => 'Boolean', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListAppsListsResponse' => [ 'type' => 'structure', 'members' => [ 'AppsLists' => [ 'shape' => 'AppsListsData', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListComplianceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListComplianceStatusResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyComplianceStatusList' => [ 'shape' => 'PolicyComplianceStatusList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDiscoveredResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'MemberAccountIds', 'ResourceType', ], 'members' => [ 'MemberAccountIds' => [ 'shape' => 'AWSAccountIdList', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDiscoveredResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'Items' => [ 'shape' => 'DiscoveredResourceList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-z0-9A-Z-]{36}$', ], 'ListMemberAccountsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListMemberAccountsResponse' => [ 'type' => 'structure', 'members' => [ 'MemberAccounts' => [ 'shape' => 'MemberAccounts', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListPoliciesResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyList' => [ 'shape' => 'PolicySummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListProtocolsListsRequest' => [ 'type' => 'structure', 'required' => [ 'MaxResults', ], 'members' => [ 'DefaultLists' => [ 'shape' => 'Boolean', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListProtocolsListsResponse' => [ 'type' => 'structure', 'members' => [ 'ProtocolsLists' => [ 'shape' => 'ProtocolsListsData', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListResourceSetResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'ResourceId', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListResourceSetResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'Items', ], 'members' => [ 'Items' => [ 'shape' => 'ResourceList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListResourceSetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListResourceSetsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceSets' => [ 'shape' => 'ResourceSetSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'ListThirdPartyFirewallFirewallPoliciesRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', 'MaxResults', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListThirdPartyFirewallFirewallPoliciesResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallFirewallPolicies' => [ 'shape' => 'ThirdPartyFirewallFirewallPolicies', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ManagedServiceData' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, 'pattern' => '^((?!\\\\[nr]).)+', ], 'MarketplaceSubscriptionOnboardingStatus' => [ 'type' => 'string', 'enum' => [ 'NO_SUBSCRIPTION', 'NOT_COMPLETE', 'COMPLETE', ], ], 'MemberAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSAccountId', ], ], 'Name' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'NetworkAclCommonPolicy' => [ 'type' => 'structure', 'required' => [ 'NetworkAclEntrySet', ], 'members' => [ 'NetworkAclEntrySet' => [ 'shape' => 'NetworkAclEntrySet', ], ], ], 'NetworkAclEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkAclEntry', ], ], 'NetworkAclEntry' => [ 'type' => 'structure', 'required' => [ 'Protocol', 'RuleAction', 'Egress', ], 'members' => [ 'IcmpTypeCode' => [ 'shape' => 'NetworkAclIcmpTypeCode', ], 'Protocol' => [ 'shape' => 'LengthBoundedString', ], 'PortRange' => [ 'shape' => 'NetworkAclPortRange', ], 'CidrBlock' => [ 'shape' => 'LengthBoundedNonEmptyString', ], 'Ipv6CidrBlock' => [ 'shape' => 'LengthBoundedNonEmptyString', ], 'RuleAction' => [ 'shape' => 'NetworkAclRuleAction', ], 'Egress' => [ 'shape' => 'BooleanObject', ], ], ], 'NetworkAclEntrySet' => [ 'type' => 'structure', 'required' => [ 'ForceRemediateForFirstEntries', 'ForceRemediateForLastEntries', ], 'members' => [ 'FirstEntries' => [ 'shape' => 'NetworkAclEntries', ], 'ForceRemediateForFirstEntries' => [ 'shape' => 'BooleanObject', ], 'LastEntries' => [ 'shape' => 'NetworkAclEntries', ], 'ForceRemediateForLastEntries' => [ 'shape' => 'BooleanObject', ], ], ], 'NetworkAclIcmpTypeCode' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'IntegerObject', ], 'Type' => [ 'shape' => 'IntegerObject', ], ], ], 'NetworkAclPortRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'IPPortNumberInteger', ], 'To' => [ 'shape' => 'IPPortNumberInteger', ], ], ], 'NetworkAclRuleAction' => [ 'type' => 'string', 'enum' => [ 'allow', 'deny', ], ], 'NetworkFirewallAction' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]+$', ], 'NetworkFirewallActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkFirewallAction', ], ], 'NetworkFirewallBlackHoleRouteDetectedViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], ], ], 'NetworkFirewallInternetTrafficNotInspectedViolation' => [ 'type' => 'structure', 'members' => [ 'SubnetId' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'IsRouteTableUsedInDifferentAZ' => [ 'shape' => 'Boolean', ], 'CurrentFirewallSubnetRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallSubnetRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualFirewallSubnetRoutes' => [ 'shape' => 'Routes', ], 'InternetGatewayId' => [ 'shape' => 'ResourceId', ], 'CurrentInternetGatewayRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedInternetGatewayRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualInternetGatewayRoutes' => [ 'shape' => 'Routes', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallInvalidRouteConfigurationViolation' => [ 'type' => 'structure', 'members' => [ 'AffectedSubnets' => [ 'shape' => 'ResourceIdList', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'IsRouteTableUsedInDifferentAZ' => [ 'shape' => 'Boolean', ], 'ViolatingRoute' => [ 'shape' => 'Route', ], 'CurrentFirewallSubnetRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'ActualFirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ActualFirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallSubnetRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualFirewallSubnetRoutes' => [ 'shape' => 'Routes', ], 'InternetGatewayId' => [ 'shape' => 'ResourceId', ], 'CurrentInternetGatewayRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedInternetGatewayRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualInternetGatewayRoutes' => [ 'shape' => 'Routes', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'CurrentRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedRouteTable' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallMissingExpectedRoutesViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ExpectedRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallMissingFirewallViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'NetworkFirewallMissingSubnetViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'NetworkFirewallOverrideAction' => [ 'type' => 'string', 'enum' => [ 'DROP_TO_ALERT', ], ], 'NetworkFirewallPolicy' => [ 'type' => 'structure', 'members' => [ 'FirewallDeploymentModel' => [ 'shape' => 'FirewallDeploymentModel', ], ], ], 'NetworkFirewallPolicyDescription' => [ 'type' => 'structure', 'members' => [ 'StatelessRuleGroups' => [ 'shape' => 'StatelessRuleGroupList', ], 'StatelessDefaultActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatelessFragmentDefaultActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatelessCustomActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatefulRuleGroups' => [ 'shape' => 'StatefulRuleGroupList', ], 'StatefulDefaultActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatefulEngineOptions' => [ 'shape' => 'StatefulEngineOptions', ], ], ], 'NetworkFirewallPolicyModifiedViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'CurrentPolicyDescription' => [ 'shape' => 'NetworkFirewallPolicyDescription', ], 'ExpectedPolicyDescription' => [ 'shape' => 'NetworkFirewallPolicyDescription', ], ], ], 'NetworkFirewallResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'NetworkFirewallStatefulRuleGroupOverride' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'NetworkFirewallOverrideAction', ], ], ], 'NetworkFirewallUnexpectedFirewallRoutesViolation' => [ 'type' => 'structure', 'members' => [ 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'FirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallUnexpectedGatewayRoutesViolation' => [ 'type' => 'structure', 'members' => [ 'GatewayId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'OrderedRemediationActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationActionWithOrder', ], ], 'OrganizationStatus' => [ 'type' => 'string', 'enum' => [ 'ONBOARDING', 'ONBOARDING_COMPLETE', 'OFFBOARDING', 'OFFBOARDING_COMPLETE', ], ], 'OrganizationalUnitId' => [ 'type' => 'string', 'max' => 68, 'min' => 16, 'pattern' => '^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$', ], 'OrganizationalUnitIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationalUnitId', ], ], 'OrganizationalUnitScope' => [ 'type' => 'structure', 'members' => [ 'OrganizationalUnits' => [ 'shape' => 'OrganizationalUnitIdList', ], 'AllOrganizationalUnitsEnabled' => [ 'shape' => 'Boolean', ], 'ExcludeSpecifiedOrganizationalUnits' => [ 'shape' => 'Boolean', ], ], ], 'PaginationMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'PaginationToken' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'PartialMatch' => [ 'type' => 'structure', 'members' => [ 'Reference' => [ 'shape' => 'ReferenceRule', ], 'TargetViolationReasons' => [ 'shape' => 'TargetViolationReasons', ], ], ], 'PartialMatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'PartialMatch', ], ], 'Policy' => [ 'type' => 'structure', 'required' => [ 'PolicyName', 'SecurityServicePolicyData', 'ResourceType', 'ExcludeResourceTags', 'RemediationEnabled', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'PolicyName' => [ 'shape' => 'ResourceName', ], 'PolicyUpdateToken' => [ 'shape' => 'PolicyUpdateToken', ], 'SecurityServicePolicyData' => [ 'shape' => 'SecurityServicePolicyData', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceTypeList' => [ 'shape' => 'ResourceTypeList', ], 'ResourceTags' => [ 'shape' => 'ResourceTags', ], 'ExcludeResourceTags' => [ 'shape' => 'Boolean', ], 'RemediationEnabled' => [ 'shape' => 'Boolean', ], 'DeleteUnusedFMManagedResources' => [ 'shape' => 'Boolean', ], 'IncludeMap' => [ 'shape' => 'CustomerPolicyScopeMap', ], 'ExcludeMap' => [ 'shape' => 'CustomerPolicyScopeMap', ], 'ResourceSetIds' => [ 'shape' => 'ResourceSetIds', ], 'PolicyDescription' => [ 'shape' => 'ResourceDescription', ], 'PolicyStatus' => [ 'shape' => 'CustomerPolicyStatus', ], ], ], 'PolicyComplianceDetail' => [ 'type' => 'structure', 'members' => [ 'PolicyOwner' => [ 'shape' => 'AWSAccountId', ], 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'Violators' => [ 'shape' => 'ComplianceViolators', ], 'EvaluationLimitExceeded' => [ 'shape' => 'Boolean', ], 'ExpiredAt' => [ 'shape' => 'TimeStamp', ], 'IssueInfoMap' => [ 'shape' => 'IssueInfoMap', ], ], ], 'PolicyComplianceStatus' => [ 'type' => 'structure', 'members' => [ 'PolicyOwner' => [ 'shape' => 'AWSAccountId', ], 'PolicyId' => [ 'shape' => 'PolicyId', ], 'PolicyName' => [ 'shape' => 'ResourceName', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'EvaluationResults' => [ 'shape' => 'EvaluationResults', ], 'LastUpdated' => [ 'shape' => 'TimeStamp', ], 'IssueInfoMap' => [ 'shape' => 'IssueInfoMap', ], ], ], 'PolicyComplianceStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyComplianceStatus', ], ], 'PolicyComplianceStatusType' => [ 'type' => 'string', 'enum' => [ 'COMPLIANT', 'NON_COMPLIANT', ], ], 'PolicyId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-z0-9A-Z-]{36}$', ], 'PolicyOption' => [ 'type' => 'structure', 'members' => [ 'NetworkFirewallPolicy' => [ 'shape' => 'NetworkFirewallPolicy', ], 'ThirdPartyFirewallPolicy' => [ 'shape' => 'ThirdPartyFirewallPolicy', ], 'NetworkAclCommonPolicy' => [ 'shape' => 'NetworkAclCommonPolicy', ], ], ], 'PolicySummary' => [ 'type' => 'structure', 'members' => [ 'PolicyArn' => [ 'shape' => 'ResourceArn', ], 'PolicyId' => [ 'shape' => 'PolicyId', ], 'PolicyName' => [ 'shape' => 'ResourceName', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'SecurityServiceType' => [ 'shape' => 'SecurityServiceType', ], 'RemediationEnabled' => [ 'shape' => 'Boolean', ], 'DeleteUnusedFMManagedResources' => [ 'shape' => 'Boolean', ], 'PolicyStatus' => [ 'shape' => 'CustomerPolicyStatus', ], ], ], 'PolicySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicySummary', ], ], 'PolicyTypeScope' => [ 'type' => 'structure', 'members' => [ 'PolicyTypes' => [ 'shape' => 'SecurityServiceTypeList', ], 'AllPolicyTypesEnabled' => [ 'shape' => 'Boolean', ], ], ], 'PolicyUpdateToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'PossibleRemediationAction' => [ 'type' => 'structure', 'required' => [ 'OrderedRemediationActions', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'OrderedRemediationActions' => [ 'shape' => 'OrderedRemediationActions', ], 'IsDefaultAction' => [ 'shape' => 'Boolean', ], ], ], 'PossibleRemediationActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PossibleRemediationAction', ], ], 'PossibleRemediationActions' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'Actions' => [ 'shape' => 'PossibleRemediationActionList', ], ], ], 'PreviousAppsList' => [ 'type' => 'map', 'key' => [ 'shape' => 'PreviousListVersion', ], 'value' => [ 'shape' => 'AppsList', ], ], 'PreviousListVersion' => [ 'type' => 'string', 'max' => 2, 'min' => 1, 'pattern' => '^\\d{1,2}$', ], 'PreviousProtocolsList' => [ 'type' => 'map', 'key' => [ 'shape' => 'PreviousListVersion', ], 'value' => [ 'shape' => 'ProtocolsList', ], ], 'PriorityNumber' => [ 'type' => 'integer', ], 'ProtectionData' => [ 'type' => 'string', ], 'Protocol' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ProtocolsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Protocol', ], ], 'ProtocolsListData' => [ 'type' => 'structure', 'required' => [ 'ListName', 'ProtocolsList', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'ListUpdateToken' => [ 'shape' => 'UpdateToken', ], 'CreateTime' => [ 'shape' => 'TimeStamp', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'ProtocolsList' => [ 'shape' => 'ProtocolsList', ], 'PreviousProtocolsList' => [ 'shape' => 'PreviousProtocolsList', ], ], ], 'ProtocolsListDataSummary' => [ 'type' => 'structure', 'members' => [ 'ListArn' => [ 'shape' => 'ResourceArn', ], 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'ProtocolsList' => [ 'shape' => 'ProtocolsList', ], ], ], 'ProtocolsListsData' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtocolsListDataSummary', ], ], 'PutAdminAccountRequest' => [ 'type' => 'structure', 'required' => [ 'AdminAccount', ], 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], 'AdminScope' => [ 'shape' => 'AdminScope', ], ], ], 'PutAppsListRequest' => [ 'type' => 'structure', 'required' => [ 'AppsList', ], 'members' => [ 'AppsList' => [ 'shape' => 'AppsListData', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutAppsListResponse' => [ 'type' => 'structure', 'members' => [ 'AppsList' => [ 'shape' => 'AppsListData', ], 'AppsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'PutNotificationChannelRequest' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', 'SnsRoleName', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'SnsRoleName' => [ 'shape' => 'ResourceArn', ], ], ], 'PutPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Policy', ], 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], 'PolicyArn' => [ 'shape' => 'ResourceArn', ], ], ], 'PutProtocolsListRequest' => [ 'type' => 'structure', 'required' => [ 'ProtocolsList', ], 'members' => [ 'ProtocolsList' => [ 'shape' => 'ProtocolsListData', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutProtocolsListResponse' => [ 'type' => 'structure', 'members' => [ 'ProtocolsList' => [ 'shape' => 'ProtocolsListData', ], 'ProtocolsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'PutResourceSetRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceSet', ], 'members' => [ 'ResourceSet' => [ 'shape' => 'ResourceSet', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutResourceSetResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSet', 'ResourceSetArn', ], 'members' => [ 'ResourceSet' => [ 'shape' => 'ResourceSet', ], 'ResourceSetArn' => [ 'shape' => 'ResourceArn', ], ], ], 'ReferenceRule' => [ 'type' => 'string', ], 'RegionScope' => [ 'type' => 'structure', 'members' => [ 'Regions' => [ 'shape' => 'AWSRegionList', ], 'AllRegionsEnabled' => [ 'shape' => 'Boolean', ], ], ], 'RemediationAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'EC2CreateRouteAction' => [ 'shape' => 'EC2CreateRouteAction', ], 'EC2ReplaceRouteAction' => [ 'shape' => 'EC2ReplaceRouteAction', ], 'EC2DeleteRouteAction' => [ 'shape' => 'EC2DeleteRouteAction', ], 'EC2CopyRouteTableAction' => [ 'shape' => 'EC2CopyRouteTableAction', ], 'EC2ReplaceRouteTableAssociationAction' => [ 'shape' => 'EC2ReplaceRouteTableAssociationAction', ], 'EC2AssociateRouteTableAction' => [ 'shape' => 'EC2AssociateRouteTableAction', ], 'EC2CreateRouteTableAction' => [ 'shape' => 'EC2CreateRouteTableAction', ], 'FMSPolicyUpdateFirewallCreationConfigAction' => [ 'shape' => 'FMSPolicyUpdateFirewallCreationConfigAction', ], 'CreateNetworkAclAction' => [ 'shape' => 'CreateNetworkAclAction', ], 'ReplaceNetworkAclAssociationAction' => [ 'shape' => 'ReplaceNetworkAclAssociationAction', ], 'CreateNetworkAclEntriesAction' => [ 'shape' => 'CreateNetworkAclEntriesAction', ], 'DeleteNetworkAclEntriesAction' => [ 'shape' => 'DeleteNetworkAclEntriesAction', ], ], ], 'RemediationActionDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, 'pattern' => '.*', ], 'RemediationActionType' => [ 'type' => 'string', 'enum' => [ 'REMOVE', 'MODIFY', ], ], 'RemediationActionWithOrder' => [ 'type' => 'structure', 'members' => [ 'RemediationAction' => [ 'shape' => 'RemediationAction', ], 'Order' => [ 'shape' => 'BasicInteger', ], ], ], 'ReplaceNetworkAclAssociationAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'AssociationId' => [ 'shape' => 'ActionTarget', ], 'NetworkAclId' => [ 'shape' => 'ActionTarget', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'Resource' => [ 'type' => 'structure', 'required' => [ 'URI', ], 'members' => [ 'URI' => [ 'shape' => 'Identifier', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceCount' => [ 'type' => 'long', 'min' => 0, ], 'ResourceDescription' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceId', ], ], 'ResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'ResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceSet' => [ 'type' => 'structure', 'required' => [ 'Name', 'ResourceTypeList', ], 'members' => [ 'Id' => [ 'shape' => 'Base62Id', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'UpdateToken' => [ 'shape' => 'UpdateToken', ], 'ResourceTypeList' => [ 'shape' => 'ResourceTypeList', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'ResourceSetStatus' => [ 'shape' => 'ResourceSetStatus', ], ], ], 'ResourceSetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'Base62Id', ], ], 'ResourceSetStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'OUT_OF_ADMIN_SCOPE', ], ], 'ResourceSetSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Base62Id', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'ResourceSetStatus' => [ 'shape' => 'ResourceSetStatus', ], ], ], 'ResourceSetSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceSetSummary', ], ], 'ResourceTag' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'ResourceTagKey', ], 'Value' => [ 'shape' => 'ResourceTagValue', ], ], ], 'ResourceTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceTagValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceTag', ], 'max' => 50, 'min' => 0, ], 'ResourceType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceType', ], ], 'ResourceViolation' => [ 'type' => 'structure', 'members' => [ 'AwsVPCSecurityGroupViolation' => [ 'shape' => 'AwsVPCSecurityGroupViolation', ], 'AwsEc2NetworkInterfaceViolation' => [ 'shape' => 'AwsEc2NetworkInterfaceViolation', ], 'AwsEc2InstanceViolation' => [ 'shape' => 'AwsEc2InstanceViolation', ], 'NetworkFirewallMissingFirewallViolation' => [ 'shape' => 'NetworkFirewallMissingFirewallViolation', ], 'NetworkFirewallMissingSubnetViolation' => [ 'shape' => 'NetworkFirewallMissingSubnetViolation', ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'shape' => 'NetworkFirewallMissingExpectedRTViolation', ], 'NetworkFirewallPolicyModifiedViolation' => [ 'shape' => 'NetworkFirewallPolicyModifiedViolation', ], 'NetworkFirewallInternetTrafficNotInspectedViolation' => [ 'shape' => 'NetworkFirewallInternetTrafficNotInspectedViolation', ], 'NetworkFirewallInvalidRouteConfigurationViolation' => [ 'shape' => 'NetworkFirewallInvalidRouteConfigurationViolation', ], 'NetworkFirewallBlackHoleRouteDetectedViolation' => [ 'shape' => 'NetworkFirewallBlackHoleRouteDetectedViolation', ], 'NetworkFirewallUnexpectedFirewallRoutesViolation' => [ 'shape' => 'NetworkFirewallUnexpectedFirewallRoutesViolation', ], 'NetworkFirewallUnexpectedGatewayRoutesViolation' => [ 'shape' => 'NetworkFirewallUnexpectedGatewayRoutesViolation', ], 'NetworkFirewallMissingExpectedRoutesViolation' => [ 'shape' => 'NetworkFirewallMissingExpectedRoutesViolation', ], 'DnsRuleGroupPriorityConflictViolation' => [ 'shape' => 'DnsRuleGroupPriorityConflictViolation', ], 'DnsDuplicateRuleGroupViolation' => [ 'shape' => 'DnsDuplicateRuleGroupViolation', ], 'DnsRuleGroupLimitExceededViolation' => [ 'shape' => 'DnsRuleGroupLimitExceededViolation', ], 'FirewallSubnetIsOutOfScopeViolation' => [ 'shape' => 'FirewallSubnetIsOutOfScopeViolation', ], 'RouteHasOutOfScopeEndpointViolation' => [ 'shape' => 'RouteHasOutOfScopeEndpointViolation', ], 'ThirdPartyFirewallMissingFirewallViolation' => [ 'shape' => 'ThirdPartyFirewallMissingFirewallViolation', ], 'ThirdPartyFirewallMissingSubnetViolation' => [ 'shape' => 'ThirdPartyFirewallMissingSubnetViolation', ], 'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [ 'shape' => 'ThirdPartyFirewallMissingExpectedRouteTableViolation', ], 'FirewallSubnetMissingVPCEndpointViolation' => [ 'shape' => 'FirewallSubnetMissingVPCEndpointViolation', ], 'InvalidNetworkAclEntriesViolation' => [ 'shape' => 'InvalidNetworkAclEntriesViolation', ], 'PossibleRemediationActions' => [ 'shape' => 'PossibleRemediationActions', ], ], ], 'ResourceViolations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceViolation', ], ], 'Route' => [ 'type' => 'structure', 'members' => [ 'DestinationType' => [ 'shape' => 'DestinationType', ], 'TargetType' => [ 'shape' => 'TargetType', ], 'Destination' => [ 'shape' => 'LengthBoundedString', ], 'Target' => [ 'shape' => 'LengthBoundedString', ], ], ], 'RouteHasOutOfScopeEndpointViolation' => [ 'type' => 'structure', 'members' => [ 'SubnetId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'SubnetAvailabilityZoneId' => [ 'shape' => 'LengthBoundedString', ], 'CurrentFirewallSubnetRouteTable' => [ 'shape' => 'ResourceId', ], 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'FirewallSubnetRoutes' => [ 'shape' => 'Routes', ], 'InternetGatewayId' => [ 'shape' => 'ResourceId', ], 'CurrentInternetGatewayRouteTable' => [ 'shape' => 'ResourceId', ], 'InternetGatewayRoutes' => [ 'shape' => 'Routes', ], ], ], 'Routes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Route', ], ], 'RuleOrder' => [ 'type' => 'string', 'enum' => [ 'STRICT_ORDER', 'DEFAULT_ACTION_ORDER', ], ], 'SecurityGroupRemediationAction' => [ 'type' => 'structure', 'members' => [ 'RemediationActionType' => [ 'shape' => 'RemediationActionType', ], 'Description' => [ 'shape' => 'RemediationActionDescription', ], 'RemediationResult' => [ 'shape' => 'SecurityGroupRuleDescription', ], 'IsDefaultAction' => [ 'shape' => 'Boolean', ], ], ], 'SecurityGroupRemediationActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupRemediationAction', ], ], 'SecurityGroupRuleDescription' => [ 'type' => 'structure', 'members' => [ 'IPV4Range' => [ 'shape' => 'CIDR', ], 'IPV6Range' => [ 'shape' => 'CIDR', ], 'PrefixListId' => [ 'shape' => 'ResourceId', ], 'Protocol' => [ 'shape' => 'LengthBoundedString', ], 'FromPort' => [ 'shape' => 'IPPortNumber', ], 'ToPort' => [ 'shape' => 'IPPortNumber', ], ], ], 'SecurityServicePolicyData' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'SecurityServiceType', ], 'ManagedServiceData' => [ 'shape' => 'ManagedServiceData', ], 'PolicyOption' => [ 'shape' => 'PolicyOption', ], ], ], 'SecurityServiceType' => [ 'type' => 'string', 'enum' => [ 'WAF', 'WAFV2', 'SHIELD_ADVANCED', 'SECURITY_GROUPS_COMMON', 'SECURITY_GROUPS_CONTENT_AUDIT', 'SECURITY_GROUPS_USAGE_AUDIT', 'NETWORK_FIREWALL', 'DNS_FIREWALL', 'THIRD_PARTY_FIREWALL', 'IMPORT_NETWORK_FIREWALL', 'NETWORK_ACL_COMMON', ], ], 'SecurityServiceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityServiceType', ], 'max' => 32, 'min' => 0, ], 'StatefulEngineOptions' => [ 'type' => 'structure', 'members' => [ 'RuleOrder' => [ 'shape' => 'RuleOrder', ], ], ], 'StatefulRuleGroup' => [ 'type' => 'structure', 'members' => [ 'RuleGroupName' => [ 'shape' => 'NetworkFirewallResourceName', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'PriorityNumber', ], 'Override' => [ 'shape' => 'NetworkFirewallStatefulRuleGroupOverride', ], ], ], 'StatefulRuleGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StatefulRuleGroup', ], ], 'StatelessRuleGroup' => [ 'type' => 'structure', 'members' => [ 'RuleGroupName' => [ 'shape' => 'NetworkFirewallResourceName', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'StatelessRuleGroupPriority', ], ], ], 'StatelessRuleGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StatelessRuleGroup', ], ], 'StatelessRuleGroupPriority' => [ 'type' => 'integer', 'max' => 65535, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagList', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'GATEWAY', 'CARRIER_GATEWAY', 'INSTANCE', 'LOCAL_GATEWAY', 'NAT_GATEWAY', 'NETWORK_INTERFACE', 'VPC_ENDPOINT', 'VPC_PEERING_CONNECTION', 'EGRESS_ONLY_INTERNET_GATEWAY', 'TRANSIT_GATEWAY', ], ], 'TargetViolationReason' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '\\w+', ], 'TargetViolationReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetViolationReason', ], ], 'ThirdPartyFirewall' => [ 'type' => 'string', 'enum' => [ 'PALO_ALTO_NETWORKS_CLOUD_NGFW', 'FORTIGATE_CLOUD_NATIVE_FIREWALL', ], ], 'ThirdPartyFirewallAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'ONBOARDING', 'ONBOARD_COMPLETE', 'OFFBOARDING', 'OFFBOARD_COMPLETE', 'NOT_EXIST', ], ], 'ThirdPartyFirewallFirewallPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThirdPartyFirewallFirewallPolicy', ], ], 'ThirdPartyFirewallFirewallPolicy' => [ 'type' => 'structure', 'members' => [ 'FirewallPolicyId' => [ 'shape' => 'FirewallPolicyId', ], 'FirewallPolicyName' => [ 'shape' => 'FirewallPolicyName', ], ], ], 'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'CurrentRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedRouteTable' => [ 'shape' => 'ResourceId', ], ], ], 'ThirdPartyFirewallMissingFirewallViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'ThirdPartyFirewallMissingSubnetViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'ThirdPartyFirewallPolicy' => [ 'type' => 'structure', 'members' => [ 'FirewallDeploymentModel' => [ 'shape' => 'FirewallDeploymentModel', ], ], ], 'TimeStamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ViolationDetail' => [ 'type' => 'structure', 'required' => [ 'PolicyId', 'MemberAccount', 'ResourceId', 'ResourceType', 'ResourceViolations', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceViolations' => [ 'shape' => 'ResourceViolations', ], 'ResourceTags' => [ 'shape' => 'TagList', ], 'ResourceDescription' => [ 'shape' => 'LengthBoundedString', ], ], ], 'ViolationReason' => [ 'type' => 'string', 'enum' => [ 'WEB_ACL_MISSING_RULE_GROUP', 'RESOURCE_MISSING_WEB_ACL', 'RESOURCE_INCORRECT_WEB_ACL', 'RESOURCE_MISSING_SHIELD_PROTECTION', 'RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION', 'RESOURCE_MISSING_SECURITY_GROUP', 'RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP', 'SECURITY_GROUP_UNUSED', 'SECURITY_GROUP_REDUNDANT', 'FMS_CREATED_SECURITY_GROUP_EDITED', 'MISSING_FIREWALL', 'MISSING_FIREWALL_SUBNET_IN_AZ', 'MISSING_EXPECTED_ROUTE_TABLE', 'NETWORK_FIREWALL_POLICY_MODIFIED', 'FIREWALL_SUBNET_IS_OUT_OF_SCOPE', 'INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE', 'FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE', 'UNEXPECTED_FIREWALL_ROUTES', 'UNEXPECTED_TARGET_GATEWAY_ROUTES', 'TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY', 'INVALID_ROUTE_CONFIGURATION', 'MISSING_TARGET_GATEWAY', 'INTERNET_TRAFFIC_NOT_INSPECTED', 'BLACK_HOLE_ROUTE_DETECTED', 'BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET', 'RESOURCE_MISSING_DNS_FIREWALL', 'ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT', 'FIREWALL_SUBNET_MISSING_VPCE_ENDPOINT', 'INVALID_NETWORK_ACL_ENTRY', ], ], 'ViolationTarget' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, 'pattern' => '.*', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-01-01', 'endpointPrefix' => 'fms', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'FMS', 'serviceFullName' => 'Firewall Management Service', 'serviceId' => 'FMS', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSFMS_20180101', 'uid' => 'fms-2018-01-01', ], 'operations' => [ 'AssociateAdminAccount' => [ 'name' => 'AssociateAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateAdminAccountRequest', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateThirdPartyFirewall' => [ 'name' => 'AssociateThirdPartyFirewall', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateThirdPartyFirewallRequest', ], 'output' => [ 'shape' => 'AssociateThirdPartyFirewallResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'BatchAssociateResource' => [ 'name' => 'BatchAssociateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchAssociateResourceRequest', ], 'output' => [ 'shape' => 'BatchAssociateResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'BatchDisassociateResource' => [ 'name' => 'BatchDisassociateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDisassociateResourceRequest', ], 'output' => [ 'shape' => 'BatchDisassociateResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeleteAppsList' => [ 'name' => 'DeleteAppsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppsListRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteNotificationChannel' => [ 'name' => 'DeleteNotificationChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotificationChannelRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeletePolicy' => [ 'name' => 'DeletePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePolicyRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'DeleteProtocolsList' => [ 'name' => 'DeleteProtocolsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProtocolsListRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DeleteResourceSet' => [ 'name' => 'DeleteResourceSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceSetRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], ], ], 'DisassociateAdminAccount' => [ 'name' => 'DisassociateAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateAdminAccountRequest', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'DisassociateThirdPartyFirewall' => [ 'name' => 'DisassociateThirdPartyFirewall', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateThirdPartyFirewallRequest', ], 'output' => [ 'shape' => 'DisassociateThirdPartyFirewallResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetAdminAccount' => [ 'name' => 'GetAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAdminAccountRequest', ], 'output' => [ 'shape' => 'GetAdminAccountResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetAdminScope' => [ 'name' => 'GetAdminScope', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAdminScopeRequest', ], 'output' => [ 'shape' => 'GetAdminScopeResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'GetAppsList' => [ 'name' => 'GetAppsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAppsListRequest', ], 'output' => [ 'shape' => 'GetAppsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetComplianceDetail' => [ 'name' => 'GetComplianceDetail', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceDetailRequest', ], 'output' => [ 'shape' => 'GetComplianceDetailResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidOperationException', ], ], ], 'GetNotificationChannel' => [ 'name' => 'GetNotificationChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetNotificationChannelRequest', ], 'output' => [ 'shape' => 'GetNotificationChannelResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidTypeException', ], ], ], 'GetProtectionStatus' => [ 'name' => 'GetProtectionStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProtectionStatusRequest', ], 'output' => [ 'shape' => 'GetProtectionStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetProtocolsList' => [ 'name' => 'GetProtocolsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProtocolsListRequest', ], 'output' => [ 'shape' => 'GetProtocolsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetResourceSet' => [ 'name' => 'GetResourceSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourceSetRequest', ], 'output' => [ 'shape' => 'GetResourceSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetThirdPartyFirewallAssociationStatus' => [ 'name' => 'GetThirdPartyFirewallAssociationStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetThirdPartyFirewallAssociationStatusRequest', ], 'output' => [ 'shape' => 'GetThirdPartyFirewallAssociationStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'GetViolationDetails' => [ 'name' => 'GetViolationDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetViolationDetailsRequest', ], 'output' => [ 'shape' => 'GetViolationDetailsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListAdminAccountsForOrganization' => [ 'name' => 'ListAdminAccountsForOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAdminAccountsForOrganizationRequest', ], 'output' => [ 'shape' => 'ListAdminAccountsForOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'ListAdminsManagingAccount' => [ 'name' => 'ListAdminsManagingAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAdminsManagingAccountRequest', ], 'output' => [ 'shape' => 'ListAdminsManagingAccountResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListAppsLists' => [ 'name' => 'ListAppsLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsListsRequest', ], 'output' => [ 'shape' => 'ListAppsListsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListComplianceStatus' => [ 'name' => 'ListComplianceStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListComplianceStatusRequest', ], 'output' => [ 'shape' => 'ListComplianceStatusResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListDiscoveredResources' => [ 'name' => 'ListDiscoveredResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDiscoveredResourcesRequest', ], 'output' => [ 'shape' => 'ListDiscoveredResourcesResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListMemberAccounts' => [ 'name' => 'ListMemberAccounts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMemberAccountsRequest', ], 'output' => [ 'shape' => 'ListMemberAccountsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListPolicies' => [ 'name' => 'ListPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPoliciesRequest', ], 'output' => [ 'shape' => 'ListPoliciesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListProtocolsLists' => [ 'name' => 'ListProtocolsLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProtocolsListsRequest', ], 'output' => [ 'shape' => 'ListProtocolsListsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListResourceSetResources' => [ 'name' => 'ListResourceSetResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceSetResourcesRequest', ], 'output' => [ 'shape' => 'ListResourceSetResourcesResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListResourceSets' => [ 'name' => 'ListResourceSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceSetsRequest', ], 'output' => [ 'shape' => 'ListResourceSetsResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], ], ], 'ListThirdPartyFirewallFirewallPolicies' => [ 'name' => 'ListThirdPartyFirewallFirewallPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListThirdPartyFirewallFirewallPoliciesRequest', ], 'output' => [ 'shape' => 'ListThirdPartyFirewallFirewallPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutAdminAccount' => [ 'name' => 'PutAdminAccount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAdminAccountRequest', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'PutAppsList' => [ 'name' => 'PutAppsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAppsListRequest', ], 'output' => [ 'shape' => 'PutAppsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutNotificationChannel' => [ 'name' => 'PutNotificationChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutNotificationChannelRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutPolicy' => [ 'name' => 'PutPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutPolicyRequest', ], 'output' => [ 'shape' => 'PutPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidTypeException', ], ], ], 'PutProtocolsList' => [ 'name' => 'PutProtocolsList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutProtocolsListRequest', ], 'output' => [ 'shape' => 'PutProtocolsListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'PutResourceSet' => [ 'name' => 'PutResourceSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResourceSetRequest', ], 'output' => [ 'shape' => 'PutResourceSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalErrorException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidOperationException', ], [ 'shape' => 'InternalErrorException', ], [ 'shape' => 'InvalidInputException', ], ], ], ], 'shapes' => [ 'AWSAccountId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9]+$', ], 'AWSAccountIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSAccountId', ], ], 'AWSRegion' => [ 'type' => 'string', 'max' => 32, 'min' => 6, 'pattern' => '^(af|ap|ca|eu|il|me|mx|sa|us|cn|us-gov)-\\w+-\\d+$', ], 'AWSRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSRegion', ], 'max' => 64, 'min' => 0, ], 'AccountIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSAccountId', ], ], 'AccountRoleStatus' => [ 'type' => 'string', 'enum' => [ 'READY', 'CREATING', 'PENDING_DELETION', 'DELETING', 'DELETED', ], ], 'AccountScope' => [ 'type' => 'structure', 'members' => [ 'Accounts' => [ 'shape' => 'AccountIdList', ], 'AllAccountsEnabled' => [ 'shape' => 'Boolean', ], 'ExcludeSpecifiedAccounts' => [ 'shape' => 'Boolean', ], ], ], 'ActionTarget' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Description' => [ 'shape' => 'LengthBoundedString', ], ], ], 'AdminAccountSummary' => [ 'type' => 'structure', 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], 'DefaultAdmin' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'OrganizationStatus', ], ], ], 'AdminAccountSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdminAccountSummary', ], ], 'AdminScope' => [ 'type' => 'structure', 'members' => [ 'AccountScope' => [ 'shape' => 'AccountScope', ], 'OrganizationalUnitScope' => [ 'shape' => 'OrganizationalUnitScope', ], 'RegionScope' => [ 'shape' => 'RegionScope', ], 'PolicyTypeScope' => [ 'shape' => 'PolicyTypeScope', ], ], ], 'App' => [ 'type' => 'structure', 'required' => [ 'AppName', 'Protocol', 'Port', ], 'members' => [ 'AppName' => [ 'shape' => 'ResourceName', ], 'Protocol' => [ 'shape' => 'Protocol', ], 'Port' => [ 'shape' => 'IPPortNumber', ], ], ], 'AppsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'App', ], ], 'AppsListData' => [ 'type' => 'structure', 'required' => [ 'ListName', 'AppsList', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'ListUpdateToken' => [ 'shape' => 'UpdateToken', ], 'CreateTime' => [ 'shape' => 'TimeStamp', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'AppsList' => [ 'shape' => 'AppsList', ], 'PreviousAppsList' => [ 'shape' => 'PreviousAppsList', ], ], ], 'AppsListDataSummary' => [ 'type' => 'structure', 'members' => [ 'ListArn' => [ 'shape' => 'ResourceArn', ], 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'AppsList' => [ 'shape' => 'AppsList', ], ], ], 'AppsListsData' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppsListDataSummary', ], ], 'AssociateAdminAccountRequest' => [ 'type' => 'structure', 'required' => [ 'AdminAccount', ], 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], ], ], 'AssociateThirdPartyFirewallRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], ], ], 'AssociateThirdPartyFirewallResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallStatus' => [ 'shape' => 'ThirdPartyFirewallAssociationStatus', ], ], ], 'AwsEc2InstanceViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'AwsEc2NetworkInterfaceViolations' => [ 'shape' => 'AwsEc2NetworkInterfaceViolations', ], ], ], 'AwsEc2NetworkInterfaceViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolatingSecurityGroups' => [ 'shape' => 'ResourceIdList', ], ], ], 'AwsEc2NetworkInterfaceViolations' => [ 'type' => 'list', 'member' => [ 'shape' => 'AwsEc2NetworkInterfaceViolation', ], ], 'AwsVPCSecurityGroupViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], 'PartialMatches' => [ 'shape' => 'PartialMatches', ], 'PossibleSecurityGroupRemediationActions' => [ 'shape' => 'SecurityGroupRemediationActions', ], ], ], 'Base62Id' => [ 'type' => 'string', 'max' => 22, 'min' => 22, 'pattern' => '^[a-z0-9A-Z]{22}$', ], 'BasicInteger' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => -2147483648, ], 'BatchAssociateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'Items', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'Items' => [ 'shape' => 'IdentifierList', ], ], ], 'BatchAssociateResourceResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'FailedItems', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'FailedItems' => [ 'shape' => 'FailedItemList', ], ], ], 'BatchDisassociateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'Items', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'Items' => [ 'shape' => 'IdentifierList', ], ], ], 'BatchDisassociateResourceResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSetIdentifier', 'FailedItems', ], 'members' => [ 'ResourceSetIdentifier' => [ 'shape' => 'Identifier', ], 'FailedItems' => [ 'shape' => 'FailedItemList', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'CIDR' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[a-f0-9:./]+', ], 'ComplianceViolator' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ViolationReason' => [ 'shape' => 'ViolationReason', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'Metadata' => [ 'shape' => 'ComplianceViolatorMetadata', ], ], ], 'ComplianceViolatorMetadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'LengthBoundedString', ], 'value' => [ 'shape' => 'LengthBoundedString', ], ], 'ComplianceViolators' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceViolator', ], ], 'CreateNetworkAclAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'Vpc' => [ 'shape' => 'ActionTarget', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'CreateNetworkAclEntriesAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'NetworkAclId' => [ 'shape' => 'ActionTarget', ], 'NetworkAclEntriesToBeCreated' => [ 'shape' => 'EntriesDescription', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'CustomerPolicyScopeId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'CustomerPolicyScopeIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerPolicyScopeId', ], ], 'CustomerPolicyScopeIdType' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'ORG_UNIT', ], ], 'CustomerPolicyScopeMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerPolicyScopeIdType', ], 'value' => [ 'shape' => 'CustomerPolicyScopeIdList', ], ], 'CustomerPolicyStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'OUT_OF_ADMIN_SCOPE', ], ], 'DeleteAppsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], ], ], 'DeleteNetworkAclEntriesAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'NetworkAclId' => [ 'shape' => 'ActionTarget', ], 'NetworkAclEntriesToBeDeleted' => [ 'shape' => 'EntriesDescription', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'DeleteNotificationChannelRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeletePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'DeleteAllPolicyResources' => [ 'shape' => 'Boolean', ], ], ], 'DeleteProtocolsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], ], ], 'DeleteResourceSetRequest' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'Base62Id', ], ], ], 'DependentServiceName' => [ 'type' => 'string', 'enum' => [ 'AWSCONFIG', 'AWSWAF', 'AWSSHIELD_ADVANCED', 'AWSVPC', ], ], 'Description' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'DestinationType' => [ 'type' => 'string', 'enum' => [ 'IPV4', 'IPV6', 'PREFIX_LIST', ], ], 'DetailedInfo' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=,+\\-@]*)$', ], 'DisassociateAdminAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateThirdPartyFirewallRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], ], ], 'DisassociateThirdPartyFirewallResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallStatus' => [ 'shape' => 'ThirdPartyFirewallAssociationStatus', ], ], ], 'DiscoveredResource' => [ 'type' => 'structure', 'members' => [ 'URI' => [ 'shape' => 'Identifier', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], 'Type' => [ 'shape' => 'ResourceType', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'DiscoveredResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiscoveredResource', ], ], 'DnsDuplicateRuleGroupViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], ], ], 'DnsRuleGroupLimitExceededViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], 'NumberOfRuleGroupsAlreadyAssociated' => [ 'shape' => 'BasicInteger', ], ], ], 'DnsRuleGroupPriorities' => [ 'type' => 'list', 'member' => [ 'shape' => 'DnsRuleGroupPriority', ], ], 'DnsRuleGroupPriority' => [ 'type' => 'integer', 'max' => 10000, 'min' => 0, ], 'DnsRuleGroupPriorityConflictViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ViolationTargetDescription' => [ 'shape' => 'LengthBoundedString', ], 'ConflictingPriority' => [ 'shape' => 'DnsRuleGroupPriority', ], 'ConflictingPolicyId' => [ 'shape' => 'PolicyId', ], 'UnavailablePriorities' => [ 'shape' => 'DnsRuleGroupPriorities', ], ], ], 'EC2AssociateRouteTableAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], 'SubnetId' => [ 'shape' => 'ActionTarget', ], 'GatewayId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2CopyRouteTableAction' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'VpcId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2CreateRouteAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'DestinationCidrBlock' => [ 'shape' => 'CIDR', ], 'DestinationPrefixListId' => [ 'shape' => 'ResourceId', ], 'DestinationIpv6CidrBlock' => [ 'shape' => 'CIDR', ], 'VpcEndpointId' => [ 'shape' => 'ActionTarget', ], 'GatewayId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2CreateRouteTableAction' => [ 'type' => 'structure', 'required' => [ 'VpcId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'VpcId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2DeleteRouteAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'DestinationCidrBlock' => [ 'shape' => 'CIDR', ], 'DestinationPrefixListId' => [ 'shape' => 'ResourceId', ], 'DestinationIpv6CidrBlock' => [ 'shape' => 'CIDR', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2ReplaceRouteAction' => [ 'type' => 'structure', 'required' => [ 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'DestinationCidrBlock' => [ 'shape' => 'CIDR', ], 'DestinationPrefixListId' => [ 'shape' => 'ResourceId', ], 'DestinationIpv6CidrBlock' => [ 'shape' => 'CIDR', ], 'GatewayId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EC2ReplaceRouteTableAssociationAction' => [ 'type' => 'structure', 'required' => [ 'AssociationId', 'RouteTableId', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'AssociationId' => [ 'shape' => 'ActionTarget', ], 'RouteTableId' => [ 'shape' => 'ActionTarget', ], ], ], 'EntriesDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryDescription', ], ], 'EntriesWithConflicts' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryDescription', ], ], 'EntryDescription' => [ 'type' => 'structure', 'members' => [ 'EntryDetail' => [ 'shape' => 'NetworkAclEntry', ], 'EntryRuleNumber' => [ 'shape' => 'IntegerObjectMinimum0', ], 'EntryType' => [ 'shape' => 'EntryType', ], ], ], 'EntryType' => [ 'type' => 'string', 'enum' => [ 'FMS_MANAGED_FIRST_ENTRY', 'FMS_MANAGED_LAST_ENTRY', 'CUSTOM_ENTRY', ], ], 'EntryViolation' => [ 'type' => 'structure', 'members' => [ 'ExpectedEntry' => [ 'shape' => 'EntryDescription', ], 'ExpectedEvaluationOrder' => [ 'shape' => 'LengthBoundedString', ], 'ActualEvaluationOrder' => [ 'shape' => 'LengthBoundedString', ], 'EntryAtExpectedEvaluationOrder' => [ 'shape' => 'EntryDescription', ], 'EntriesWithConflicts' => [ 'shape' => 'EntriesWithConflicts', ], 'EntryViolationReasons' => [ 'shape' => 'EntryViolationReasons', ], ], ], 'EntryViolationReason' => [ 'type' => 'string', 'enum' => [ 'MISSING_EXPECTED_ENTRY', 'INCORRECT_ENTRY_ORDER', 'ENTRY_CONFLICT', ], ], 'EntryViolationReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryViolationReason', ], ], 'EntryViolations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntryViolation', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'EvaluationResult' => [ 'type' => 'structure', 'members' => [ 'ComplianceStatus' => [ 'shape' => 'PolicyComplianceStatusType', ], 'ViolatorCount' => [ 'shape' => 'ResourceCount', ], 'EvaluationLimitExceeded' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationResult', ], ], 'ExpectedRoute' => [ 'type' => 'structure', 'members' => [ 'IpV4Cidr' => [ 'shape' => 'CIDR', ], 'PrefixListId' => [ 'shape' => 'CIDR', ], 'IpV6Cidr' => [ 'shape' => 'CIDR', ], 'ContributingSubnets' => [ 'shape' => 'ResourceIdList', ], 'AllowedTargets' => [ 'shape' => 'LengthBoundedStringList', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], ], ], 'ExpectedRoutes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExpectedRoute', ], ], 'FMSPolicyUpdateFirewallCreationConfigAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'FirewallCreationConfig' => [ 'shape' => 'ManagedServiceData', ], ], ], 'FailedItem' => [ 'type' => 'structure', 'members' => [ 'URI' => [ 'shape' => 'Identifier', ], 'Reason' => [ 'shape' => 'FailedItemReason', ], ], ], 'FailedItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedItem', ], ], 'FailedItemReason' => [ 'type' => 'string', 'enum' => [ 'NOT_VALID_ARN', 'NOT_VALID_PARTITION', 'NOT_VALID_REGION', 'NOT_VALID_SERVICE', 'NOT_VALID_RESOURCE_TYPE', 'NOT_VALID_ACCOUNT_ID', ], ], 'FirewallDeploymentModel' => [ 'type' => 'string', 'enum' => [ 'CENTRALIZED', 'DISTRIBUTED', ], ], 'FirewallPolicyId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'FirewallPolicyName' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'FirewallSubnetIsOutOfScopeViolation' => [ 'type' => 'structure', 'members' => [ 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'SubnetAvailabilityZoneId' => [ 'shape' => 'LengthBoundedString', ], 'VpcEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'FirewallSubnetMissingVPCEndpointViolation' => [ 'type' => 'structure', 'members' => [ 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'SubnetAvailabilityZoneId' => [ 'shape' => 'LengthBoundedString', ], ], ], 'GetAdminAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetAdminAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], 'RoleStatus' => [ 'shape' => 'AccountRoleStatus', ], ], ], 'GetAdminScopeRequest' => [ 'type' => 'structure', 'required' => [ 'AdminAccount', ], 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], ], ], 'GetAdminScopeResponse' => [ 'type' => 'structure', 'members' => [ 'AdminScope' => [ 'shape' => 'AdminScope', ], 'Status' => [ 'shape' => 'OrganizationStatus', ], ], ], 'GetAppsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'DefaultList' => [ 'shape' => 'Boolean', ], ], ], 'GetAppsListResponse' => [ 'type' => 'structure', 'members' => [ 'AppsList' => [ 'shape' => 'AppsListData', ], 'AppsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetComplianceDetailRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', 'MemberAccount', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], ], ], 'GetComplianceDetailResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyComplianceDetail' => [ 'shape' => 'PolicyComplianceDetail', ], ], ], 'GetNotificationChannelRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetNotificationChannelResponse' => [ 'type' => 'structure', 'members' => [ 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'SnsRoleName' => [ 'shape' => 'ResourceArn', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], 'PolicyArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetProtectionStatusRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccountId' => [ 'shape' => 'AWSAccountId', ], 'StartTime' => [ 'shape' => 'TimeStamp', ], 'EndTime' => [ 'shape' => 'TimeStamp', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'GetProtectionStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccountId' => [ 'shape' => 'AWSAccountId', ], 'ServiceType' => [ 'shape' => 'SecurityServiceType', ], 'Data' => [ 'shape' => 'ProtectionData', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'GetProtocolsListRequest' => [ 'type' => 'structure', 'required' => [ 'ListId', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'DefaultList' => [ 'shape' => 'Boolean', ], ], ], 'GetProtocolsListResponse' => [ 'type' => 'structure', 'members' => [ 'ProtocolsList' => [ 'shape' => 'ProtocolsListData', ], 'ProtocolsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetResourceSetRequest' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'Base62Id', ], ], ], 'GetResourceSetResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSet', 'ResourceSetArn', ], 'members' => [ 'ResourceSet' => [ 'shape' => 'ResourceSet', ], 'ResourceSetArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetThirdPartyFirewallAssociationStatusRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], ], ], 'GetThirdPartyFirewallAssociationStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallStatus' => [ 'shape' => 'ThirdPartyFirewallAssociationStatus', ], 'MarketplaceOnboardingStatus' => [ 'shape' => 'MarketplaceSubscriptionOnboardingStatus', ], ], ], 'GetViolationDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', 'MemberAccount', 'ResourceId', 'ResourceType', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], ], ], 'GetViolationDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'ViolationDetail' => [ 'shape' => 'ViolationDetail', ], ], ], 'IPPortNumber' => [ 'type' => 'long', 'max' => 65535, 'min' => 0, ], 'IPPortNumberInteger' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'Identifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'IdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Identifier', ], ], 'IntegerObject' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => -2147483648, ], 'IntegerObjectMinimum0' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => 0, ], 'InternalErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidNetworkAclEntriesViolation' => [ 'type' => 'structure', 'members' => [ 'Vpc' => [ 'shape' => 'ResourceId', ], 'Subnet' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'CurrentAssociatedNetworkAcl' => [ 'shape' => 'ResourceId', ], 'EntryViolations' => [ 'shape' => 'EntryViolations', ], ], ], 'InvalidOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'IssueInfoMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'DependentServiceName', ], 'value' => [ 'shape' => 'DetailedInfo', ], ], 'LengthBoundedNonEmptyString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'LengthBoundedString' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'LengthBoundedStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LengthBoundedString', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ListAdminAccountsForOrganizationRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListAdminAccountsForOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccounts' => [ 'shape' => 'AdminAccountSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListAdminsManagingAccountRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListAdminsManagingAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AdminAccounts' => [ 'shape' => 'AccountIdList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListAppsListsRequest' => [ 'type' => 'structure', 'required' => [ 'MaxResults', ], 'members' => [ 'DefaultLists' => [ 'shape' => 'Boolean', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListAppsListsResponse' => [ 'type' => 'structure', 'members' => [ 'AppsLists' => [ 'shape' => 'AppsListsData', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListComplianceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyId', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListComplianceStatusResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyComplianceStatusList' => [ 'shape' => 'PolicyComplianceStatusList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDiscoveredResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'MemberAccountIds', 'ResourceType', ], 'members' => [ 'MemberAccountIds' => [ 'shape' => 'AWSAccountIdList', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDiscoveredResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'Items' => [ 'shape' => 'DiscoveredResourceList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-z0-9A-Z-]{36}$', ], 'ListMemberAccountsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListMemberAccountsResponse' => [ 'type' => 'structure', 'members' => [ 'MemberAccounts' => [ 'shape' => 'MemberAccounts', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListPoliciesResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyList' => [ 'shape' => 'PolicySummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListProtocolsListsRequest' => [ 'type' => 'structure', 'required' => [ 'MaxResults', ], 'members' => [ 'DefaultLists' => [ 'shape' => 'Boolean', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListProtocolsListsResponse' => [ 'type' => 'structure', 'members' => [ 'ProtocolsLists' => [ 'shape' => 'ProtocolsListsData', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListResourceSetResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'ResourceId', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListResourceSetResourcesResponse' => [ 'type' => 'structure', 'required' => [ 'Items', ], 'members' => [ 'Items' => [ 'shape' => 'ResourceList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListResourceSetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListResourceSetsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceSets' => [ 'shape' => 'ResourceSetSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'ListThirdPartyFirewallFirewallPoliciesRequest' => [ 'type' => 'structure', 'required' => [ 'ThirdPartyFirewall', 'MaxResults', ], 'members' => [ 'ThirdPartyFirewall' => [ 'shape' => 'ThirdPartyFirewall', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'PaginationMaxResults', ], ], ], 'ListThirdPartyFirewallFirewallPoliciesResponse' => [ 'type' => 'structure', 'members' => [ 'ThirdPartyFirewallFirewallPolicies' => [ 'shape' => 'ThirdPartyFirewallFirewallPolicies', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ManagedServiceData' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, 'pattern' => '^((?!\\\\[nr]).)+', ], 'MarketplaceSubscriptionOnboardingStatus' => [ 'type' => 'string', 'enum' => [ 'NO_SUBSCRIPTION', 'NOT_COMPLETE', 'COMPLETE', ], ], 'MemberAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AWSAccountId', ], ], 'Name' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'NetworkAclCommonPolicy' => [ 'type' => 'structure', 'required' => [ 'NetworkAclEntrySet', ], 'members' => [ 'NetworkAclEntrySet' => [ 'shape' => 'NetworkAclEntrySet', ], ], ], 'NetworkAclEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkAclEntry', ], ], 'NetworkAclEntry' => [ 'type' => 'structure', 'required' => [ 'Protocol', 'RuleAction', 'Egress', ], 'members' => [ 'IcmpTypeCode' => [ 'shape' => 'NetworkAclIcmpTypeCode', ], 'Protocol' => [ 'shape' => 'LengthBoundedString', ], 'PortRange' => [ 'shape' => 'NetworkAclPortRange', ], 'CidrBlock' => [ 'shape' => 'LengthBoundedNonEmptyString', ], 'Ipv6CidrBlock' => [ 'shape' => 'LengthBoundedNonEmptyString', ], 'RuleAction' => [ 'shape' => 'NetworkAclRuleAction', ], 'Egress' => [ 'shape' => 'BooleanObject', ], ], ], 'NetworkAclEntrySet' => [ 'type' => 'structure', 'required' => [ 'ForceRemediateForFirstEntries', 'ForceRemediateForLastEntries', ], 'members' => [ 'FirstEntries' => [ 'shape' => 'NetworkAclEntries', ], 'ForceRemediateForFirstEntries' => [ 'shape' => 'BooleanObject', ], 'LastEntries' => [ 'shape' => 'NetworkAclEntries', ], 'ForceRemediateForLastEntries' => [ 'shape' => 'BooleanObject', ], ], ], 'NetworkAclIcmpTypeCode' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'IntegerObject', ], 'Type' => [ 'shape' => 'IntegerObject', ], ], ], 'NetworkAclPortRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'IPPortNumberInteger', ], 'To' => [ 'shape' => 'IPPortNumberInteger', ], ], ], 'NetworkAclRuleAction' => [ 'type' => 'string', 'enum' => [ 'allow', 'deny', ], ], 'NetworkFirewallAction' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]+$', ], 'NetworkFirewallActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkFirewallAction', ], ], 'NetworkFirewallBlackHoleRouteDetectedViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], ], ], 'NetworkFirewallInternetTrafficNotInspectedViolation' => [ 'type' => 'structure', 'members' => [ 'SubnetId' => [ 'shape' => 'ResourceId', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'IsRouteTableUsedInDifferentAZ' => [ 'shape' => 'Boolean', ], 'CurrentFirewallSubnetRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallSubnetRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualFirewallSubnetRoutes' => [ 'shape' => 'Routes', ], 'InternetGatewayId' => [ 'shape' => 'ResourceId', ], 'CurrentInternetGatewayRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedInternetGatewayRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualInternetGatewayRoutes' => [ 'shape' => 'Routes', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallInvalidRouteConfigurationViolation' => [ 'type' => 'structure', 'members' => [ 'AffectedSubnets' => [ 'shape' => 'ResourceIdList', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'IsRouteTableUsedInDifferentAZ' => [ 'shape' => 'Boolean', ], 'ViolatingRoute' => [ 'shape' => 'Route', ], 'CurrentFirewallSubnetRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'ActualFirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ActualFirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ExpectedFirewallSubnetRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualFirewallSubnetRoutes' => [ 'shape' => 'Routes', ], 'InternetGatewayId' => [ 'shape' => 'ResourceId', ], 'CurrentInternetGatewayRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedInternetGatewayRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'ActualInternetGatewayRoutes' => [ 'shape' => 'Routes', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'CurrentRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedRouteTable' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallMissingExpectedRoutesViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'ExpectedRoutes' => [ 'shape' => 'ExpectedRoutes', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallMissingFirewallViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'NetworkFirewallMissingSubnetViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'NetworkFirewallOverrideAction' => [ 'type' => 'string', 'enum' => [ 'DROP_TO_ALERT', ], ], 'NetworkFirewallPolicy' => [ 'type' => 'structure', 'members' => [ 'FirewallDeploymentModel' => [ 'shape' => 'FirewallDeploymentModel', ], ], ], 'NetworkFirewallPolicyDescription' => [ 'type' => 'structure', 'members' => [ 'StatelessRuleGroups' => [ 'shape' => 'StatelessRuleGroupList', ], 'StatelessDefaultActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatelessFragmentDefaultActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatelessCustomActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatefulRuleGroups' => [ 'shape' => 'StatefulRuleGroupList', ], 'StatefulDefaultActions' => [ 'shape' => 'NetworkFirewallActionList', ], 'StatefulEngineOptions' => [ 'shape' => 'StatefulEngineOptions', ], ], ], 'NetworkFirewallPolicyModifiedViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'CurrentPolicyDescription' => [ 'shape' => 'NetworkFirewallPolicyDescription', ], 'ExpectedPolicyDescription' => [ 'shape' => 'NetworkFirewallPolicyDescription', ], ], ], 'NetworkFirewallResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'NetworkFirewallStatefulRuleGroupOverride' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'NetworkFirewallOverrideAction', ], ], ], 'NetworkFirewallUnexpectedFirewallRoutesViolation' => [ 'type' => 'structure', 'members' => [ 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'FirewallEndpoint' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'NetworkFirewallUnexpectedGatewayRoutesViolation' => [ 'type' => 'structure', 'members' => [ 'GatewayId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], ], ], 'OrderedRemediationActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationActionWithOrder', ], ], 'OrganizationStatus' => [ 'type' => 'string', 'enum' => [ 'ONBOARDING', 'ONBOARDING_COMPLETE', 'OFFBOARDING', 'OFFBOARDING_COMPLETE', ], ], 'OrganizationalUnitId' => [ 'type' => 'string', 'max' => 68, 'min' => 16, 'pattern' => '^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$', ], 'OrganizationalUnitIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationalUnitId', ], ], 'OrganizationalUnitScope' => [ 'type' => 'structure', 'members' => [ 'OrganizationalUnits' => [ 'shape' => 'OrganizationalUnitIdList', ], 'AllOrganizationalUnitsEnabled' => [ 'shape' => 'Boolean', ], 'ExcludeSpecifiedOrganizationalUnits' => [ 'shape' => 'Boolean', ], ], ], 'PaginationMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'PaginationToken' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'PartialMatch' => [ 'type' => 'structure', 'members' => [ 'Reference' => [ 'shape' => 'ReferenceRule', ], 'TargetViolationReasons' => [ 'shape' => 'TargetViolationReasons', ], ], ], 'PartialMatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'PartialMatch', ], ], 'Policy' => [ 'type' => 'structure', 'required' => [ 'PolicyName', 'SecurityServicePolicyData', 'ResourceType', 'ExcludeResourceTags', 'RemediationEnabled', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'PolicyName' => [ 'shape' => 'ResourceName', ], 'PolicyUpdateToken' => [ 'shape' => 'PolicyUpdateToken', ], 'SecurityServicePolicyData' => [ 'shape' => 'SecurityServicePolicyData', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceTypeList' => [ 'shape' => 'ResourceTypeList', ], 'ResourceTags' => [ 'shape' => 'ResourceTags', ], 'ExcludeResourceTags' => [ 'shape' => 'Boolean', ], 'RemediationEnabled' => [ 'shape' => 'Boolean', ], 'DeleteUnusedFMManagedResources' => [ 'shape' => 'Boolean', ], 'IncludeMap' => [ 'shape' => 'CustomerPolicyScopeMap', ], 'ExcludeMap' => [ 'shape' => 'CustomerPolicyScopeMap', ], 'ResourceSetIds' => [ 'shape' => 'ResourceSetIds', ], 'PolicyDescription' => [ 'shape' => 'ResourceDescription', ], 'PolicyStatus' => [ 'shape' => 'CustomerPolicyStatus', ], ], ], 'PolicyComplianceDetail' => [ 'type' => 'structure', 'members' => [ 'PolicyOwner' => [ 'shape' => 'AWSAccountId', ], 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'Violators' => [ 'shape' => 'ComplianceViolators', ], 'EvaluationLimitExceeded' => [ 'shape' => 'Boolean', ], 'ExpiredAt' => [ 'shape' => 'TimeStamp', ], 'IssueInfoMap' => [ 'shape' => 'IssueInfoMap', ], ], ], 'PolicyComplianceStatus' => [ 'type' => 'structure', 'members' => [ 'PolicyOwner' => [ 'shape' => 'AWSAccountId', ], 'PolicyId' => [ 'shape' => 'PolicyId', ], 'PolicyName' => [ 'shape' => 'ResourceName', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'EvaluationResults' => [ 'shape' => 'EvaluationResults', ], 'LastUpdated' => [ 'shape' => 'TimeStamp', ], 'IssueInfoMap' => [ 'shape' => 'IssueInfoMap', ], ], ], 'PolicyComplianceStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyComplianceStatus', ], ], 'PolicyComplianceStatusType' => [ 'type' => 'string', 'enum' => [ 'COMPLIANT', 'NON_COMPLIANT', ], ], 'PolicyId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-z0-9A-Z-]{36}$', ], 'PolicyOption' => [ 'type' => 'structure', 'members' => [ 'NetworkFirewallPolicy' => [ 'shape' => 'NetworkFirewallPolicy', ], 'ThirdPartyFirewallPolicy' => [ 'shape' => 'ThirdPartyFirewallPolicy', ], 'NetworkAclCommonPolicy' => [ 'shape' => 'NetworkAclCommonPolicy', ], ], ], 'PolicySummary' => [ 'type' => 'structure', 'members' => [ 'PolicyArn' => [ 'shape' => 'ResourceArn', ], 'PolicyId' => [ 'shape' => 'PolicyId', ], 'PolicyName' => [ 'shape' => 'ResourceName', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'SecurityServiceType' => [ 'shape' => 'SecurityServiceType', ], 'RemediationEnabled' => [ 'shape' => 'Boolean', ], 'DeleteUnusedFMManagedResources' => [ 'shape' => 'Boolean', ], 'PolicyStatus' => [ 'shape' => 'CustomerPolicyStatus', ], ], ], 'PolicySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicySummary', ], ], 'PolicyTypeScope' => [ 'type' => 'structure', 'members' => [ 'PolicyTypes' => [ 'shape' => 'SecurityServiceTypeList', ], 'AllPolicyTypesEnabled' => [ 'shape' => 'Boolean', ], ], ], 'PolicyUpdateToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'PossibleRemediationAction' => [ 'type' => 'structure', 'required' => [ 'OrderedRemediationActions', ], 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'OrderedRemediationActions' => [ 'shape' => 'OrderedRemediationActions', ], 'IsDefaultAction' => [ 'shape' => 'Boolean', ], ], ], 'PossibleRemediationActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PossibleRemediationAction', ], ], 'PossibleRemediationActions' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'Actions' => [ 'shape' => 'PossibleRemediationActionList', ], ], ], 'PreviousAppsList' => [ 'type' => 'map', 'key' => [ 'shape' => 'PreviousListVersion', ], 'value' => [ 'shape' => 'AppsList', ], ], 'PreviousListVersion' => [ 'type' => 'string', 'max' => 2, 'min' => 1, 'pattern' => '^\\d{1,2}$', ], 'PreviousProtocolsList' => [ 'type' => 'map', 'key' => [ 'shape' => 'PreviousListVersion', ], 'value' => [ 'shape' => 'ProtocolsList', ], ], 'PriorityNumber' => [ 'type' => 'integer', ], 'ProtectionData' => [ 'type' => 'string', ], 'Protocol' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ProtocolsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Protocol', ], ], 'ProtocolsListData' => [ 'type' => 'structure', 'required' => [ 'ListName', 'ProtocolsList', ], 'members' => [ 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'ListUpdateToken' => [ 'shape' => 'UpdateToken', ], 'CreateTime' => [ 'shape' => 'TimeStamp', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'ProtocolsList' => [ 'shape' => 'ProtocolsList', ], 'PreviousProtocolsList' => [ 'shape' => 'PreviousProtocolsList', ], ], ], 'ProtocolsListDataSummary' => [ 'type' => 'structure', 'members' => [ 'ListArn' => [ 'shape' => 'ResourceArn', ], 'ListId' => [ 'shape' => 'ListId', ], 'ListName' => [ 'shape' => 'ResourceName', ], 'ProtocolsList' => [ 'shape' => 'ProtocolsList', ], ], ], 'ProtocolsListsData' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtocolsListDataSummary', ], ], 'PutAdminAccountRequest' => [ 'type' => 'structure', 'required' => [ 'AdminAccount', ], 'members' => [ 'AdminAccount' => [ 'shape' => 'AWSAccountId', ], 'AdminScope' => [ 'shape' => 'AdminScope', ], ], ], 'PutAppsListRequest' => [ 'type' => 'structure', 'required' => [ 'AppsList', ], 'members' => [ 'AppsList' => [ 'shape' => 'AppsListData', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutAppsListResponse' => [ 'type' => 'structure', 'members' => [ 'AppsList' => [ 'shape' => 'AppsListData', ], 'AppsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'PutNotificationChannelRequest' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', 'SnsRoleName', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'SnsRoleName' => [ 'shape' => 'ResourceArn', ], ], ], 'PutPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Policy', ], 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], 'PolicyArn' => [ 'shape' => 'ResourceArn', ], ], ], 'PutProtocolsListRequest' => [ 'type' => 'structure', 'required' => [ 'ProtocolsList', ], 'members' => [ 'ProtocolsList' => [ 'shape' => 'ProtocolsListData', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutProtocolsListResponse' => [ 'type' => 'structure', 'members' => [ 'ProtocolsList' => [ 'shape' => 'ProtocolsListData', ], 'ProtocolsListArn' => [ 'shape' => 'ResourceArn', ], ], ], 'PutResourceSetRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceSet', ], 'members' => [ 'ResourceSet' => [ 'shape' => 'ResourceSet', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'PutResourceSetResponse' => [ 'type' => 'structure', 'required' => [ 'ResourceSet', 'ResourceSetArn', ], 'members' => [ 'ResourceSet' => [ 'shape' => 'ResourceSet', ], 'ResourceSetArn' => [ 'shape' => 'ResourceArn', ], ], ], 'ReferenceRule' => [ 'type' => 'string', ], 'RegionScope' => [ 'type' => 'structure', 'members' => [ 'Regions' => [ 'shape' => 'AWSRegionList', ], 'AllRegionsEnabled' => [ 'shape' => 'Boolean', ], ], ], 'RemediationAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'EC2CreateRouteAction' => [ 'shape' => 'EC2CreateRouteAction', ], 'EC2ReplaceRouteAction' => [ 'shape' => 'EC2ReplaceRouteAction', ], 'EC2DeleteRouteAction' => [ 'shape' => 'EC2DeleteRouteAction', ], 'EC2CopyRouteTableAction' => [ 'shape' => 'EC2CopyRouteTableAction', ], 'EC2ReplaceRouteTableAssociationAction' => [ 'shape' => 'EC2ReplaceRouteTableAssociationAction', ], 'EC2AssociateRouteTableAction' => [ 'shape' => 'EC2AssociateRouteTableAction', ], 'EC2CreateRouteTableAction' => [ 'shape' => 'EC2CreateRouteTableAction', ], 'FMSPolicyUpdateFirewallCreationConfigAction' => [ 'shape' => 'FMSPolicyUpdateFirewallCreationConfigAction', ], 'CreateNetworkAclAction' => [ 'shape' => 'CreateNetworkAclAction', ], 'ReplaceNetworkAclAssociationAction' => [ 'shape' => 'ReplaceNetworkAclAssociationAction', ], 'CreateNetworkAclEntriesAction' => [ 'shape' => 'CreateNetworkAclEntriesAction', ], 'DeleteNetworkAclEntriesAction' => [ 'shape' => 'DeleteNetworkAclEntriesAction', ], ], ], 'RemediationActionDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, 'pattern' => '.*', ], 'RemediationActionType' => [ 'type' => 'string', 'enum' => [ 'REMOVE', 'MODIFY', ], ], 'RemediationActionWithOrder' => [ 'type' => 'structure', 'members' => [ 'RemediationAction' => [ 'shape' => 'RemediationAction', ], 'Order' => [ 'shape' => 'BasicInteger', ], ], ], 'ReplaceNetworkAclAssociationAction' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'LengthBoundedString', ], 'AssociationId' => [ 'shape' => 'ActionTarget', ], 'NetworkAclId' => [ 'shape' => 'ActionTarget', ], 'FMSCanRemediate' => [ 'shape' => 'Boolean', ], ], ], 'Resource' => [ 'type' => 'structure', 'required' => [ 'URI', ], 'members' => [ 'URI' => [ 'shape' => 'Identifier', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceCount' => [ 'type' => 'long', 'min' => 0, ], 'ResourceDescription' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceId', ], ], 'ResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'ResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceSet' => [ 'type' => 'structure', 'required' => [ 'Name', 'ResourceTypeList', ], 'members' => [ 'Id' => [ 'shape' => 'Base62Id', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'UpdateToken' => [ 'shape' => 'UpdateToken', ], 'ResourceTypeList' => [ 'shape' => 'ResourceTypeList', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'ResourceSetStatus' => [ 'shape' => 'ResourceSetStatus', ], ], ], 'ResourceSetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'Base62Id', ], ], 'ResourceSetStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'OUT_OF_ADMIN_SCOPE', ], ], 'ResourceSetSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Base62Id', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'LastUpdateTime' => [ 'shape' => 'TimeStamp', ], 'ResourceSetStatus' => [ 'shape' => 'ResourceSetStatus', ], ], ], 'ResourceSetSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceSetSummary', ], ], 'ResourceTag' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'ResourceTagKey', ], 'Value' => [ 'shape' => 'ResourceTagValue', ], ], ], 'ResourceTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceTagValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceTag', ], 'max' => 50, 'min' => 0, ], 'ResourceType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ResourceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceType', ], ], 'ResourceViolation' => [ 'type' => 'structure', 'members' => [ 'AwsVPCSecurityGroupViolation' => [ 'shape' => 'AwsVPCSecurityGroupViolation', ], 'AwsEc2NetworkInterfaceViolation' => [ 'shape' => 'AwsEc2NetworkInterfaceViolation', ], 'AwsEc2InstanceViolation' => [ 'shape' => 'AwsEc2InstanceViolation', ], 'NetworkFirewallMissingFirewallViolation' => [ 'shape' => 'NetworkFirewallMissingFirewallViolation', ], 'NetworkFirewallMissingSubnetViolation' => [ 'shape' => 'NetworkFirewallMissingSubnetViolation', ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'shape' => 'NetworkFirewallMissingExpectedRTViolation', ], 'NetworkFirewallPolicyModifiedViolation' => [ 'shape' => 'NetworkFirewallPolicyModifiedViolation', ], 'NetworkFirewallInternetTrafficNotInspectedViolation' => [ 'shape' => 'NetworkFirewallInternetTrafficNotInspectedViolation', ], 'NetworkFirewallInvalidRouteConfigurationViolation' => [ 'shape' => 'NetworkFirewallInvalidRouteConfigurationViolation', ], 'NetworkFirewallBlackHoleRouteDetectedViolation' => [ 'shape' => 'NetworkFirewallBlackHoleRouteDetectedViolation', ], 'NetworkFirewallUnexpectedFirewallRoutesViolation' => [ 'shape' => 'NetworkFirewallUnexpectedFirewallRoutesViolation', ], 'NetworkFirewallUnexpectedGatewayRoutesViolation' => [ 'shape' => 'NetworkFirewallUnexpectedGatewayRoutesViolation', ], 'NetworkFirewallMissingExpectedRoutesViolation' => [ 'shape' => 'NetworkFirewallMissingExpectedRoutesViolation', ], 'DnsRuleGroupPriorityConflictViolation' => [ 'shape' => 'DnsRuleGroupPriorityConflictViolation', ], 'DnsDuplicateRuleGroupViolation' => [ 'shape' => 'DnsDuplicateRuleGroupViolation', ], 'DnsRuleGroupLimitExceededViolation' => [ 'shape' => 'DnsRuleGroupLimitExceededViolation', ], 'FirewallSubnetIsOutOfScopeViolation' => [ 'shape' => 'FirewallSubnetIsOutOfScopeViolation', ], 'RouteHasOutOfScopeEndpointViolation' => [ 'shape' => 'RouteHasOutOfScopeEndpointViolation', ], 'ThirdPartyFirewallMissingFirewallViolation' => [ 'shape' => 'ThirdPartyFirewallMissingFirewallViolation', ], 'ThirdPartyFirewallMissingSubnetViolation' => [ 'shape' => 'ThirdPartyFirewallMissingSubnetViolation', ], 'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [ 'shape' => 'ThirdPartyFirewallMissingExpectedRouteTableViolation', ], 'FirewallSubnetMissingVPCEndpointViolation' => [ 'shape' => 'FirewallSubnetMissingVPCEndpointViolation', ], 'InvalidNetworkAclEntriesViolation' => [ 'shape' => 'InvalidNetworkAclEntriesViolation', ], 'PossibleRemediationActions' => [ 'shape' => 'PossibleRemediationActions', ], ], ], 'ResourceViolations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceViolation', ], ], 'Route' => [ 'type' => 'structure', 'members' => [ 'DestinationType' => [ 'shape' => 'DestinationType', ], 'TargetType' => [ 'shape' => 'TargetType', ], 'Destination' => [ 'shape' => 'LengthBoundedString', ], 'Target' => [ 'shape' => 'LengthBoundedString', ], ], ], 'RouteHasOutOfScopeEndpointViolation' => [ 'type' => 'structure', 'members' => [ 'SubnetId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'RouteTableId' => [ 'shape' => 'ResourceId', ], 'ViolatingRoutes' => [ 'shape' => 'Routes', ], 'SubnetAvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'SubnetAvailabilityZoneId' => [ 'shape' => 'LengthBoundedString', ], 'CurrentFirewallSubnetRouteTable' => [ 'shape' => 'ResourceId', ], 'FirewallSubnetId' => [ 'shape' => 'ResourceId', ], 'FirewallSubnetRoutes' => [ 'shape' => 'Routes', ], 'InternetGatewayId' => [ 'shape' => 'ResourceId', ], 'CurrentInternetGatewayRouteTable' => [ 'shape' => 'ResourceId', ], 'InternetGatewayRoutes' => [ 'shape' => 'Routes', ], ], ], 'Routes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Route', ], ], 'RuleOrder' => [ 'type' => 'string', 'enum' => [ 'STRICT_ORDER', 'DEFAULT_ACTION_ORDER', ], ], 'SecurityGroupRemediationAction' => [ 'type' => 'structure', 'members' => [ 'RemediationActionType' => [ 'shape' => 'RemediationActionType', ], 'Description' => [ 'shape' => 'RemediationActionDescription', ], 'RemediationResult' => [ 'shape' => 'SecurityGroupRuleDescription', ], 'IsDefaultAction' => [ 'shape' => 'Boolean', ], ], ], 'SecurityGroupRemediationActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupRemediationAction', ], ], 'SecurityGroupRuleDescription' => [ 'type' => 'structure', 'members' => [ 'IPV4Range' => [ 'shape' => 'CIDR', ], 'IPV6Range' => [ 'shape' => 'CIDR', ], 'PrefixListId' => [ 'shape' => 'ResourceId', ], 'Protocol' => [ 'shape' => 'LengthBoundedString', ], 'FromPort' => [ 'shape' => 'IPPortNumber', ], 'ToPort' => [ 'shape' => 'IPPortNumber', ], ], ], 'SecurityServicePolicyData' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'SecurityServiceType', ], 'ManagedServiceData' => [ 'shape' => 'ManagedServiceData', ], 'PolicyOption' => [ 'shape' => 'PolicyOption', ], ], ], 'SecurityServiceType' => [ 'type' => 'string', 'enum' => [ 'WAF', 'WAFV2', 'SHIELD_ADVANCED', 'SECURITY_GROUPS_COMMON', 'SECURITY_GROUPS_CONTENT_AUDIT', 'SECURITY_GROUPS_USAGE_AUDIT', 'NETWORK_FIREWALL', 'DNS_FIREWALL', 'THIRD_PARTY_FIREWALL', 'IMPORT_NETWORK_FIREWALL', 'NETWORK_ACL_COMMON', ], ], 'SecurityServiceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityServiceType', ], 'max' => 32, 'min' => 0, ], 'StatefulEngineOptions' => [ 'type' => 'structure', 'members' => [ 'RuleOrder' => [ 'shape' => 'RuleOrder', ], 'StreamExceptionPolicy' => [ 'shape' => 'StreamExceptionPolicy', ], ], ], 'StatefulRuleGroup' => [ 'type' => 'structure', 'members' => [ 'RuleGroupName' => [ 'shape' => 'NetworkFirewallResourceName', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'PriorityNumber', ], 'Override' => [ 'shape' => 'NetworkFirewallStatefulRuleGroupOverride', ], ], ], 'StatefulRuleGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StatefulRuleGroup', ], ], 'StatelessRuleGroup' => [ 'type' => 'structure', 'members' => [ 'RuleGroupName' => [ 'shape' => 'NetworkFirewallResourceName', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'StatelessRuleGroupPriority', ], ], ], 'StatelessRuleGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StatelessRuleGroup', ], ], 'StatelessRuleGroupPriority' => [ 'type' => 'integer', 'max' => 65535, 'min' => 1, ], 'StreamExceptionPolicy' => [ 'type' => 'string', 'enum' => [ 'DROP', 'CONTINUE', 'REJECT', 'FMS_IGNORE', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagList', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'GATEWAY', 'CARRIER_GATEWAY', 'INSTANCE', 'LOCAL_GATEWAY', 'NAT_GATEWAY', 'NETWORK_INTERFACE', 'VPC_ENDPOINT', 'VPC_PEERING_CONNECTION', 'EGRESS_ONLY_INTERNET_GATEWAY', 'TRANSIT_GATEWAY', ], ], 'TargetViolationReason' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '\\w+', ], 'TargetViolationReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetViolationReason', ], ], 'ThirdPartyFirewall' => [ 'type' => 'string', 'enum' => [ 'PALO_ALTO_NETWORKS_CLOUD_NGFW', 'FORTIGATE_CLOUD_NATIVE_FIREWALL', ], ], 'ThirdPartyFirewallAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'ONBOARDING', 'ONBOARD_COMPLETE', 'OFFBOARDING', 'OFFBOARD_COMPLETE', 'NOT_EXIST', ], ], 'ThirdPartyFirewallFirewallPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThirdPartyFirewallFirewallPolicy', ], ], 'ThirdPartyFirewallFirewallPolicy' => [ 'type' => 'structure', 'members' => [ 'FirewallPolicyId' => [ 'shape' => 'FirewallPolicyId', ], 'FirewallPolicyName' => [ 'shape' => 'FirewallPolicyName', ], ], ], 'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'CurrentRouteTable' => [ 'shape' => 'ResourceId', ], 'ExpectedRouteTable' => [ 'shape' => 'ResourceId', ], ], ], 'ThirdPartyFirewallMissingFirewallViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'ThirdPartyFirewallMissingSubnetViolation' => [ 'type' => 'structure', 'members' => [ 'ViolationTarget' => [ 'shape' => 'ViolationTarget', ], 'VPC' => [ 'shape' => 'ResourceId', ], 'AvailabilityZone' => [ 'shape' => 'LengthBoundedString', ], 'TargetViolationReason' => [ 'shape' => 'TargetViolationReason', ], ], ], 'ThirdPartyFirewallPolicy' => [ 'type' => 'structure', 'members' => [ 'FirewallDeploymentModel' => [ 'shape' => 'FirewallDeploymentModel', ], ], ], 'TimeStamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'ViolationDetail' => [ 'type' => 'structure', 'required' => [ 'PolicyId', 'MemberAccount', 'ResourceId', 'ResourceType', 'ResourceViolations', ], 'members' => [ 'PolicyId' => [ 'shape' => 'PolicyId', ], 'MemberAccount' => [ 'shape' => 'AWSAccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceViolations' => [ 'shape' => 'ResourceViolations', ], 'ResourceTags' => [ 'shape' => 'TagList', ], 'ResourceDescription' => [ 'shape' => 'LengthBoundedString', ], ], ], 'ViolationReason' => [ 'type' => 'string', 'enum' => [ 'WEB_ACL_MISSING_RULE_GROUP', 'RESOURCE_MISSING_WEB_ACL', 'RESOURCE_INCORRECT_WEB_ACL', 'RESOURCE_MISSING_SHIELD_PROTECTION', 'RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION', 'RESOURCE_MISSING_SECURITY_GROUP', 'RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP', 'SECURITY_GROUP_UNUSED', 'SECURITY_GROUP_REDUNDANT', 'FMS_CREATED_SECURITY_GROUP_EDITED', 'MISSING_FIREWALL', 'MISSING_FIREWALL_SUBNET_IN_AZ', 'MISSING_EXPECTED_ROUTE_TABLE', 'NETWORK_FIREWALL_POLICY_MODIFIED', 'FIREWALL_SUBNET_IS_OUT_OF_SCOPE', 'INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE', 'FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE', 'UNEXPECTED_FIREWALL_ROUTES', 'UNEXPECTED_TARGET_GATEWAY_ROUTES', 'TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY', 'INVALID_ROUTE_CONFIGURATION', 'MISSING_TARGET_GATEWAY', 'INTERNET_TRAFFIC_NOT_INSPECTED', 'BLACK_HOLE_ROUTE_DETECTED', 'BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET', 'RESOURCE_MISSING_DNS_FIREWALL', 'ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT', 'FIREWALL_SUBNET_MISSING_VPCE_ENDPOINT', 'INVALID_NETWORK_ACL_ENTRY', ], ], 'ViolationTarget' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, 'pattern' => '.*', ], ],]; diff --git a/src/data/fms/2018-01-01/docs-2.json b/src/data/fms/2018-01-01/docs-2.json index 387677605b..520a097707 100644 --- a/src/data/fms/2018-01-01/docs-2.json +++ b/src/data/fms/2018-01-01/docs-2.json @@ -1108,8 +1108,8 @@ "NetworkAclEntries": { "base": null, "refs": { - "NetworkAclEntrySet$FirstEntries": "

The rules that you want to run first in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

", - "NetworkAclEntrySet$LastEntries": "

The rules that you want to run last in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

" + "NetworkAclEntrySet$FirstEntries": "

The rules that you want to run first in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

You must specify at least one first entry or one last entry in any network ACL policy.

", + "NetworkAclEntrySet$LastEntries": "

The rules that you want to run last in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

You must specify at least one first entry or one last entry in any network ACL policy.

" } }, "NetworkAclEntry": { @@ -1859,7 +1859,7 @@ "RuleOrder": { "base": null, "refs": { - "StatefulEngineOptions$RuleOrder": "

Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

" + "StatefulEngineOptions$RuleOrder": "

Indicates how to manage the order of stateful rule evaluation for the policy. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

Default: DEFAULT_ACTION_ORDER

" } }, "SecurityGroupRemediationAction": { @@ -1937,6 +1937,12 @@ "StatelessRuleGroup$Priority": "

The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

" } }, + "StreamExceptionPolicy": { + "base": null, + "refs": { + "StatefulEngineOptions$StreamExceptionPolicy": "

Indicates how Network Firewall should handle traffic when a network connection breaks midstream.

For more information, see Stream exception policy in your firewall policy in the Network Firewall Developer Guide.

Default: FMS_IGNORE

" + } + }, "Tag": { "base": "

A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. 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\"). You can add up to 50 tags to each Amazon Web Services resource.

", "refs": { diff --git a/src/data/fms/2018-01-01/docs-2.json.php b/src/data/fms/2018-01-01/docs-2.json.php index be0df475ce..c8f2c2a402 100644 --- a/src/data/fms/2018-01-01/docs-2.json.php +++ b/src/data/fms/2018-01-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.

Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager.

', 'operations' => [ 'AssociateAdminAccount' => '

Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect.

For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

', 'AssociateThirdPartyFirewall' => '

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that\'s associated with your Amazon Web Services customer account.

', 'BatchAssociateResource' => '

Associate resources to a Firewall Manager resource set.

', 'BatchDisassociateResource' => '

Disassociates resources from a Firewall Manager resource set.

', 'DeleteAppsList' => '

Permanently deletes an Firewall Manager applications list.

', 'DeleteNotificationChannel' => '

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

', 'DeletePolicy' => '

Permanently deletes an Firewall Manager policy.

', 'DeleteProtocolsList' => '

Permanently deletes an Firewall Manager protocols list.

', 'DeleteResourceSet' => '

Deletes the specified ResourceSet.

', 'DisassociateAdminAccount' => '

Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request.

Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.

', 'DisassociateThirdPartyFirewall' => '

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.

', 'GetAdminAccount' => '

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.

', 'GetAdminScope' => '

Returns information about the specified account\'s administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

', 'GetAppsList' => '

Returns information about the specified Firewall Manager applications list.

', 'GetComplianceDetail' => '

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy.

The reasons for resources being considered compliant depend on the Firewall Manager policy type.

', 'GetNotificationChannel' => '

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

', 'GetPolicy' => '

Returns information about the specified Firewall Manager policy.

', 'GetProtectionStatus' => '

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

', 'GetProtocolsList' => '

Returns information about the specified Firewall Manager protocols list.

', 'GetResourceSet' => '

Gets information about a specific resource set.

', 'GetThirdPartyFirewallAssociationStatus' => '

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

', 'GetViolationDetails' => '

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

', 'ListAdminAccountsForOrganization' => '

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.

This operation can be called only from the organization\'s management account.

', 'ListAdminsManagingAccount' => '

Lists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope.

', 'ListAppsLists' => '

Returns an array of AppsListDataSummary objects.

', 'ListComplianceStatus' => '

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

', 'ListDiscoveredResources' => '

Returns an array of resources in the organization\'s accounts that are available to be associated with a resource set.

', 'ListMemberAccounts' => '

Returns a MemberAccounts object that lists the member accounts in the administrator\'s Amazon Web Services organization.

Either an Firewall Manager administrator or the organization\'s management account can make this request.

', 'ListPolicies' => '

Returns an array of PolicySummary objects.

', 'ListProtocolsLists' => '

Returns an array of ProtocolsListDataSummary objects.

', 'ListResourceSetResources' => '

Returns an array of resources that are currently associated to a resource set.

', 'ListResourceSets' => '

Returns an array of ResourceSetSummary objects.

', 'ListTagsForResource' => '

Retrieves the list of tags for the specified Amazon Web Services resource.

', 'ListThirdPartyFirewallFirewallPolicies' => '

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator\'s account.

', 'PutAdminAccount' => '

Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization\'s management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn\'t a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

', 'PutAppsList' => '

Creates an Firewall Manager applications list.

', 'PutNotificationChannel' => '

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.

To perform this action outside of the console, you must first configure the SNS topic\'s access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.

', 'PutPolicy' => '

Creates an Firewall Manager policy.

A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

Firewall Manager provides the following types of policies:

', 'PutProtocolsList' => '

Creates an Firewall Manager protocols list.

', 'PutResourceSet' => '

Creates the resource set.

An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

', 'TagResource' => '

Adds one or more tags to an Amazon Web Services resource.

', 'UntagResource' => '

Removes one or more tags from an Amazon Web Services resource.

', ], 'shapes' => [ 'AWSAccountId' => [ 'base' => NULL, 'refs' => [ 'AWSAccountIdList$member' => NULL, 'AccountIdList$member' => NULL, 'AdminAccountSummary$AdminAccount' => '

The Amazon Web Services account ID of the Firewall Manager administrator\'s account.

', 'AssociateAdminAccountRequest$AdminAccount' => '

The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager default administrator account. This account must be a member account of the organization in Organizations whose resources you want to protect. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

', 'DiscoveredResource$AccountId' => '

The Amazon Web Services account ID associated with the discovered resource.

', 'GetAdminAccountResponse$AdminAccount' => '

The account that is set as the Firewall Manager default administrator.

', 'GetAdminScopeRequest$AdminAccount' => '

The administrator account that you want to get the details for.

', 'GetComplianceDetailRequest$MemberAccount' => '

The Amazon Web Services account that owns the resources that you want to get the details for.

', 'GetProtectionStatusRequest$MemberAccountId' => '

The Amazon Web Services account that is in scope of the policy that you want to get the details for.

', 'GetProtectionStatusResponse$AdminAccountId' => '

The ID of the Firewall Manager administrator account for this policy.

', 'GetViolationDetailsRequest$MemberAccount' => '

The Amazon Web Services account ID that you want the details for.

', 'MemberAccounts$member' => NULL, 'PolicyComplianceDetail$PolicyOwner' => '

The Amazon Web Services account that created the Firewall Manager policy.

', 'PolicyComplianceDetail$MemberAccount' => '

The Amazon Web Services account ID.

', 'PolicyComplianceStatus$PolicyOwner' => '

The Amazon Web Services account that created the Firewall Manager policy.

', 'PolicyComplianceStatus$MemberAccount' => '

The member account ID.

', 'PutAdminAccountRequest$AdminAccount' => '

The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

', 'Resource$AccountId' => '

The Amazon Web Services account ID that the associated resource belongs to.

', 'ViolationDetail$MemberAccount' => '

The Amazon Web Services account that the violation details were requested for.

', ], ], 'AWSAccountIdList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesRequest$MemberAccountIds' => '

The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

', ], ], 'AWSRegion' => [ 'base' => NULL, 'refs' => [ 'AWSRegionList$member' => NULL, ], ], 'AWSRegionList' => [ 'base' => NULL, 'refs' => [ 'RegionScope$Regions' => '

The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

', ], ], 'AccountIdList' => [ 'base' => NULL, 'refs' => [ 'AccountScope$Accounts' => '

The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.

', 'ListAdminsManagingAccountResponse$AdminAccounts' => '

The list of accounts who manage member accounts within their AdminScope.

', ], ], 'AccountRoleStatus' => [ 'base' => NULL, 'refs' => [ 'GetAdminAccountResponse$RoleStatus' => '

The status of the account that you set as the Firewall Manager default administrator.

', ], ], 'AccountScope' => [ 'base' => '

Configures the accounts within the administrator\'s Organizations organization that the specified Firewall Manager administrator can apply policies to.

', 'refs' => [ 'AdminScope$AccountScope' => '

Defines the accounts that the specified Firewall Manager administrator can apply policies to.

', ], ], 'ActionTarget' => [ 'base' => '

Describes a remediation action target.

', 'refs' => [ 'CreateNetworkAclAction$Vpc' => '

The VPC that\'s associated with the remediation action.

', 'CreateNetworkAclEntriesAction$NetworkAclId' => '

The network ACL that\'s associated with the remediation action.

', 'DeleteNetworkAclEntriesAction$NetworkAclId' => '

The network ACL that\'s associated with the remediation action.

', 'EC2AssociateRouteTableAction$RouteTableId' => '

The ID of the EC2 route table that is associated with the remediation action.

', 'EC2AssociateRouteTableAction$SubnetId' => '

The ID of the subnet for the EC2 route table that is associated with the remediation action.

', 'EC2AssociateRouteTableAction$GatewayId' => '

The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.

', 'EC2CopyRouteTableAction$VpcId' => '

The VPC ID of the copied EC2 route table that is associated with the remediation action.

', 'EC2CopyRouteTableAction$RouteTableId' => '

The ID of the copied EC2 route table that is associated with the remediation action.

', 'EC2CreateRouteAction$VpcEndpointId' => '

Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

', 'EC2CreateRouteAction$GatewayId' => '

Information about the ID of an internet gateway or virtual private gateway attached to your VPC.

', 'EC2CreateRouteAction$RouteTableId' => '

Information about the ID of the route table for the route.

', 'EC2CreateRouteTableAction$VpcId' => '

Information about the ID of a VPC.

', 'EC2DeleteRouteAction$RouteTableId' => '

Information about the ID of the route table.

', 'EC2ReplaceRouteAction$GatewayId' => '

Information about the ID of an internet gateway or virtual private gateway.

', 'EC2ReplaceRouteAction$RouteTableId' => '

Information about the ID of the route table.

', 'EC2ReplaceRouteTableAssociationAction$AssociationId' => '

Information about the association ID.

', 'EC2ReplaceRouteTableAssociationAction$RouteTableId' => '

Information about the ID of the new route table to associate with the subnet.

', 'ReplaceNetworkAclAssociationAction$AssociationId' => NULL, 'ReplaceNetworkAclAssociationAction$NetworkAclId' => '

The network ACL that\'s associated with the remediation action.

', ], ], 'AdminAccountSummary' => [ 'base' => '

Contains high level information about the Firewall Manager administrator account.

', 'refs' => [ 'AdminAccountSummaryList$member' => NULL, ], ], 'AdminAccountSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAdminAccountsForOrganizationResponse$AdminAccounts' => '

A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.

', ], ], 'AdminScope' => [ 'base' => '

Defines the resources that the Firewall Manager administrator can manage. For more information about administrative scope, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

', 'refs' => [ 'GetAdminScopeResponse$AdminScope' => '

Contains details about the administrative scope of the requested account.

', 'PutAdminAccountRequest$AdminScope' => '

Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.

', ], ], 'App' => [ 'base' => '

An individual Firewall Manager application.

', 'refs' => [ 'AppsList$member' => NULL, ], ], 'AppsList' => [ 'base' => NULL, 'refs' => [ 'AppsListData$AppsList' => '

An array of applications in the Firewall Manager applications list.

', 'AppsListDataSummary$AppsList' => '

An array of App objects in the Firewall Manager applications list.

', 'PreviousAppsList$value' => NULL, ], ], 'AppsListData' => [ 'base' => '

An Firewall Manager applications list.

', 'refs' => [ 'GetAppsListResponse$AppsList' => '

Information about the specified Firewall Manager applications list.

', 'PutAppsListRequest$AppsList' => '

The details of the Firewall Manager applications list to be created.

', 'PutAppsListResponse$AppsList' => '

The details of the Firewall Manager applications list.

', ], ], 'AppsListDataSummary' => [ 'base' => '

Details of the Firewall Manager applications list.

', 'refs' => [ 'AppsListsData$member' => NULL, ], ], 'AppsListsData' => [ 'base' => NULL, 'refs' => [ 'ListAppsListsResponse$AppsLists' => '

An array of AppsListDataSummary objects.

', ], ], 'AssociateAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateThirdPartyFirewallRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateThirdPartyFirewallResponse' => [ 'base' => NULL, 'refs' => [], ], 'AwsEc2InstanceViolation' => [ 'base' => '

Violation detail for an EC2 instance resource.

', 'refs' => [ 'ResourceViolation$AwsEc2InstanceViolation' => '

Violation detail for an EC2 instance.

', ], ], 'AwsEc2NetworkInterfaceViolation' => [ 'base' => '

Violation detail for network interfaces associated with an EC2 instance.

', 'refs' => [ 'AwsEc2NetworkInterfaceViolations$member' => NULL, 'ResourceViolation$AwsEc2NetworkInterfaceViolation' => '

Violation detail for a network interface.

', ], ], 'AwsEc2NetworkInterfaceViolations' => [ 'base' => NULL, 'refs' => [ 'AwsEc2InstanceViolation$AwsEc2NetworkInterfaceViolations' => '

Violation detail for network interfaces associated with the EC2 instance.

', ], ], 'AwsVPCSecurityGroupViolation' => [ 'base' => '

Violation detail for the rule violation in a security group when compared to the primary security group of the Firewall Manager policy.

', 'refs' => [ 'ResourceViolation$AwsVPCSecurityGroupViolation' => '

Violation detail for security groups.

', ], ], 'Base62Id' => [ 'base' => NULL, 'refs' => [ 'DeleteResourceSetRequest$Identifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'GetResourceSetRequest$Identifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'ResourceSet$Id' => '

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'ResourceSetIds$member' => NULL, 'ResourceSetSummary$Id' => '

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', ], ], 'BasicInteger' => [ 'base' => NULL, 'refs' => [ 'DnsRuleGroupLimitExceededViolation$NumberOfRuleGroupsAlreadyAssociated' => '

The number of rule groups currently associated with the VPC.

', 'RemediationActionWithOrder$Order' => '

The order of the remediation actions in the list.

', ], ], 'BatchAssociateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchAssociateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AccountScope$AllAccountsEnabled' => '

A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.

', 'AccountScope$ExcludeSpecifiedAccounts' => '

A boolean value that excludes the accounts in AccountScope$Accounts from the administrator\'s scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.

', 'AdminAccountSummary$DefaultAdmin' => '

A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

', 'CreateNetworkAclAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'CreateNetworkAclEntriesAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'DeleteNetworkAclEntriesAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'DeletePolicyRequest$DeleteAllPolicyResources' => '

If True, the request performs cleanup according to the policy type.

For WAF and Shield Advanced policies, the cleanup does the following:

For security group policies, the cleanup does the following for each security group in the policy:

For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren\'t associated with any other resources through another policy.

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don\'t specify tags or accounts, all resources are in scope.

', 'EvaluationResult$EvaluationLimitExceeded' => '

Indicates that over 100 resources are noncompliant with the Firewall Manager policy.

', 'GetAppsListRequest$DefaultList' => '

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

', 'GetProtocolsListRequest$DefaultList' => '

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

', 'ListAppsListsRequest$DefaultLists' => '

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

', 'ListProtocolsListsRequest$DefaultLists' => '

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$IsRouteTableUsedInDifferentAZ' => '

Information about whether the route table is used in another Availability Zone.

', 'NetworkFirewallInvalidRouteConfigurationViolation$IsRouteTableUsedInDifferentAZ' => '

Information about whether the route table is used in another Availability Zone.

', 'OrganizationalUnitScope$AllOrganizationalUnitsEnabled' => '

A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in OrganizationalUnitScope$OrganizationalUnits. You cannot specify both.

', 'OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits' => '

A boolean value that excludes the OUs in OrganizationalUnitScope$OrganizationalUnits from the administrator\'s scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed in OrganizationalUnitScope$OrganizationalUnits. You can either specify a list of OUs to exclude by OrganizationalUnitScope$OrganizationalUnits, or you can enable management of all OUs by OrganizationalUnitScope$AllOrganizationalUnitsEnabled. You cannot specify both.

', 'Policy$ExcludeResourceTags' => '

If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

', 'Policy$RemediationEnabled' => '

Indicates if the policy should be automatically applied to new resources.

', 'Policy$DeleteUnusedFMManagedResources' => '

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn\'t remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

', 'PolicyComplianceDetail$EvaluationLimitExceeded' => '

Indicates if over 100 resources are noncompliant with the Firewall Manager policy.

', 'PolicySummary$RemediationEnabled' => '

Indicates if the policy should be automatically applied to new resources.

', 'PolicySummary$DeleteUnusedFMManagedResources' => '

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn\'t remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

', 'PolicyTypeScope$AllPolicyTypesEnabled' => '

Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.

', 'PossibleRemediationAction$IsDefaultAction' => '

Information about whether an action is taken by default.

', 'RegionScope$AllRegionsEnabled' => '

Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.

', 'ReplaceNetworkAclAssociationAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'SecurityGroupRemediationAction$IsDefaultAction' => '

Indicates if the current action is the default action.

', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntry$Egress' => '

Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it\'s not an egress rule, then it\'s an ingress, or inbound, rule.

', 'NetworkAclEntrySet$ForceRemediateForFirstEntries' => '

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Network access control list (ACL) policies in the Firewall Manager Developer Guide.

', 'NetworkAclEntrySet$ForceRemediateForLastEntries' => '

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Network access control list (ACL) policies in the Firewall Manager Developer Guide.

', ], ], 'CIDR' => [ 'base' => NULL, 'refs' => [ 'EC2CreateRouteAction$DestinationCidrBlock' => '

Information about the IPv4 CIDR address block used for the destination match.

', 'EC2CreateRouteAction$DestinationIpv6CidrBlock' => '

Information about the IPv6 CIDR block destination.

', 'EC2DeleteRouteAction$DestinationCidrBlock' => '

Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

', 'EC2DeleteRouteAction$DestinationIpv6CidrBlock' => '

Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

', 'EC2ReplaceRouteAction$DestinationCidrBlock' => '

Information about the IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

', 'EC2ReplaceRouteAction$DestinationIpv6CidrBlock' => '

Information about the IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

', 'ExpectedRoute$IpV4Cidr' => '

Information about the IPv4 CIDR block.

', 'ExpectedRoute$PrefixListId' => '

Information about the ID of the prefix list for the route.

', 'ExpectedRoute$IpV6Cidr' => '

Information about the IPv6 CIDR block.

', 'SecurityGroupRuleDescription$IPV4Range' => '

The IPv4 ranges for the security group rule.

', 'SecurityGroupRuleDescription$IPV6Range' => '

The IPv6 ranges for the security group rule.

', ], ], 'ComplianceViolator' => [ 'base' => '

Details of the resource that is not protected by the policy.

', 'refs' => [ 'ComplianceViolators$member' => NULL, ], ], 'ComplianceViolatorMetadata' => [ 'base' => NULL, 'refs' => [ 'ComplianceViolator$Metadata' => '

Metadata about the resource that doesn\'t comply with the policy scope.

', ], ], 'ComplianceViolators' => [ 'base' => NULL, 'refs' => [ 'PolicyComplianceDetail$Violators' => '

An array of resources that aren\'t protected by the WAF or Shield Advanced policy or that aren\'t in compliance with the security group policy.

', ], ], 'CreateNetworkAclAction' => [ 'base' => '

Information about the CreateNetworkAcl action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$CreateNetworkAclAction' => '

Information about the CreateNetworkAcl action in Amazon EC2.

', ], ], 'CreateNetworkAclEntriesAction' => [ 'base' => '

Information about the CreateNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$CreateNetworkAclEntriesAction' => '

Information about the CreateNetworkAclEntries action in Amazon EC2.

', ], ], 'CustomerPolicyScopeId' => [ 'base' => NULL, 'refs' => [ 'CustomerPolicyScopeIdList$member' => NULL, ], ], 'CustomerPolicyScopeIdList' => [ 'base' => NULL, 'refs' => [ 'CustomerPolicyScopeMap$value' => NULL, ], ], 'CustomerPolicyScopeIdType' => [ 'base' => NULL, 'refs' => [ 'CustomerPolicyScopeMap$key' => NULL, ], ], 'CustomerPolicyScopeMap' => [ 'base' => NULL, 'refs' => [ 'Policy$IncludeMap' => '

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

', 'Policy$ExcludeMap' => '

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

', ], ], 'CustomerPolicyStatus' => [ 'base' => NULL, 'refs' => [ 'Policy$PolicyStatus' => '

Indicates whether the policy is in or out of an admin\'s policy or Region scope.

', 'PolicySummary$PolicyStatus' => '

Indicates whether the policy is in or out of an admin\'s policy or Region scope.

', ], ], 'DeleteAppsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNetworkAclEntriesAction' => [ 'base' => '

Information about the DeleteNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$DeleteNetworkAclEntriesAction' => '

Information about the DeleteNetworkAclEntries action in Amazon EC2.

', ], ], 'DeleteNotificationChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProtocolsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DependentServiceName' => [ 'base' => NULL, 'refs' => [ 'IssueInfoMap$key' => NULL, ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ResourceSet$Description' => '

A description of the resource set.

', 'ResourceSetSummary$Description' => '

A description of the resource set.

', ], ], 'DestinationType' => [ 'base' => NULL, 'refs' => [ 'Route$DestinationType' => '

The type of destination for the route.

', ], ], 'DetailedInfo' => [ 'base' => NULL, 'refs' => [ 'IssueInfoMap$value' => NULL, ], ], 'DisassociateAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateThirdPartyFirewallRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateThirdPartyFirewallResponse' => [ 'base' => NULL, 'refs' => [], ], 'DiscoveredResource' => [ 'base' => '

A resource in the organization that\'s available to be associated with a Firewall Manager resource set.

', 'refs' => [ 'DiscoveredResourceList$member' => NULL, ], ], 'DiscoveredResourceList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesResponse$Items' => '

Details of the resources that were discovered.

', ], ], 'DnsDuplicateRuleGroupViolation' => [ 'base' => '

A DNS Firewall rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can\'t be associated again.

', 'refs' => [ 'ResourceViolation$DnsDuplicateRuleGroupViolation' => '

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can\'t be associated again.

', ], ], 'DnsRuleGroupLimitExceededViolation' => [ 'base' => '

The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed due to the limit.

', 'refs' => [ 'ResourceViolation$DnsRuleGroupLimitExceededViolation' => '

Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.

', ], ], 'DnsRuleGroupPriorities' => [ 'base' => NULL, 'refs' => [ 'DnsRuleGroupPriorityConflictViolation$UnavailablePriorities' => '

The priorities of rule groups that are already associated with the VPC. To retry your operation, choose priority settings that aren\'t in this list for the rule groups in your new DNS Firewall policy.

', ], ], 'DnsRuleGroupPriority' => [ 'base' => NULL, 'refs' => [ 'DnsRuleGroupPriorities$member' => NULL, 'DnsRuleGroupPriorityConflictViolation$ConflictingPriority' => '

The priority setting of the two conflicting rule groups.

', ], ], 'DnsRuleGroupPriorityConflictViolation' => [ 'base' => '

A rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that\'s already associated.

', 'refs' => [ 'ResourceViolation$DnsRuleGroupPriorityConflictViolation' => '

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that\'s already associated.

', ], ], 'EC2AssociateRouteTableAction' => [ 'base' => '

The action of associating an EC2 resource, such as a subnet or internet gateway, with a route table.

', 'refs' => [ 'RemediationAction$EC2AssociateRouteTableAction' => '

Information about the AssociateRouteTable action in the Amazon EC2 API.

', ], ], 'EC2CopyRouteTableAction' => [ 'base' => '

An action that copies the EC2 route table for use in remediation.

', 'refs' => [ 'RemediationAction$EC2CopyRouteTableAction' => '

Information about the CopyRouteTable action in the Amazon EC2 API.

', ], ], 'EC2CreateRouteAction' => [ 'base' => '

Information about the CreateRoute action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2CreateRouteAction' => '

Information about the CreateRoute action in the Amazon EC2 API.

', ], ], 'EC2CreateRouteTableAction' => [ 'base' => '

Information about the CreateRouteTable action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2CreateRouteTableAction' => '

Information about the CreateRouteTable action in the Amazon EC2 API.

', ], ], 'EC2DeleteRouteAction' => [ 'base' => '

Information about the DeleteRoute action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2DeleteRouteAction' => '

Information about the DeleteRoute action in the Amazon EC2 API.

', ], ], 'EC2ReplaceRouteAction' => [ 'base' => '

Information about the ReplaceRoute action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2ReplaceRouteAction' => '

Information about the ReplaceRoute action in the Amazon EC2 API.

', ], ], 'EC2ReplaceRouteTableAssociationAction' => [ 'base' => '

Information about the ReplaceRouteTableAssociation action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2ReplaceRouteTableAssociationAction' => '

Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.

', ], ], 'EntriesDescription' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkAclEntriesAction$NetworkAclEntriesToBeCreated' => '

Lists the entries that the remediation action would create.

', 'DeleteNetworkAclEntriesAction$NetworkAclEntriesToBeDeleted' => '

Lists the entries that the remediation action would delete.

', ], ], 'EntriesWithConflicts' => [ 'base' => NULL, 'refs' => [ 'EntryViolation$EntriesWithConflicts' => '

The list of entries that are in conflict with ExpectedEntry.

', ], ], 'EntryDescription' => [ 'base' => '

Describes a single rule in a network ACL.

', 'refs' => [ 'EntriesDescription$member' => NULL, 'EntriesWithConflicts$member' => NULL, 'EntryViolation$ExpectedEntry' => '

The Firewall Manager-managed network ACL entry that is involved in the entry violation.

', 'EntryViolation$EntryAtExpectedEvaluationOrder' => '

The entry that\'s currently in the ExpectedEvaluationOrder location, in place of the expected entry.

', ], ], 'EntryType' => [ 'base' => NULL, 'refs' => [ 'EntryDescription$EntryType' => '

Specifies whether the entry is managed by Firewall Manager or by a user, and, for Firewall Manager-managed entries, specifies whether the entry is among those that run first in the network ACL or those that run last.

', ], ], 'EntryViolation' => [ 'base' => '

Detailed information about an entry violation in a network ACL. The violation is against the network ACL specification inside the Firewall Manager network ACL policy. This data object is part of InvalidNetworkAclEntriesViolation.

', 'refs' => [ 'EntryViolations$member' => NULL, ], ], 'EntryViolationReason' => [ 'base' => NULL, 'refs' => [ 'EntryViolationReasons$member' => NULL, ], ], 'EntryViolationReasons' => [ 'base' => NULL, 'refs' => [ 'EntryViolation$EntryViolationReasons' => '

Descriptions of the violations that Firewall Manager found for these entries.

', ], ], 'EntryViolations' => [ 'base' => NULL, 'refs' => [ 'InvalidNetworkAclEntriesViolation$EntryViolations' => '

Detailed information about the entry violations in the network ACL.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InternalErrorException$Message' => NULL, 'InvalidInputException$Message' => NULL, 'InvalidOperationException$Message' => NULL, 'InvalidTypeException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, ], ], 'EvaluationResult' => [ 'base' => '

Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don\'t comply with the policy.

', 'refs' => [ 'EvaluationResults$member' => NULL, ], ], 'EvaluationResults' => [ 'base' => NULL, 'refs' => [ 'PolicyComplianceStatus$EvaluationResults' => '

An array of EvaluationResult objects.

', ], ], 'ExpectedRoute' => [ 'base' => '

Information about the expected route in the route table.

', 'refs' => [ 'ExpectedRoutes$member' => NULL, ], ], 'ExpectedRoutes' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallInternetTrafficNotInspectedViolation$ExpectedFirewallSubnetRoutes' => '

The firewall subnet routes that are expected.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ExpectedInternetGatewayRoutes' => '

The internet gateway routes that are expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedFirewallSubnetRoutes' => '

The firewall subnet routes that are expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedInternetGatewayRoutes' => '

The expected routes for the internet gateway.

', 'NetworkFirewallMissingExpectedRoutesViolation$ExpectedRoutes' => '

The expected routes.

', ], ], 'FMSPolicyUpdateFirewallCreationConfigAction' => [ 'base' => '

Contains information about the actions that you can take to remediate scope violations caused by your policy\'s FirewallCreationConfig. FirewallCreationConfig is an optional configuration that you can use to choose which Availability Zones Firewall Manager creates Network Firewall endpoints in.

', 'refs' => [ 'RemediationAction$FMSPolicyUpdateFirewallCreationConfigAction' => '

The remedial action to take when updating a firewall configuration.

', ], ], 'FailedItem' => [ 'base' => '

Details of a resource that failed when trying to update it\'s association to a resource set.

', 'refs' => [ 'FailedItemList$member' => NULL, ], ], 'FailedItemList' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateResourceResponse$FailedItems' => '

The resources that failed to associate to the resource set.

', 'BatchDisassociateResourceResponse$FailedItems' => '

The resources that failed to disassociate from the resource set.

', ], ], 'FailedItemReason' => [ 'base' => NULL, 'refs' => [ 'FailedItem$Reason' => '

The reason the resource\'s association could not be updated.

', ], ], 'FirewallDeploymentModel' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicy$FirewallDeploymentModel' => '

Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to NULL.

', 'ThirdPartyFirewallPolicy$FirewallDeploymentModel' => '

Defines the deployment model to use for the third-party firewall policy.

', ], ], 'FirewallPolicyId' => [ 'base' => NULL, 'refs' => [ 'ThirdPartyFirewallFirewallPolicy$FirewallPolicyId' => '

The ID of the specified firewall policy.

', ], ], 'FirewallPolicyName' => [ 'base' => NULL, 'refs' => [ 'ThirdPartyFirewallFirewallPolicy$FirewallPolicyName' => '

The name of the specified firewall policy.

', ], ], 'FirewallSubnetIsOutOfScopeViolation' => [ 'base' => '

Contains details about the firewall subnet that violates the policy scope.

', 'refs' => [ 'ResourceViolation$FirewallSubnetIsOutOfScopeViolation' => '

Contains details about the firewall subnet that violates the policy scope.

', ], ], 'FirewallSubnetMissingVPCEndpointViolation' => [ 'base' => '

The violation details for a firewall subnet\'s VPC endpoint that\'s deleted or missing.

', 'refs' => [ 'ResourceViolation$FirewallSubnetMissingVPCEndpointViolation' => '

The violation details for a third-party firewall\'s VPC endpoint subnet that was deleted.

', ], ], 'GetAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAdminAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAdminScopeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAdminScopeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAppsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAppsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetComplianceDetailRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetComplianceDetailResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNotificationChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNotificationChannelResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProtectionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProtectionStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProtocolsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProtocolsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetThirdPartyFirewallAssociationStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetThirdPartyFirewallAssociationStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetViolationDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetViolationDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'IPPortNumber' => [ 'base' => NULL, 'refs' => [ 'App$Port' => '

The application\'s port number, for example 80.

', 'SecurityGroupRuleDescription$FromPort' => '

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

', 'SecurityGroupRuleDescription$ToPort' => '

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes.

', ], ], 'IPPortNumberInteger' => [ 'base' => NULL, 'refs' => [ 'NetworkAclPortRange$From' => '

The beginning port number of the range.

', 'NetworkAclPortRange$To' => '

The ending port number of the range.

', ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateResourceRequest$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'BatchAssociateResourceResponse$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'BatchDisassociateResourceRequest$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'BatchDisassociateResourceResponse$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'DiscoveredResource$URI' => '

The universal resource identifier (URI) of the discovered resource.

', 'FailedItem$URI' => '

The univeral resource indicator (URI) of the resource that failed.

', 'IdentifierList$member' => NULL, 'Resource$URI' => '

The resource\'s universal resource indicator (URI).

', ], ], 'IdentifierList' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateResourceRequest$Items' => '

The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).

', 'BatchDisassociateResourceRequest$Items' => '

The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).

', ], ], 'IntegerObject' => [ 'base' => NULL, 'refs' => [ 'NetworkAclIcmpTypeCode$Code' => '

ICMP code.

', 'NetworkAclIcmpTypeCode$Type' => '

ICMP type.

', ], ], 'IntegerObjectMinimum0' => [ 'base' => NULL, 'refs' => [ 'EntryDescription$EntryRuleNumber' => '

The rule number for the entry. ACL entries are processed in ascending order by rule number. In a Firewall Manager network ACL policy, Firewall Manager assigns rule numbers.

', ], ], 'InternalErrorException' => [ 'base' => '

The operation failed because of a system problem, even though the request was valid. Retry your request.

', 'refs' => [], ], 'InvalidInputException' => [ 'base' => '

The parameters of the request were invalid.

', 'refs' => [], ], 'InvalidNetworkAclEntriesViolation' => [ 'base' => '

Violation detail for the entries in a network ACL resource.

', 'refs' => [ 'ResourceViolation$InvalidNetworkAclEntriesViolation' => '

Violation detail for the entries in a network ACL resource.

', ], ], 'InvalidOperationException' => [ 'base' => '

The operation failed because there was nothing to do or the operation wasn\'t possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that\'s disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

', 'refs' => [], ], 'InvalidTypeException' => [ 'base' => '

The value of the Type parameter is invalid.

', 'refs' => [], ], 'IssueInfoMap' => [ 'base' => NULL, 'refs' => [ 'PolicyComplianceDetail$IssueInfoMap' => '

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

', 'PolicyComplianceStatus$IssueInfoMap' => '

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

', ], ], 'LengthBoundedNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntry$CidrBlock' => '

The IPv4 network range to allow or deny, in CIDR notation.

', 'NetworkAclEntry$Ipv6CidrBlock' => '

The IPv6 network range to allow or deny, in CIDR notation.

', ], ], 'LengthBoundedString' => [ 'base' => NULL, 'refs' => [ 'ActionTarget$Description' => '

A description of the remediation action target.

', 'AwsVPCSecurityGroupViolation$ViolationTargetDescription' => '

A description of the security group that violates the policy.

', 'ComplianceViolatorMetadata$key' => NULL, 'ComplianceViolatorMetadata$value' => NULL, 'CreateNetworkAclAction$Description' => '

Brief description of this remediation action.

', 'CreateNetworkAclEntriesAction$Description' => '

Brief description of this remediation action.

', 'DeleteNetworkAclEntriesAction$Description' => '

Brief description of this remediation action.

', 'DnsDuplicateRuleGroupViolation$ViolationTargetDescription' => '

A description of the violation that specifies the rule group and VPC.

', 'DnsRuleGroupLimitExceededViolation$ViolationTargetDescription' => '

A description of the violation that specifies the rule group and VPC.

', 'DnsRuleGroupPriorityConflictViolation$ViolationTargetDescription' => '

A description of the violation that specifies the VPC and the rule group that\'s already associated with it.

', 'EC2AssociateRouteTableAction$Description' => '

A description of the EC2 route table that is associated with the remediation action.

', 'EC2CopyRouteTableAction$Description' => '

A description of the copied EC2 route table that is associated with the remediation action.

', 'EC2CreateRouteAction$Description' => '

A description of CreateRoute action in Amazon EC2.

', 'EC2CreateRouteTableAction$Description' => '

A description of the CreateRouteTable action.

', 'EC2DeleteRouteAction$Description' => '

A description of the DeleteRoute action.

', 'EC2ReplaceRouteAction$Description' => '

A description of the ReplaceRoute action in Amazon EC2.

', 'EC2ReplaceRouteTableAssociationAction$Description' => '

A description of the ReplaceRouteTableAssociation action in Amazon EC2.

', 'EntryViolation$ExpectedEvaluationOrder' => '

The evaluation location within the ordered list of entries where the ExpectedEntry should be, according to the network ACL policy specifications.

', 'EntryViolation$ActualEvaluationOrder' => '

The evaluation location within the ordered list of entries where the ExpectedEntry is currently located.

', 'FMSPolicyUpdateFirewallCreationConfigAction$Description' => '

Describes the remedial action.

', 'FirewallSubnetIsOutOfScopeViolation$SubnetAvailabilityZone' => '

The Availability Zone of the firewall subnet that violates the policy scope.

', 'FirewallSubnetIsOutOfScopeViolation$SubnetAvailabilityZoneId' => '

The Availability Zone ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetMissingVPCEndpointViolation$SubnetAvailabilityZone' => '

The name of the Availability Zone of the deleted VPC subnet.

', 'FirewallSubnetMissingVPCEndpointViolation$SubnetAvailabilityZoneId' => '

The ID of the Availability Zone of the deleted VPC subnet.

', 'InvalidNetworkAclEntriesViolation$SubnetAvailabilityZone' => '

The Availability Zone where the network ACL is in use.

', 'LengthBoundedStringList$member' => NULL, 'NetworkAclEntry$Protocol' => '

The protocol number. A value of "-1" means all protocols.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$SubnetAvailabilityZone' => '

The subnet Availability Zone.

', 'NetworkFirewallMissingExpectedRTViolation$AvailabilityZone' => '

The Availability Zone of a violating subnet.

', 'NetworkFirewallMissingFirewallViolation$AvailabilityZone' => '

The Availability Zone of a violating subnet.

', 'NetworkFirewallMissingSubnetViolation$AvailabilityZone' => '

The Availability Zone of a violating subnet.

', 'PossibleRemediationAction$Description' => '

A description of the list of remediation actions.

', 'PossibleRemediationActions$Description' => '

A description of the possible remediation actions list.

', 'RemediationAction$Description' => '

A description of a remediation action.

', 'ReplaceNetworkAclAssociationAction$Description' => '

Brief description of this remediation action.

', 'Route$Destination' => '

The destination of the route.

', 'Route$Target' => '

The route\'s target.

', 'RouteHasOutOfScopeEndpointViolation$SubnetAvailabilityZone' => '

The subnet\'s Availability Zone.

', 'RouteHasOutOfScopeEndpointViolation$SubnetAvailabilityZoneId' => '

The ID of the subnet\'s Availability Zone.

', 'SecurityGroupRuleDescription$Protocol' => '

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$AvailabilityZone' => '

The Availability Zone of the firewall subnet that\'s causing the violation.

', 'ThirdPartyFirewallMissingFirewallViolation$AvailabilityZone' => '

The Availability Zone of the third-party firewall that\'s causing the violation.

', 'ThirdPartyFirewallMissingSubnetViolation$AvailabilityZone' => '

The Availability Zone of a subnet that\'s causing the violation.

', 'ViolationDetail$ResourceDescription' => '

Brief description for the requested resource.

', ], ], 'LengthBoundedStringList' => [ 'base' => NULL, 'refs' => [ 'ExpectedRoute$AllowedTargets' => '

Information about the allowed targets.

', ], ], 'LimitExceededException' => [ 'base' => '

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

', 'refs' => [], ], 'ListAdminAccountsForOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAdminAccountsForOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAdminsManagingAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAdminsManagingAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListComplianceStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListComplianceStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDiscoveredResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDiscoveredResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListId' => [ 'base' => NULL, 'refs' => [ 'AppsListData$ListId' => '

The ID of the Firewall Manager applications list.

', 'AppsListDataSummary$ListId' => '

The ID of the applications list.

', 'DeleteAppsListRequest$ListId' => '

The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList.

', 'DeleteProtocolsListRequest$ListId' => '

The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.

', 'GetAppsListRequest$ListId' => '

The ID of the Firewall Manager applications list that you want the details for.

', 'GetProtocolsListRequest$ListId' => '

The ID of the Firewall Manager protocols list that you want the details for.

', 'ProtocolsListData$ListId' => '

The ID of the Firewall Manager protocols list.

', 'ProtocolsListDataSummary$ListId' => '

The ID of the specified protocols list.

', ], ], 'ListMemberAccountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMemberAccountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProtocolsListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProtocolsListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThirdPartyFirewallFirewallPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThirdPartyFirewallFirewallPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ManagedServiceData' => [ 'base' => NULL, 'refs' => [ 'FMSPolicyUpdateFirewallCreationConfigAction$FirewallCreationConfig' => '

A FirewallCreationConfig that you can copy into your current policy\'s SecurityServiceData in order to remedy scope violations.

', 'SecurityServicePolicyData$ManagedServiceData' => '

Details about the service that are specific to the service type, in JSON format.

', ], ], 'MarketplaceSubscriptionOnboardingStatus' => [ 'base' => NULL, 'refs' => [ 'GetThirdPartyFirewallAssociationStatusResponse$MarketplaceOnboardingStatus' => '

The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.

', ], ], 'MemberAccounts' => [ 'base' => NULL, 'refs' => [ 'ListMemberAccountsResponse$MemberAccounts' => '

An array of account IDs.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ResourceSet$Name' => '

The descriptive name of the resource set. You can\'t change the name of a resource set after you create it.

', 'ResourceSetSummary$Name' => '

The descriptive name of the resource set. You can\'t change the name of a resource set after you create it.

', ], ], 'NetworkAclCommonPolicy' => [ 'base' => '

Defines a Firewall Manager network ACL policy. This is used in the PolicyOption of a SecurityServicePolicyData for a Policy, when the SecurityServicePolicyData type is set to NETWORK_ACL_COMMON.

For information about network ACLs, see Control traffic to subnets using network ACLs in the Amazon Virtual Private Cloud User Guide.

', 'refs' => [ 'PolicyOption$NetworkAclCommonPolicy' => '

Defines a Firewall Manager network ACL policy.

', ], ], 'NetworkAclEntries' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntrySet$FirstEntries' => '

The rules that you want to run first in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

', 'NetworkAclEntrySet$LastEntries' => '

The rules that you want to run last in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

', ], ], 'NetworkAclEntry' => [ 'base' => '

Describes a rule in a network ACL.

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the entries in the network ACL according to the rule numbers, in ascending order.

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

', 'refs' => [ 'EntryDescription$EntryDetail' => '

Describes a rule in a network ACL.

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the entries in the network ACL according to the rule numbers, in ascending order.

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

', 'NetworkAclEntries$member' => NULL, ], ], 'NetworkAclEntrySet' => [ 'base' => '

The configuration of the first and last rules for the network ACL policy, and the remediation settings for each.

', 'refs' => [ 'NetworkAclCommonPolicy$NetworkAclEntrySet' => '

The definition of the first and last rules for the network ACL policy.

', ], ], 'NetworkAclIcmpTypeCode' => [ 'base' => '

ICMP protocol: The ICMP type and code.

', 'refs' => [ 'NetworkAclEntry$IcmpTypeCode' => '

ICMP protocol: The ICMP type and code.

', ], ], 'NetworkAclPortRange' => [ 'base' => '

TCP or UDP protocols: The range of ports the rule applies to.

', 'refs' => [ 'NetworkAclEntry$PortRange' => '

TCP or UDP protocols: The range of ports the rule applies to.

', ], ], 'NetworkAclRuleAction' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntry$RuleAction' => '

Indicates whether to allow or deny the traffic that matches the rule.

', ], ], 'NetworkFirewallAction' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallActionList$member' => NULL, ], ], 'NetworkFirewallActionList' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicyDescription$StatelessDefaultActions' => '

The actions to take on packets that don\'t match any of the stateless rule groups.

', 'NetworkFirewallPolicyDescription$StatelessFragmentDefaultActions' => '

The actions to take on packet fragments that don\'t match any of the stateless rule groups.

', 'NetworkFirewallPolicyDescription$StatelessCustomActions' => '

Names of custom actions that are available for use in the stateless default actions settings.

', 'NetworkFirewallPolicyDescription$StatefulDefaultActions' => '

The default actions to take on a packet that doesn\'t match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

', ], ], 'NetworkFirewallBlackHoleRouteDetectedViolation' => [ 'base' => '

Violation detail for an internet gateway route with an inactive state in the customer subnet route table or Network Firewall subnet route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallBlackHoleRouteDetectedViolation' => NULL, ], ], 'NetworkFirewallInternetTrafficNotInspectedViolation' => [ 'base' => '

Violation detail for the subnet for which internet traffic that hasn\'t been inspected.

', 'refs' => [ 'ResourceViolation$NetworkFirewallInternetTrafficNotInspectedViolation' => '

Violation detail for the subnet for which internet traffic hasn\'t been inspected.

', ], ], 'NetworkFirewallInvalidRouteConfigurationViolation' => [ 'base' => '

Violation detail for the improperly configured subnet route. It\'s possible there is a missing route table route, or a configuration that causes traffic to cross an Availability Zone boundary.

', 'refs' => [ 'ResourceViolation$NetworkFirewallInvalidRouteConfigurationViolation' => '

The route configuration is invalid.

', ], ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'base' => '

Violation detail for Network Firewall for a subnet that\'s not associated to the expected Firewall Manager managed route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingExpectedRTViolation' => '

Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.

', ], ], 'NetworkFirewallMissingExpectedRoutesViolation' => [ 'base' => '

Violation detail for an expected route missing in Network Firewall.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingExpectedRoutesViolation' => '

Expected routes are missing from Network Firewall.

', ], ], 'NetworkFirewallMissingFirewallViolation' => [ 'base' => '

Violation detail for Network Firewall for a subnet that doesn\'t have a Firewall Manager managed firewall in its VPC.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingFirewallViolation' => '

Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.

', ], ], 'NetworkFirewallMissingSubnetViolation' => [ 'base' => '

Violation detail for Network Firewall for an Availability Zone that\'s missing the expected Firewall Manager managed subnet.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingSubnetViolation' => '

Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.

', ], ], 'NetworkFirewallOverrideAction' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallStatefulRuleGroupOverride$Action' => '

The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.

', ], ], 'NetworkFirewallPolicy' => [ 'base' => '

Configures the firewall policy deployment model of Network Firewall. For information about Network Firewall deployment models, see Network Firewall example architectures with routing in the Network Firewall Developer Guide.

', 'refs' => [ 'PolicyOption$NetworkFirewallPolicy' => '

Defines the deployment model to use for the firewall policy.

', ], ], 'NetworkFirewallPolicyDescription' => [ 'base' => '

The definition of the Network Firewall firewall policy.

', 'refs' => [ 'NetworkFirewallPolicyModifiedViolation$CurrentPolicyDescription' => '

The policy that\'s currently in use in the individual account.

', 'NetworkFirewallPolicyModifiedViolation$ExpectedPolicyDescription' => '

The policy that should be in use in the individual account in order to be compliant.

', ], ], 'NetworkFirewallPolicyModifiedViolation' => [ 'base' => '

Violation detail for Network Firewall for a firewall policy that has a different NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.

', 'refs' => [ 'ResourceViolation$NetworkFirewallPolicyModifiedViolation' => '

Violation detail for an Network Firewall policy that indicates that a firewall policy in an individual account has been modified in a way that makes it noncompliant. For example, the individual account owner might have deleted a rule group, changed the priority of a stateless rule group, or changed a policy default action.

', ], ], 'NetworkFirewallResourceName' => [ 'base' => NULL, 'refs' => [ 'StatefulRuleGroup$RuleGroupName' => '

The name of the rule group.

', 'StatelessRuleGroup$RuleGroupName' => '

The name of the rule group.

', ], ], 'NetworkFirewallStatefulRuleGroupOverride' => [ 'base' => '

The setting that allows the policy owner to change the behavior of the rule group within a policy.

', 'refs' => [ 'StatefulRuleGroup$Override' => '

The action that allows the policy owner to override the behavior of the rule group within a policy.

', ], ], 'NetworkFirewallUnexpectedFirewallRoutesViolation' => [ 'base' => '

Violation detail for an unexpected route that\'s present in a route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallUnexpectedFirewallRoutesViolation' => '

There\'s an unexpected firewall route.

', ], ], 'NetworkFirewallUnexpectedGatewayRoutesViolation' => [ 'base' => '

Violation detail for an unexpected gateway route that’s present in a route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallUnexpectedGatewayRoutesViolation' => '

There\'s an unexpected gateway route.

', ], ], 'OrderedRemediationActions' => [ 'base' => NULL, 'refs' => [ 'PossibleRemediationAction$OrderedRemediationActions' => '

The ordered list of remediation actions.

', ], ], 'OrganizationStatus' => [ 'base' => NULL, 'refs' => [ 'AdminAccountSummary$Status' => '

The current status of the request to onboard a member account as an Firewall Manager administrator.

', 'GetAdminScopeResponse$Status' => '

The current status of the request to onboard a member account as an Firewall Manager administrator.

', ], ], 'OrganizationalUnitId' => [ 'base' => NULL, 'refs' => [ 'OrganizationalUnitIdList$member' => NULL, ], ], 'OrganizationalUnitIdList' => [ 'base' => NULL, 'refs' => [ 'OrganizationalUnitScope$OrganizationalUnits' => '

The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to true, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to false, then the Firewall Manager administrator can only apply policies to the OUs in this list.

', ], ], 'OrganizationalUnitScope' => [ 'base' => '

Defines the Organizations organizational units (OUs) that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

', 'refs' => [ 'AdminScope$OrganizationalUnitScope' => '

Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

', ], ], 'PaginationMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusRequest$MaxResults' => '

Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

', 'ListAdminAccountsForOrganizationRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListAdminsManagingAccountRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListAppsListsRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify this, Firewall Manager returns all available objects.

', 'ListComplianceStatusRequest$MaxResults' => '

Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.

', 'ListDiscoveredResourcesRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListMemberAccountsRequest$MaxResults' => '

Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

', 'ListPoliciesRequest$MaxResults' => '

Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

', 'ListProtocolsListsRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify this, Firewall Manager returns all available objects.

', 'ListResourceSetResourcesRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListResourceSetsRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListThirdPartyFirewallFirewallPoliciesRequest$MaxResults' => '

The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than MaxResults firewall policies, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusRequest$NextToken' => '

If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

', 'GetProtectionStatusResponse$NextToken' => '

If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

', 'ListAdminAccountsForOrganizationRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAdminAccountsForOrganizationResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAdminsManagingAccountRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAdminsManagingAccountResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAppsListsRequest$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

', 'ListAppsListsResponse$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

', 'ListComplianceStatusRequest$NextToken' => '

If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

', 'ListComplianceStatusResponse$NextToken' => '

If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

', 'ListDiscoveredResourcesRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListDiscoveredResourcesResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListMemberAccountsRequest$NextToken' => '

If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

', 'ListMemberAccountsResponse$NextToken' => '

If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

', 'ListPoliciesRequest$NextToken' => '

If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

', 'ListPoliciesResponse$NextToken' => '

If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

', 'ListProtocolsListsRequest$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

', 'ListProtocolsListsResponse$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

', 'ListResourceSetResourcesRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListResourceSetResourcesResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListResourceSetsRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListResourceSetsResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListThirdPartyFirewallFirewallPoliciesRequest$NextToken' => '

If the previous response included a NextToken element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another ListThirdPartyFirewallFirewallPoliciesRequest request.

For the value of NextToken, specify the value of NextToken from the previous response. If the previous response didn\'t include a NextToken element, there are no more third-party firewall policies to get.

', 'ListThirdPartyFirewallFirewallPoliciesResponse$NextToken' => '

The value that you will use for NextToken in the next ListThirdPartyFirewallFirewallPolicies request.

', ], ], 'PartialMatch' => [ 'base' => '

The reference rule that partially matches the ViolationTarget rule and violation reason.

', 'refs' => [ 'PartialMatches$member' => NULL, ], ], 'PartialMatches' => [ 'base' => NULL, 'refs' => [ 'AwsVPCSecurityGroupViolation$PartialMatches' => '

List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule.

', ], ], 'Policy' => [ 'base' => '

An Firewall Manager policy.

', 'refs' => [ 'GetPolicyResponse$Policy' => '

Information about the specified Firewall Manager policy.

', 'PutPolicyRequest$Policy' => '

The details of the Firewall Manager policy to be created.

', 'PutPolicyResponse$Policy' => '

The details of the Firewall Manager policy.

', ], ], 'PolicyComplianceDetail' => [ 'base' => '

Describes the noncompliant resources in a member account for a specific Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded is set to True.

', 'refs' => [ 'GetComplianceDetailResponse$PolicyComplianceDetail' => '

Information about the resources and the policy that you specified in the GetComplianceDetail request.

', ], ], 'PolicyComplianceStatus' => [ 'base' => '

Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

', 'refs' => [ 'PolicyComplianceStatusList$member' => NULL, ], ], 'PolicyComplianceStatusList' => [ 'base' => NULL, 'refs' => [ 'ListComplianceStatusResponse$PolicyComplianceStatusList' => '

An array of PolicyComplianceStatus objects.

', ], ], 'PolicyComplianceStatusType' => [ 'base' => NULL, 'refs' => [ 'EvaluationResult$ComplianceStatus' => '

Describes an Amazon Web Services account\'s compliance with the Firewall Manager policy.

', ], ], 'PolicyId' => [ 'base' => NULL, 'refs' => [ 'DeletePolicyRequest$PolicyId' => '

The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

', 'DnsRuleGroupPriorityConflictViolation$ConflictingPolicyId' => '

The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy contains the rule group that\'s already associated with the VPC.

', 'GetComplianceDetailRequest$PolicyId' => '

The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.

', 'GetPolicyRequest$PolicyId' => '

The ID of the Firewall Manager policy that you want the details for.

', 'GetProtectionStatusRequest$PolicyId' => '

The ID of the policy for which you want to get the attack information.

', 'GetViolationDetailsRequest$PolicyId' => '

The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:

', 'ListComplianceStatusRequest$PolicyId' => '

The ID of the Firewall Manager policy that you want the details for.

', 'Policy$PolicyId' => '

The ID of the Firewall Manager policy.

', 'PolicyComplianceDetail$PolicyId' => '

The ID of the Firewall Manager policy.

', 'PolicyComplianceStatus$PolicyId' => '

The ID of the Firewall Manager policy.

', 'PolicySummary$PolicyId' => '

The ID of the specified policy.

', 'ViolationDetail$PolicyId' => '

The ID of the Firewall Manager policy that the violation details were requested for.

', ], ], 'PolicyOption' => [ 'base' => '

Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.

', 'refs' => [ 'SecurityServicePolicyData$PolicyOption' => '

Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.

', ], ], 'PolicySummary' => [ 'base' => '

Details of the Firewall Manager policy.

', 'refs' => [ 'PolicySummaryList$member' => NULL, ], ], 'PolicySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPoliciesResponse$PolicyList' => '

An array of PolicySummary objects.

', ], ], 'PolicyTypeScope' => [ 'base' => '

Defines the policy types that the specified Firewall Manager administrator can manage.

', 'refs' => [ 'AdminScope$PolicyTypeScope' => '

Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage.

', ], ], 'PolicyUpdateToken' => [ 'base' => NULL, 'refs' => [ 'Policy$PolicyUpdateToken' => '

A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

', ], ], 'PossibleRemediationAction' => [ 'base' => '

A list of remediation actions.

', 'refs' => [ 'PossibleRemediationActionList$member' => NULL, ], ], 'PossibleRemediationActionList' => [ 'base' => NULL, 'refs' => [ 'PossibleRemediationActions$Actions' => '

Information about the actions.

', ], ], 'PossibleRemediationActions' => [ 'base' => '

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

', 'refs' => [ 'ResourceViolation$PossibleRemediationActions' => '

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

', ], ], 'PreviousAppsList' => [ 'base' => NULL, 'refs' => [ 'AppsListData$PreviousAppsList' => '

A map of previous version numbers to their corresponding App object arrays.

', ], ], 'PreviousListVersion' => [ 'base' => NULL, 'refs' => [ 'PreviousAppsList$key' => NULL, 'PreviousProtocolsList$key' => NULL, ], ], 'PreviousProtocolsList' => [ 'base' => NULL, 'refs' => [ 'ProtocolsListData$PreviousProtocolsList' => '

A map of previous version numbers to their corresponding protocol arrays.

', ], ], 'PriorityNumber' => [ 'base' => NULL, 'refs' => [ 'StatefulRuleGroup$Priority' => '

An integer setting that indicates the order in which to run the stateful rule groups in a single Network Firewall firewall policy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.

Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. For information about

You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there\'s a wide range in between, for example use 100, 200, and so on.

', ], ], 'ProtectionData' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusResponse$Data' => '

Details about the attack, including the following:

The details are in JSON format.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'App$Protocol' => '

The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

', 'ProtocolsList$member' => NULL, ], ], 'ProtocolsList' => [ 'base' => NULL, 'refs' => [ 'PreviousProtocolsList$value' => NULL, 'ProtocolsListData$ProtocolsList' => '

An array of protocols in the Firewall Manager protocols list.

', 'ProtocolsListDataSummary$ProtocolsList' => '

An array of protocols in the Firewall Manager protocols list.

', ], ], 'ProtocolsListData' => [ 'base' => '

An Firewall Manager protocols list.

', 'refs' => [ 'GetProtocolsListResponse$ProtocolsList' => '

Information about the specified Firewall Manager protocols list.

', 'PutProtocolsListRequest$ProtocolsList' => '

The details of the Firewall Manager protocols list to be created.

', 'PutProtocolsListResponse$ProtocolsList' => '

The details of the Firewall Manager protocols list.

', ], ], 'ProtocolsListDataSummary' => [ 'base' => '

Details of the Firewall Manager protocols list.

', 'refs' => [ 'ProtocolsListsData$member' => NULL, ], ], 'ProtocolsListsData' => [ 'base' => NULL, 'refs' => [ 'ListProtocolsListsResponse$ProtocolsLists' => '

An array of ProtocolsListDataSummary objects.

', ], ], 'PutAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAppsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAppsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutNotificationChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutProtocolsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutProtocolsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourceSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourceSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReferenceRule' => [ 'base' => NULL, 'refs' => [ 'PartialMatch$Reference' => '

The reference rule from the primary security group of the Firewall Manager policy.

', ], ], 'RegionScope' => [ 'base' => '

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can manage.

', 'refs' => [ 'AdminScope$RegionScope' => '

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

', ], ], 'RemediationAction' => [ 'base' => '

Information about an individual action you can take to remediate a violation.

', 'refs' => [ 'RemediationActionWithOrder$RemediationAction' => '

Information about an action you can take to remediate a violation.

', ], ], 'RemediationActionDescription' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupRemediationAction$Description' => '

Brief description of the action that will be performed.

', ], ], 'RemediationActionType' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupRemediationAction$RemediationActionType' => '

The remediation action that will be performed.

', ], ], 'RemediationActionWithOrder' => [ 'base' => '

An ordered list of actions you can take to remediate a violation.

', 'refs' => [ 'OrderedRemediationActions$member' => NULL, ], ], 'ReplaceNetworkAclAssociationAction' => [ 'base' => '

Information about the ReplaceNetworkAclAssociation action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$ReplaceNetworkAclAssociationAction' => '

Information about the ReplaceNetworkAclAssociation action in Amazon EC2.

', ], ], 'Resource' => [ 'base' => '

Details of a resource that is associated to an Firewall Manager resource set.

', 'refs' => [ 'ResourceList$member' => NULL, ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AppsListDataSummary$ListArn' => '

The Amazon Resource Name (ARN) of the applications list.

', 'GetAppsListResponse$AppsListArn' => '

The Amazon Resource Name (ARN) of the applications list.

', 'GetNotificationChannelResponse$SnsTopicArn' => '

The SNS topic that records Firewall Manager activity.

', 'GetNotificationChannelResponse$SnsRoleName' => '

The IAM role that is used by Firewall Manager to record activity to SNS.

', 'GetPolicyResponse$PolicyArn' => '

The Amazon Resource Name (ARN) of the specified policy.

', 'GetProtocolsListResponse$ProtocolsListArn' => '

The Amazon Resource Name (ARN) of the specified protocols list.

', 'GetResourceSetResponse$ResourceSetArn' => '

The Amazon Resource Name (ARN) of the resource set.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

', 'PolicySummary$PolicyArn' => '

The Amazon Resource Name (ARN) of the specified policy.

', 'ProtocolsListDataSummary$ListArn' => '

The Amazon Resource Name (ARN) of the specified protocols list.

', 'PutAppsListResponse$AppsListArn' => '

The Amazon Resource Name (ARN) of the applications list.

', 'PutNotificationChannelRequest$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from Firewall Manager.

', 'PutNotificationChannelRequest$SnsRoleName' => '

The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record Firewall Manager activity.

', 'PutPolicyResponse$PolicyArn' => '

The Amazon Resource Name (ARN) of the policy.

', 'PutProtocolsListResponse$ProtocolsListArn' => '

The Amazon Resource Name (ARN) of the protocols list.

', 'PutResourceSetResponse$ResourceSetArn' => '

The Amazon Resource Name (ARN) of the resource set.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

', ], ], 'ResourceCount' => [ 'base' => NULL, 'refs' => [ 'EvaluationResult$ViolatorCount' => '

The number of resources that are noncompliant with the specified policy. For WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn\'t comply with the rules of the policy and remediation is disabled or not possible.

', ], ], 'ResourceDescription' => [ 'base' => NULL, 'refs' => [ 'Policy$PolicyDescription' => '

The definition of the Network Firewall firewall policy.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ActionTarget$ResourceId' => '

The ID of the remediation target.

', 'ComplianceViolator$ResourceId' => '

The resource ID.

', 'EC2CreateRouteAction$DestinationPrefixListId' => '

Information about the ID of a prefix list used for the destination match.

', 'EC2DeleteRouteAction$DestinationPrefixListId' => '

Information about the ID of the prefix list for the route.

', 'EC2ReplaceRouteAction$DestinationPrefixListId' => '

Information about the ID of the prefix list for the route.

', 'ExpectedRoute$RouteTableId' => '

Information about the route table ID.

', 'FirewallSubnetIsOutOfScopeViolation$FirewallSubnetId' => '

The ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetIsOutOfScopeViolation$VpcId' => '

The VPC ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetIsOutOfScopeViolation$VpcEndpointId' => '

The VPC endpoint ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetMissingVPCEndpointViolation$FirewallSubnetId' => '

The ID of the firewall that this VPC endpoint is associated with.

', 'FirewallSubnetMissingVPCEndpointViolation$VpcId' => '

The resource ID of the VPC associated with the deleted VPC subnet.

', 'GetViolationDetailsRequest$ResourceId' => '

The ID of the resource that has violations.

', 'InvalidNetworkAclEntriesViolation$Vpc' => '

The VPC where the violation was found.

', 'InvalidNetworkAclEntriesViolation$Subnet' => '

The subnet that\'s associated with the network ACL.

', 'InvalidNetworkAclEntriesViolation$CurrentAssociatedNetworkAcl' => '

The network ACL containing the entry violations.

', 'ListResourceSetResourcesRequest$Identifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'NetworkFirewallBlackHoleRouteDetectedViolation$RouteTableId' => '

Information about the route table ID.

', 'NetworkFirewallBlackHoleRouteDetectedViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$SubnetId' => '

The subnet ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$RouteTableId' => '

Information about the route table ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$CurrentFirewallSubnetRouteTable' => '

Information about the subnet route table for the current firewall.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ExpectedFirewallEndpoint' => '

The expected endpoint for the current firewall.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$FirewallSubnetId' => '

The firewall subnet ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$InternetGatewayId' => '

The internet gateway ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$CurrentInternetGatewayRouteTable' => '

The current route table for the internet gateway.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallInvalidRouteConfigurationViolation$RouteTableId' => '

The route table ID.

', 'NetworkFirewallInvalidRouteConfigurationViolation$CurrentFirewallSubnetRouteTable' => '

The subnet route table for the current firewall.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedFirewallEndpoint' => '

The firewall endpoint that\'s expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualFirewallEndpoint' => '

The actual firewall endpoint.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedFirewallSubnetId' => '

The expected subnet ID for the firewall.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualFirewallSubnetId' => '

The actual subnet ID for the firewall.

', 'NetworkFirewallInvalidRouteConfigurationViolation$InternetGatewayId' => '

The internet gateway ID.

', 'NetworkFirewallInvalidRouteConfigurationViolation$CurrentInternetGatewayRouteTable' => '

The route table for the current internet gateway.

', 'NetworkFirewallInvalidRouteConfigurationViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallMissingExpectedRTViolation$VPC' => '

The resource ID of the VPC associated with a violating subnet.

', 'NetworkFirewallMissingExpectedRTViolation$CurrentRouteTable' => '

The resource ID of the current route table that\'s associated with the subnet, if one is available.

', 'NetworkFirewallMissingExpectedRTViolation$ExpectedRouteTable' => '

The resource ID of the route table that should be associated with the subnet.

', 'NetworkFirewallMissingExpectedRoutesViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallMissingFirewallViolation$VPC' => '

The resource ID of the VPC associated with a violating subnet.

', 'NetworkFirewallMissingSubnetViolation$VPC' => '

The resource ID of the VPC associated with a violating subnet.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$FirewallSubnetId' => '

The subnet ID for the firewall.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$RouteTableId' => '

The ID of the route table.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$FirewallEndpoint' => '

The endpoint of the firewall.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$GatewayId' => '

Information about the gateway ID.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$RouteTableId' => '

Information about the route table.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$VpcId' => '

Information about the VPC ID.

', 'ResourceIdList$member' => NULL, 'RouteHasOutOfScopeEndpointViolation$SubnetId' => '

The ID of the subnet associated with the route that violates the policy scope.

', 'RouteHasOutOfScopeEndpointViolation$VpcId' => '

The VPC ID of the route that violates the policy scope.

', 'RouteHasOutOfScopeEndpointViolation$RouteTableId' => '

The ID of the route table.

', 'RouteHasOutOfScopeEndpointViolation$CurrentFirewallSubnetRouteTable' => '

The route table associated with the current firewall subnet.

', 'RouteHasOutOfScopeEndpointViolation$FirewallSubnetId' => '

The ID of the firewall subnet.

', 'RouteHasOutOfScopeEndpointViolation$InternetGatewayId' => '

The ID of the Internet Gateway.

', 'RouteHasOutOfScopeEndpointViolation$CurrentInternetGatewayRouteTable' => '

The current route table associated with the Internet Gateway.

', 'SecurityGroupRuleDescription$PrefixListId' => '

The ID of the prefix list for the security group rule.

', 'StatefulRuleGroup$ResourceId' => '

The resource ID of the rule group.

', 'StatelessRuleGroup$ResourceId' => '

The resource ID of the rule group.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$VPC' => '

The resource ID of the VPC associated with a fireawll subnet that\'s causing the violation.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$CurrentRouteTable' => '

The resource ID of the current route table that\'s associated with the subnet, if one is available.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$ExpectedRouteTable' => '

The resource ID of the route table that should be associated with the subnet.

', 'ThirdPartyFirewallMissingFirewallViolation$VPC' => '

The resource ID of the VPC associated with a third-party firewall.

', 'ThirdPartyFirewallMissingSubnetViolation$VPC' => '

The resource ID of the VPC associated with a subnet that\'s causing the violation.

', 'ViolationDetail$ResourceId' => '

The resource ID that the violation details were requested for.

', ], ], 'ResourceIdList' => [ 'base' => NULL, 'refs' => [ 'AwsEc2NetworkInterfaceViolation$ViolatingSecurityGroups' => '

List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.

', 'ExpectedRoute$ContributingSubnets' => '

Information about the contributing subnets.

', 'NetworkFirewallInvalidRouteConfigurationViolation$AffectedSubnets' => '

The subnets that are affected.

', ], ], 'ResourceList' => [ 'base' => NULL, 'refs' => [ 'ListResourceSetResourcesResponse$Items' => '

An array of the associated resources\' uniform resource identifiers (URI).

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'App$AppName' => '

The application\'s name.

', 'AppsListData$ListName' => '

The name of the Firewall Manager applications list.

', 'AppsListDataSummary$ListName' => '

The name of the applications list.

', 'DiscoveredResource$Name' => '

The name of the discovered resource.

', 'Policy$PolicyName' => '

The name of the Firewall Manager policy.

', 'PolicyComplianceStatus$PolicyName' => '

The name of the Firewall Manager policy.

', 'PolicySummary$PolicyName' => '

The name of the specified policy.

', 'ProtocolsListData$ListName' => '

The name of the Firewall Manager protocols list.

', 'ProtocolsListDataSummary$ListName' => '

The name of the specified protocols list.

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

The specified resource was not found.

', 'refs' => [], ], 'ResourceSet' => [ 'base' => '

A set of resources to include in a policy.

', 'refs' => [ 'GetResourceSetResponse$ResourceSet' => '

Information about the specified resource set.

', 'PutResourceSetRequest$ResourceSet' => '

Details about the resource set to be created or updated.>

', 'PutResourceSetResponse$ResourceSet' => '

Details about the resource set.

', ], ], 'ResourceSetIds' => [ 'base' => NULL, 'refs' => [ 'Policy$ResourceSetIds' => '

The unique identifiers of the resource sets used by the policy.

', ], ], 'ResourceSetStatus' => [ 'base' => NULL, 'refs' => [ 'ResourceSet$ResourceSetStatus' => '

Indicates whether the resource set is in or out of an admin\'s Region scope.

', 'ResourceSetSummary$ResourceSetStatus' => '

Indicates whether the resource set is in or out of an admin\'s Region scope.

', ], ], 'ResourceSetSummary' => [ 'base' => '

Summarizes the resource sets used in a policy.

', 'refs' => [ 'ResourceSetSummaryList$member' => NULL, ], ], 'ResourceSetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListResourceSetsResponse$ResourceSets' => '

An array of ResourceSetSummary objects.

', ], ], 'ResourceTag' => [ 'base' => '

The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.

', 'refs' => [ 'ResourceTags$member' => NULL, ], ], 'ResourceTagKey' => [ 'base' => NULL, 'refs' => [ 'ResourceTag$Key' => '

The resource tag key.

', ], ], 'ResourceTagValue' => [ 'base' => NULL, 'refs' => [ 'ResourceTag$Value' => '

The resource tag value.

', ], ], 'ResourceTags' => [ 'base' => NULL, 'refs' => [ 'Policy$ResourceTags' => '

An array of ResourceTag objects.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ComplianceViolator$ResourceType' => '

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.

', 'DiscoveredResource$Type' => '

The type of the discovered resource.

', 'GetViolationDetailsRequest$ResourceType' => '

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.

', 'ListDiscoveredResourcesRequest$ResourceType' => '

The type of resources to discover.

', 'Policy$ResourceType' => '

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

The following are valid resource types for each Firewall Manager policy type:

', 'PolicySummary$ResourceType' => '

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.

', 'ResourceTypeList$member' => NULL, 'ViolationDetail$ResourceType' => '

The resource type that the violation details were requested for.

', ], ], 'ResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'Policy$ResourceTypeList' => '

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.

', 'ResourceSet$ResourceTypeList' => '

Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

', ], ], 'ResourceViolation' => [ 'base' => '

Violation detail based on resource type.

', 'refs' => [ 'ResourceViolations$member' => NULL, ], ], 'ResourceViolations' => [ 'base' => NULL, 'refs' => [ 'ViolationDetail$ResourceViolations' => '

List of violations for the requested resource.

', ], ], 'Route' => [ 'base' => '

Describes a route in a route table.

', 'refs' => [ 'NetworkFirewallInvalidRouteConfigurationViolation$ViolatingRoute' => '

The route that\'s in violation.

', 'Routes$member' => NULL, ], ], 'RouteHasOutOfScopeEndpointViolation' => [ 'base' => '

Contains details about the route endpoint that violates the policy scope.

', 'refs' => [ 'ResourceViolation$RouteHasOutOfScopeEndpointViolation' => '

Contains details about the route endpoint that violates the policy scope.

', ], ], 'Routes' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallBlackHoleRouteDetectedViolation$ViolatingRoutes' => '

Information about the route or routes that are in violation.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ViolatingRoutes' => '

The route or routes that are in violation.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ActualFirewallSubnetRoutes' => '

The actual firewall subnet routes.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ActualInternetGatewayRoutes' => '

The actual internet gateway routes.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualFirewallSubnetRoutes' => '

The actual firewall subnet routes that are expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualInternetGatewayRoutes' => '

The actual internet gateway routes.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$ViolatingRoutes' => '

The routes that are in violation.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$ViolatingRoutes' => '

The routes that are in violation.

', 'RouteHasOutOfScopeEndpointViolation$ViolatingRoutes' => '

The list of routes that violate the route table.

', 'RouteHasOutOfScopeEndpointViolation$FirewallSubnetRoutes' => '

The list of firewall subnet routes.

', 'RouteHasOutOfScopeEndpointViolation$InternetGatewayRoutes' => '

The routes in the route table associated with the Internet Gateway.

', ], ], 'RuleOrder' => [ 'base' => NULL, 'refs' => [ 'StatefulEngineOptions$RuleOrder' => '

Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

', ], ], 'SecurityGroupRemediationAction' => [ 'base' => '

Remediation option for the rule specified in the ViolationTarget.

', 'refs' => [ 'SecurityGroupRemediationActions$member' => NULL, ], ], 'SecurityGroupRemediationActions' => [ 'base' => NULL, 'refs' => [ 'AwsVPCSecurityGroupViolation$PossibleSecurityGroupRemediationActions' => '

Remediation options for the rule specified in the ViolationTarget.

', ], ], 'SecurityGroupRuleDescription' => [ 'base' => '

Describes a set of permissions for a security group rule.

', 'refs' => [ 'SecurityGroupRemediationAction$RemediationResult' => '

The final state of the rule specified in the ViolationTarget after it is remediated.

', ], ], 'SecurityServicePolicyData' => [ 'base' => '

Details about the security service that is being used to protect the resources.

', 'refs' => [ 'Policy$SecurityServicePolicyData' => '

Details about the security service that is being used to protect the resources.

', ], ], 'SecurityServiceType' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusResponse$ServiceType' => '

The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.

', 'PolicySummary$SecurityServiceType' => '

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.

', 'SecurityServicePolicyData$Type' => '

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting Amazon Web Services Support.

', 'SecurityServiceTypeList$member' => NULL, ], ], 'SecurityServiceTypeList' => [ 'base' => NULL, 'refs' => [ 'PolicyTypeScope$PolicyTypes' => '

The list of policy types that the specified Firewall Manager administrator can manage.

', ], ], 'StatefulEngineOptions' => [ 'base' => '

Configuration settings for the handling of the stateful rule groups in a Network Firewall firewall policy.

', 'refs' => [ 'NetworkFirewallPolicyDescription$StatefulEngineOptions' => '

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

', ], ], 'StatefulRuleGroup' => [ 'base' => '

Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.

', 'refs' => [ 'StatefulRuleGroupList$member' => NULL, ], ], 'StatefulRuleGroupList' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicyDescription$StatefulRuleGroups' => '

The stateful rule groups that are used in the Network Firewall firewall policy.

', ], ], 'StatelessRuleGroup' => [ 'base' => '

Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.

', 'refs' => [ 'StatelessRuleGroupList$member' => NULL, ], ], 'StatelessRuleGroupList' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicyDescription$StatelessRuleGroups' => '

The stateless rule groups that are used in the Network Firewall firewall policy.

', ], ], 'StatelessRuleGroupPriority' => [ 'base' => NULL, 'refs' => [ 'StatelessRuleGroup$Priority' => '

The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

', ], ], 'Tag' => [ 'base' => '

A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each Amazon Web Services resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], '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' => '

The keys of the tags to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceResponse$TagList' => '

The tags associated with the resource.

', 'PutAppsListRequest$TagList' => '

The tags associated with the resource.

', 'PutPolicyRequest$TagList' => '

The tags to add to the Amazon Web Services resource.

', 'PutProtocolsListRequest$TagList' => '

The tags associated with the resource.

', 'PutResourceSetRequest$TagList' => '

Retrieves the tags associated with the specified resource set. 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.

', 'TagResourceRequest$TagList' => '

The tags to add to the resource.

', 'ViolationDetail$ResourceTags' => '

The ResourceTag objects associated 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.

', ], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Route$TargetType' => '

The type of target for the route.

', ], ], 'TargetViolationReason' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallMissingFirewallViolation$TargetViolationReason' => '

The reason the resource has this violation, if one is available.

', 'NetworkFirewallMissingSubnetViolation$TargetViolationReason' => '

The reason the resource has this violation, if one is available.

', 'TargetViolationReasons$member' => NULL, 'ThirdPartyFirewallMissingFirewallViolation$TargetViolationReason' => '

The reason the resource is causing this violation, if a reason is available.

', 'ThirdPartyFirewallMissingSubnetViolation$TargetViolationReason' => '

The reason the resource is causing the violation, if a reason is available.

', ], ], 'TargetViolationReasons' => [ 'base' => NULL, 'refs' => [ 'PartialMatch$TargetViolationReasons' => '

The violation reason.

', ], ], 'ThirdPartyFirewall' => [ 'base' => NULL, 'refs' => [ 'AssociateThirdPartyFirewallRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', 'DisassociateThirdPartyFirewallRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', 'GetThirdPartyFirewallAssociationStatusRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', 'ListThirdPartyFirewallFirewallPoliciesRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', ], ], 'ThirdPartyFirewallAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'AssociateThirdPartyFirewallResponse$ThirdPartyFirewallStatus' => '

The current status for setting a Firewall Manager policy administrator\'s account as an administrator of the third-party firewall tenant.

', 'DisassociateThirdPartyFirewallResponse$ThirdPartyFirewallStatus' => '

The current status for the disassociation of a Firewall Manager administrators account with a third-party firewall.

', 'GetThirdPartyFirewallAssociationStatusResponse$ThirdPartyFirewallStatus' => '

The current status for setting a Firewall Manager policy administrators account as an administrator of the third-party firewall tenant.

', ], ], 'ThirdPartyFirewallFirewallPolicies' => [ 'base' => NULL, 'refs' => [ 'ListThirdPartyFirewallFirewallPoliciesResponse$ThirdPartyFirewallFirewallPolicies' => '

A list that contains one ThirdPartyFirewallFirewallPolicies element for each third-party firewall policies that the specified third-party firewall vendor is associated with. Each ThirdPartyFirewallFirewallPolicies element contains the firewall policy name and ID.

', ], ], 'ThirdPartyFirewallFirewallPolicy' => [ 'base' => '

Configures the third-party firewall\'s firewall policy.

', 'refs' => [ 'ThirdPartyFirewallFirewallPolicies$member' => NULL, ], ], 'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [ 'base' => '

The violation details for a third-party firewall that\'s not associated with an Firewall Manager managed route table.

', 'refs' => [ 'ResourceViolation$ThirdPartyFirewallMissingExpectedRouteTableViolation' => '

The violation details for a third-party firewall that has the Firewall Manager managed route table that was associated with the third-party firewall has been deleted.

', ], ], 'ThirdPartyFirewallMissingFirewallViolation' => [ 'base' => '

The violation details about a third-party firewall\'s subnet that doesn\'t have a Firewall Manager managed firewall in its VPC.

', 'refs' => [ 'ResourceViolation$ThirdPartyFirewallMissingFirewallViolation' => '

The violation details for a third-party firewall that\'s been deleted.

', ], ], 'ThirdPartyFirewallMissingSubnetViolation' => [ 'base' => '

The violation details for a third-party firewall for an Availability Zone that\'s missing the Firewall Manager managed subnet.

', 'refs' => [ 'ResourceViolation$ThirdPartyFirewallMissingSubnetViolation' => '

The violation details for a third-party firewall\'s subnet that\'s been deleted.

', ], ], 'ThirdPartyFirewallPolicy' => [ 'base' => '

Configures the deployment model for the third-party firewall.

', 'refs' => [ 'PolicyOption$ThirdPartyFirewallPolicy' => '

Defines the policy options for a third-party firewall policy.

', ], ], 'TimeStamp' => [ 'base' => NULL, 'refs' => [ 'AppsListData$CreateTime' => '

The time that the Firewall Manager applications list was created.

', 'AppsListData$LastUpdateTime' => '

The time that the Firewall Manager applications list was last updated.

', 'GetProtectionStatusRequest$StartTime' => '

The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

', 'GetProtectionStatusRequest$EndTime' => '

The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

', 'PolicyComplianceDetail$ExpiredAt' => '

A timestamp that indicates when the returned information should be considered out of date.

', 'PolicyComplianceStatus$LastUpdated' => '

Timestamp of the last update to the EvaluationResult objects.

', 'ProtocolsListData$CreateTime' => '

The time that the Firewall Manager protocols list was created.

', 'ProtocolsListData$LastUpdateTime' => '

The time that the Firewall Manager protocols list was last updated.

', 'ResourceSet$LastUpdateTime' => '

The last time that the resource set was changed.

', 'ResourceSetSummary$LastUpdateTime' => '

The last time that the resource set was changed.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateToken' => [ 'base' => NULL, 'refs' => [ 'AppsListData$ListUpdateToken' => '

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

', 'ProtocolsListData$ListUpdateToken' => '

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

', 'ResourceSet$UpdateToken' => '

An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn\'t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

', ], ], 'ViolationDetail' => [ 'base' => '

Violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

', 'refs' => [ 'GetViolationDetailsResponse$ViolationDetail' => '

Violation detail for a resource.

', ], ], 'ViolationReason' => [ 'base' => NULL, 'refs' => [ 'ComplianceViolator$ViolationReason' => '

The reason that the resource is not protected by the policy.

', ], ], 'ViolationTarget' => [ 'base' => NULL, 'refs' => [ 'AwsEc2InstanceViolation$ViolationTarget' => '

The resource ID of the EC2 instance.

', 'AwsEc2NetworkInterfaceViolation$ViolationTarget' => '

The resource ID of the network interface.

', 'AwsVPCSecurityGroupViolation$ViolationTarget' => '

The security group rule that is being evaluated.

', 'DnsDuplicateRuleGroupViolation$ViolationTarget' => '

Information about the VPC ID.

', 'DnsRuleGroupLimitExceededViolation$ViolationTarget' => '

Information about the VPC ID.

', 'DnsRuleGroupPriorityConflictViolation$ViolationTarget' => '

Information about the VPC ID.

', 'NetworkFirewallBlackHoleRouteDetectedViolation$ViolationTarget' => '

The subnet that has an inactive state.

', 'NetworkFirewallMissingExpectedRTViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'NetworkFirewallMissingExpectedRoutesViolation$ViolationTarget' => '

The target of the violation.

', 'NetworkFirewallMissingFirewallViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'NetworkFirewallMissingSubnetViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'NetworkFirewallPolicyModifiedViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$ViolationTarget' => '

The ID of the third-party firewall or VPC resource that\'s causing the violation.

', 'ThirdPartyFirewallMissingFirewallViolation$ViolationTarget' => '

The ID of the third-party firewall that\'s causing the violation.

', 'ThirdPartyFirewallMissingSubnetViolation$ViolationTarget' => '

The ID of the third-party firewall or VPC resource that\'s causing the violation.

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

This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.

Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager.

', 'operations' => [ 'AssociateAdminAccount' => '

Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect.

For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

', 'AssociateThirdPartyFirewall' => '

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that\'s associated with your Amazon Web Services customer account.

', 'BatchAssociateResource' => '

Associate resources to a Firewall Manager resource set.

', 'BatchDisassociateResource' => '

Disassociates resources from a Firewall Manager resource set.

', 'DeleteAppsList' => '

Permanently deletes an Firewall Manager applications list.

', 'DeleteNotificationChannel' => '

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

', 'DeletePolicy' => '

Permanently deletes an Firewall Manager policy.

', 'DeleteProtocolsList' => '

Permanently deletes an Firewall Manager protocols list.

', 'DeleteResourceSet' => '

Deletes the specified ResourceSet.

', 'DisassociateAdminAccount' => '

Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request.

Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.

', 'DisassociateThirdPartyFirewall' => '

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.

', 'GetAdminAccount' => '

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.

', 'GetAdminScope' => '

Returns information about the specified account\'s administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

', 'GetAppsList' => '

Returns information about the specified Firewall Manager applications list.

', 'GetComplianceDetail' => '

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy.

The reasons for resources being considered compliant depend on the Firewall Manager policy type.

', 'GetNotificationChannel' => '

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

', 'GetPolicy' => '

Returns information about the specified Firewall Manager policy.

', 'GetProtectionStatus' => '

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

', 'GetProtocolsList' => '

Returns information about the specified Firewall Manager protocols list.

', 'GetResourceSet' => '

Gets information about a specific resource set.

', 'GetThirdPartyFirewallAssociationStatus' => '

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

', 'GetViolationDetails' => '

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

', 'ListAdminAccountsForOrganization' => '

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.

This operation can be called only from the organization\'s management account.

', 'ListAdminsManagingAccount' => '

Lists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope.

', 'ListAppsLists' => '

Returns an array of AppsListDataSummary objects.

', 'ListComplianceStatus' => '

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

', 'ListDiscoveredResources' => '

Returns an array of resources in the organization\'s accounts that are available to be associated with a resource set.

', 'ListMemberAccounts' => '

Returns a MemberAccounts object that lists the member accounts in the administrator\'s Amazon Web Services organization.

Either an Firewall Manager administrator or the organization\'s management account can make this request.

', 'ListPolicies' => '

Returns an array of PolicySummary objects.

', 'ListProtocolsLists' => '

Returns an array of ProtocolsListDataSummary objects.

', 'ListResourceSetResources' => '

Returns an array of resources that are currently associated to a resource set.

', 'ListResourceSets' => '

Returns an array of ResourceSetSummary objects.

', 'ListTagsForResource' => '

Retrieves the list of tags for the specified Amazon Web Services resource.

', 'ListThirdPartyFirewallFirewallPolicies' => '

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator\'s account.

', 'PutAdminAccount' => '

Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization\'s management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn\'t a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

', 'PutAppsList' => '

Creates an Firewall Manager applications list.

', 'PutNotificationChannel' => '

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.

To perform this action outside of the console, you must first configure the SNS topic\'s access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.

', 'PutPolicy' => '

Creates an Firewall Manager policy.

A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

Firewall Manager provides the following types of policies:

', 'PutProtocolsList' => '

Creates an Firewall Manager protocols list.

', 'PutResourceSet' => '

Creates the resource set.

An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

', 'TagResource' => '

Adds one or more tags to an Amazon Web Services resource.

', 'UntagResource' => '

Removes one or more tags from an Amazon Web Services resource.

', ], 'shapes' => [ 'AWSAccountId' => [ 'base' => NULL, 'refs' => [ 'AWSAccountIdList$member' => NULL, 'AccountIdList$member' => NULL, 'AdminAccountSummary$AdminAccount' => '

The Amazon Web Services account ID of the Firewall Manager administrator\'s account.

', 'AssociateAdminAccountRequest$AdminAccount' => '

The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager default administrator account. This account must be a member account of the organization in Organizations whose resources you want to protect. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

', 'DiscoveredResource$AccountId' => '

The Amazon Web Services account ID associated with the discovered resource.

', 'GetAdminAccountResponse$AdminAccount' => '

The account that is set as the Firewall Manager default administrator.

', 'GetAdminScopeRequest$AdminAccount' => '

The administrator account that you want to get the details for.

', 'GetComplianceDetailRequest$MemberAccount' => '

The Amazon Web Services account that owns the resources that you want to get the details for.

', 'GetProtectionStatusRequest$MemberAccountId' => '

The Amazon Web Services account that is in scope of the policy that you want to get the details for.

', 'GetProtectionStatusResponse$AdminAccountId' => '

The ID of the Firewall Manager administrator account for this policy.

', 'GetViolationDetailsRequest$MemberAccount' => '

The Amazon Web Services account ID that you want the details for.

', 'MemberAccounts$member' => NULL, 'PolicyComplianceDetail$PolicyOwner' => '

The Amazon Web Services account that created the Firewall Manager policy.

', 'PolicyComplianceDetail$MemberAccount' => '

The Amazon Web Services account ID.

', 'PolicyComplianceStatus$PolicyOwner' => '

The Amazon Web Services account that created the Firewall Manager policy.

', 'PolicyComplianceStatus$MemberAccount' => '

The member account ID.

', 'PutAdminAccountRequest$AdminAccount' => '

The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

', 'Resource$AccountId' => '

The Amazon Web Services account ID that the associated resource belongs to.

', 'ViolationDetail$MemberAccount' => '

The Amazon Web Services account that the violation details were requested for.

', ], ], 'AWSAccountIdList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesRequest$MemberAccountIds' => '

The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

', ], ], 'AWSRegion' => [ 'base' => NULL, 'refs' => [ 'AWSRegionList$member' => NULL, ], ], 'AWSRegionList' => [ 'base' => NULL, 'refs' => [ 'RegionScope$Regions' => '

The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

', ], ], 'AccountIdList' => [ 'base' => NULL, 'refs' => [ 'AccountScope$Accounts' => '

The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.

', 'ListAdminsManagingAccountResponse$AdminAccounts' => '

The list of accounts who manage member accounts within their AdminScope.

', ], ], 'AccountRoleStatus' => [ 'base' => NULL, 'refs' => [ 'GetAdminAccountResponse$RoleStatus' => '

The status of the account that you set as the Firewall Manager default administrator.

', ], ], 'AccountScope' => [ 'base' => '

Configures the accounts within the administrator\'s Organizations organization that the specified Firewall Manager administrator can apply policies to.

', 'refs' => [ 'AdminScope$AccountScope' => '

Defines the accounts that the specified Firewall Manager administrator can apply policies to.

', ], ], 'ActionTarget' => [ 'base' => '

Describes a remediation action target.

', 'refs' => [ 'CreateNetworkAclAction$Vpc' => '

The VPC that\'s associated with the remediation action.

', 'CreateNetworkAclEntriesAction$NetworkAclId' => '

The network ACL that\'s associated with the remediation action.

', 'DeleteNetworkAclEntriesAction$NetworkAclId' => '

The network ACL that\'s associated with the remediation action.

', 'EC2AssociateRouteTableAction$RouteTableId' => '

The ID of the EC2 route table that is associated with the remediation action.

', 'EC2AssociateRouteTableAction$SubnetId' => '

The ID of the subnet for the EC2 route table that is associated with the remediation action.

', 'EC2AssociateRouteTableAction$GatewayId' => '

The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.

', 'EC2CopyRouteTableAction$VpcId' => '

The VPC ID of the copied EC2 route table that is associated with the remediation action.

', 'EC2CopyRouteTableAction$RouteTableId' => '

The ID of the copied EC2 route table that is associated with the remediation action.

', 'EC2CreateRouteAction$VpcEndpointId' => '

Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

', 'EC2CreateRouteAction$GatewayId' => '

Information about the ID of an internet gateway or virtual private gateway attached to your VPC.

', 'EC2CreateRouteAction$RouteTableId' => '

Information about the ID of the route table for the route.

', 'EC2CreateRouteTableAction$VpcId' => '

Information about the ID of a VPC.

', 'EC2DeleteRouteAction$RouteTableId' => '

Information about the ID of the route table.

', 'EC2ReplaceRouteAction$GatewayId' => '

Information about the ID of an internet gateway or virtual private gateway.

', 'EC2ReplaceRouteAction$RouteTableId' => '

Information about the ID of the route table.

', 'EC2ReplaceRouteTableAssociationAction$AssociationId' => '

Information about the association ID.

', 'EC2ReplaceRouteTableAssociationAction$RouteTableId' => '

Information about the ID of the new route table to associate with the subnet.

', 'ReplaceNetworkAclAssociationAction$AssociationId' => NULL, 'ReplaceNetworkAclAssociationAction$NetworkAclId' => '

The network ACL that\'s associated with the remediation action.

', ], ], 'AdminAccountSummary' => [ 'base' => '

Contains high level information about the Firewall Manager administrator account.

', 'refs' => [ 'AdminAccountSummaryList$member' => NULL, ], ], 'AdminAccountSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAdminAccountsForOrganizationResponse$AdminAccounts' => '

A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.

', ], ], 'AdminScope' => [ 'base' => '

Defines the resources that the Firewall Manager administrator can manage. For more information about administrative scope, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

', 'refs' => [ 'GetAdminScopeResponse$AdminScope' => '

Contains details about the administrative scope of the requested account.

', 'PutAdminAccountRequest$AdminScope' => '

Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.

', ], ], 'App' => [ 'base' => '

An individual Firewall Manager application.

', 'refs' => [ 'AppsList$member' => NULL, ], ], 'AppsList' => [ 'base' => NULL, 'refs' => [ 'AppsListData$AppsList' => '

An array of applications in the Firewall Manager applications list.

', 'AppsListDataSummary$AppsList' => '

An array of App objects in the Firewall Manager applications list.

', 'PreviousAppsList$value' => NULL, ], ], 'AppsListData' => [ 'base' => '

An Firewall Manager applications list.

', 'refs' => [ 'GetAppsListResponse$AppsList' => '

Information about the specified Firewall Manager applications list.

', 'PutAppsListRequest$AppsList' => '

The details of the Firewall Manager applications list to be created.

', 'PutAppsListResponse$AppsList' => '

The details of the Firewall Manager applications list.

', ], ], 'AppsListDataSummary' => [ 'base' => '

Details of the Firewall Manager applications list.

', 'refs' => [ 'AppsListsData$member' => NULL, ], ], 'AppsListsData' => [ 'base' => NULL, 'refs' => [ 'ListAppsListsResponse$AppsLists' => '

An array of AppsListDataSummary objects.

', ], ], 'AssociateAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateThirdPartyFirewallRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateThirdPartyFirewallResponse' => [ 'base' => NULL, 'refs' => [], ], 'AwsEc2InstanceViolation' => [ 'base' => '

Violation detail for an EC2 instance resource.

', 'refs' => [ 'ResourceViolation$AwsEc2InstanceViolation' => '

Violation detail for an EC2 instance.

', ], ], 'AwsEc2NetworkInterfaceViolation' => [ 'base' => '

Violation detail for network interfaces associated with an EC2 instance.

', 'refs' => [ 'AwsEc2NetworkInterfaceViolations$member' => NULL, 'ResourceViolation$AwsEc2NetworkInterfaceViolation' => '

Violation detail for a network interface.

', ], ], 'AwsEc2NetworkInterfaceViolations' => [ 'base' => NULL, 'refs' => [ 'AwsEc2InstanceViolation$AwsEc2NetworkInterfaceViolations' => '

Violation detail for network interfaces associated with the EC2 instance.

', ], ], 'AwsVPCSecurityGroupViolation' => [ 'base' => '

Violation detail for the rule violation in a security group when compared to the primary security group of the Firewall Manager policy.

', 'refs' => [ 'ResourceViolation$AwsVPCSecurityGroupViolation' => '

Violation detail for security groups.

', ], ], 'Base62Id' => [ 'base' => NULL, 'refs' => [ 'DeleteResourceSetRequest$Identifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'GetResourceSetRequest$Identifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'ResourceSet$Id' => '

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'ResourceSetIds$member' => NULL, 'ResourceSetSummary$Id' => '

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', ], ], 'BasicInteger' => [ 'base' => NULL, 'refs' => [ 'DnsRuleGroupLimitExceededViolation$NumberOfRuleGroupsAlreadyAssociated' => '

The number of rule groups currently associated with the VPC.

', 'RemediationActionWithOrder$Order' => '

The order of the remediation actions in the list.

', ], ], 'BatchAssociateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchAssociateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AccountScope$AllAccountsEnabled' => '

A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.

', 'AccountScope$ExcludeSpecifiedAccounts' => '

A boolean value that excludes the accounts in AccountScope$Accounts from the administrator\'s scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.

', 'AdminAccountSummary$DefaultAdmin' => '

A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

', 'CreateNetworkAclAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'CreateNetworkAclEntriesAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'DeleteNetworkAclEntriesAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'DeletePolicyRequest$DeleteAllPolicyResources' => '

If True, the request performs cleanup according to the policy type.

For WAF and Shield Advanced policies, the cleanup does the following:

For security group policies, the cleanup does the following for each security group in the policy:

For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren\'t associated with any other resources through another policy.

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don\'t specify tags or accounts, all resources are in scope.

', 'EvaluationResult$EvaluationLimitExceeded' => '

Indicates that over 100 resources are noncompliant with the Firewall Manager policy.

', 'GetAppsListRequest$DefaultList' => '

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

', 'GetProtocolsListRequest$DefaultList' => '

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

', 'ListAppsListsRequest$DefaultLists' => '

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

', 'ListProtocolsListsRequest$DefaultLists' => '

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$IsRouteTableUsedInDifferentAZ' => '

Information about whether the route table is used in another Availability Zone.

', 'NetworkFirewallInvalidRouteConfigurationViolation$IsRouteTableUsedInDifferentAZ' => '

Information about whether the route table is used in another Availability Zone.

', 'OrganizationalUnitScope$AllOrganizationalUnitsEnabled' => '

A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in OrganizationalUnitScope$OrganizationalUnits. You cannot specify both.

', 'OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits' => '

A boolean value that excludes the OUs in OrganizationalUnitScope$OrganizationalUnits from the administrator\'s scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed in OrganizationalUnitScope$OrganizationalUnits. You can either specify a list of OUs to exclude by OrganizationalUnitScope$OrganizationalUnits, or you can enable management of all OUs by OrganizationalUnitScope$AllOrganizationalUnitsEnabled. You cannot specify both.

', 'Policy$ExcludeResourceTags' => '

If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

', 'Policy$RemediationEnabled' => '

Indicates if the policy should be automatically applied to new resources.

', 'Policy$DeleteUnusedFMManagedResources' => '

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn\'t remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

', 'PolicyComplianceDetail$EvaluationLimitExceeded' => '

Indicates if over 100 resources are noncompliant with the Firewall Manager policy.

', 'PolicySummary$RemediationEnabled' => '

Indicates if the policy should be automatically applied to new resources.

', 'PolicySummary$DeleteUnusedFMManagedResources' => '

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn\'t remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

', 'PolicyTypeScope$AllPolicyTypesEnabled' => '

Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.

', 'PossibleRemediationAction$IsDefaultAction' => '

Information about whether an action is taken by default.

', 'RegionScope$AllRegionsEnabled' => '

Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.

', 'ReplaceNetworkAclAssociationAction$FMSCanRemediate' => '

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

', 'SecurityGroupRemediationAction$IsDefaultAction' => '

Indicates if the current action is the default action.

', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntry$Egress' => '

Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it\'s not an egress rule, then it\'s an ingress, or inbound, rule.

', 'NetworkAclEntrySet$ForceRemediateForFirstEntries' => '

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Network access control list (ACL) policies in the Firewall Manager Developer Guide.

', 'NetworkAclEntrySet$ForceRemediateForLastEntries' => '

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Network access control list (ACL) policies in the Firewall Manager Developer Guide.

', ], ], 'CIDR' => [ 'base' => NULL, 'refs' => [ 'EC2CreateRouteAction$DestinationCidrBlock' => '

Information about the IPv4 CIDR address block used for the destination match.

', 'EC2CreateRouteAction$DestinationIpv6CidrBlock' => '

Information about the IPv6 CIDR block destination.

', 'EC2DeleteRouteAction$DestinationCidrBlock' => '

Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

', 'EC2DeleteRouteAction$DestinationIpv6CidrBlock' => '

Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

', 'EC2ReplaceRouteAction$DestinationCidrBlock' => '

Information about the IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

', 'EC2ReplaceRouteAction$DestinationIpv6CidrBlock' => '

Information about the IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

', 'ExpectedRoute$IpV4Cidr' => '

Information about the IPv4 CIDR block.

', 'ExpectedRoute$PrefixListId' => '

Information about the ID of the prefix list for the route.

', 'ExpectedRoute$IpV6Cidr' => '

Information about the IPv6 CIDR block.

', 'SecurityGroupRuleDescription$IPV4Range' => '

The IPv4 ranges for the security group rule.

', 'SecurityGroupRuleDescription$IPV6Range' => '

The IPv6 ranges for the security group rule.

', ], ], 'ComplianceViolator' => [ 'base' => '

Details of the resource that is not protected by the policy.

', 'refs' => [ 'ComplianceViolators$member' => NULL, ], ], 'ComplianceViolatorMetadata' => [ 'base' => NULL, 'refs' => [ 'ComplianceViolator$Metadata' => '

Metadata about the resource that doesn\'t comply with the policy scope.

', ], ], 'ComplianceViolators' => [ 'base' => NULL, 'refs' => [ 'PolicyComplianceDetail$Violators' => '

An array of resources that aren\'t protected by the WAF or Shield Advanced policy or that aren\'t in compliance with the security group policy.

', ], ], 'CreateNetworkAclAction' => [ 'base' => '

Information about the CreateNetworkAcl action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$CreateNetworkAclAction' => '

Information about the CreateNetworkAcl action in Amazon EC2.

', ], ], 'CreateNetworkAclEntriesAction' => [ 'base' => '

Information about the CreateNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$CreateNetworkAclEntriesAction' => '

Information about the CreateNetworkAclEntries action in Amazon EC2.

', ], ], 'CustomerPolicyScopeId' => [ 'base' => NULL, 'refs' => [ 'CustomerPolicyScopeIdList$member' => NULL, ], ], 'CustomerPolicyScopeIdList' => [ 'base' => NULL, 'refs' => [ 'CustomerPolicyScopeMap$value' => NULL, ], ], 'CustomerPolicyScopeIdType' => [ 'base' => NULL, 'refs' => [ 'CustomerPolicyScopeMap$key' => NULL, ], ], 'CustomerPolicyScopeMap' => [ 'base' => NULL, 'refs' => [ 'Policy$IncludeMap' => '

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

', 'Policy$ExcludeMap' => '

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

', ], ], 'CustomerPolicyStatus' => [ 'base' => NULL, 'refs' => [ 'Policy$PolicyStatus' => '

Indicates whether the policy is in or out of an admin\'s policy or Region scope.

', 'PolicySummary$PolicyStatus' => '

Indicates whether the policy is in or out of an admin\'s policy or Region scope.

', ], ], 'DeleteAppsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNetworkAclEntriesAction' => [ 'base' => '

Information about the DeleteNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$DeleteNetworkAclEntriesAction' => '

Information about the DeleteNetworkAclEntries action in Amazon EC2.

', ], ], 'DeleteNotificationChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProtocolsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DependentServiceName' => [ 'base' => NULL, 'refs' => [ 'IssueInfoMap$key' => NULL, ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ResourceSet$Description' => '

A description of the resource set.

', 'ResourceSetSummary$Description' => '

A description of the resource set.

', ], ], 'DestinationType' => [ 'base' => NULL, 'refs' => [ 'Route$DestinationType' => '

The type of destination for the route.

', ], ], 'DetailedInfo' => [ 'base' => NULL, 'refs' => [ 'IssueInfoMap$value' => NULL, ], ], 'DisassociateAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateThirdPartyFirewallRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateThirdPartyFirewallResponse' => [ 'base' => NULL, 'refs' => [], ], 'DiscoveredResource' => [ 'base' => '

A resource in the organization that\'s available to be associated with a Firewall Manager resource set.

', 'refs' => [ 'DiscoveredResourceList$member' => NULL, ], ], 'DiscoveredResourceList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesResponse$Items' => '

Details of the resources that were discovered.

', ], ], 'DnsDuplicateRuleGroupViolation' => [ 'base' => '

A DNS Firewall rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can\'t be associated again.

', 'refs' => [ 'ResourceViolation$DnsDuplicateRuleGroupViolation' => '

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can\'t be associated again.

', ], ], 'DnsRuleGroupLimitExceededViolation' => [ 'base' => '

The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed due to the limit.

', 'refs' => [ 'ResourceViolation$DnsRuleGroupLimitExceededViolation' => '

Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.

', ], ], 'DnsRuleGroupPriorities' => [ 'base' => NULL, 'refs' => [ 'DnsRuleGroupPriorityConflictViolation$UnavailablePriorities' => '

The priorities of rule groups that are already associated with the VPC. To retry your operation, choose priority settings that aren\'t in this list for the rule groups in your new DNS Firewall policy.

', ], ], 'DnsRuleGroupPriority' => [ 'base' => NULL, 'refs' => [ 'DnsRuleGroupPriorities$member' => NULL, 'DnsRuleGroupPriorityConflictViolation$ConflictingPriority' => '

The priority setting of the two conflicting rule groups.

', ], ], 'DnsRuleGroupPriorityConflictViolation' => [ 'base' => '

A rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that\'s already associated.

', 'refs' => [ 'ResourceViolation$DnsRuleGroupPriorityConflictViolation' => '

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that\'s already associated.

', ], ], 'EC2AssociateRouteTableAction' => [ 'base' => '

The action of associating an EC2 resource, such as a subnet or internet gateway, with a route table.

', 'refs' => [ 'RemediationAction$EC2AssociateRouteTableAction' => '

Information about the AssociateRouteTable action in the Amazon EC2 API.

', ], ], 'EC2CopyRouteTableAction' => [ 'base' => '

An action that copies the EC2 route table for use in remediation.

', 'refs' => [ 'RemediationAction$EC2CopyRouteTableAction' => '

Information about the CopyRouteTable action in the Amazon EC2 API.

', ], ], 'EC2CreateRouteAction' => [ 'base' => '

Information about the CreateRoute action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2CreateRouteAction' => '

Information about the CreateRoute action in the Amazon EC2 API.

', ], ], 'EC2CreateRouteTableAction' => [ 'base' => '

Information about the CreateRouteTable action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2CreateRouteTableAction' => '

Information about the CreateRouteTable action in the Amazon EC2 API.

', ], ], 'EC2DeleteRouteAction' => [ 'base' => '

Information about the DeleteRoute action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2DeleteRouteAction' => '

Information about the DeleteRoute action in the Amazon EC2 API.

', ], ], 'EC2ReplaceRouteAction' => [ 'base' => '

Information about the ReplaceRoute action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2ReplaceRouteAction' => '

Information about the ReplaceRoute action in the Amazon EC2 API.

', ], ], 'EC2ReplaceRouteTableAssociationAction' => [ 'base' => '

Information about the ReplaceRouteTableAssociation action in Amazon EC2.

', 'refs' => [ 'RemediationAction$EC2ReplaceRouteTableAssociationAction' => '

Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.

', ], ], 'EntriesDescription' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkAclEntriesAction$NetworkAclEntriesToBeCreated' => '

Lists the entries that the remediation action would create.

', 'DeleteNetworkAclEntriesAction$NetworkAclEntriesToBeDeleted' => '

Lists the entries that the remediation action would delete.

', ], ], 'EntriesWithConflicts' => [ 'base' => NULL, 'refs' => [ 'EntryViolation$EntriesWithConflicts' => '

The list of entries that are in conflict with ExpectedEntry.

', ], ], 'EntryDescription' => [ 'base' => '

Describes a single rule in a network ACL.

', 'refs' => [ 'EntriesDescription$member' => NULL, 'EntriesWithConflicts$member' => NULL, 'EntryViolation$ExpectedEntry' => '

The Firewall Manager-managed network ACL entry that is involved in the entry violation.

', 'EntryViolation$EntryAtExpectedEvaluationOrder' => '

The entry that\'s currently in the ExpectedEvaluationOrder location, in place of the expected entry.

', ], ], 'EntryType' => [ 'base' => NULL, 'refs' => [ 'EntryDescription$EntryType' => '

Specifies whether the entry is managed by Firewall Manager or by a user, and, for Firewall Manager-managed entries, specifies whether the entry is among those that run first in the network ACL or those that run last.

', ], ], 'EntryViolation' => [ 'base' => '

Detailed information about an entry violation in a network ACL. The violation is against the network ACL specification inside the Firewall Manager network ACL policy. This data object is part of InvalidNetworkAclEntriesViolation.

', 'refs' => [ 'EntryViolations$member' => NULL, ], ], 'EntryViolationReason' => [ 'base' => NULL, 'refs' => [ 'EntryViolationReasons$member' => NULL, ], ], 'EntryViolationReasons' => [ 'base' => NULL, 'refs' => [ 'EntryViolation$EntryViolationReasons' => '

Descriptions of the violations that Firewall Manager found for these entries.

', ], ], 'EntryViolations' => [ 'base' => NULL, 'refs' => [ 'InvalidNetworkAclEntriesViolation$EntryViolations' => '

Detailed information about the entry violations in the network ACL.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InternalErrorException$Message' => NULL, 'InvalidInputException$Message' => NULL, 'InvalidOperationException$Message' => NULL, 'InvalidTypeException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, ], ], 'EvaluationResult' => [ 'base' => '

Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don\'t comply with the policy.

', 'refs' => [ 'EvaluationResults$member' => NULL, ], ], 'EvaluationResults' => [ 'base' => NULL, 'refs' => [ 'PolicyComplianceStatus$EvaluationResults' => '

An array of EvaluationResult objects.

', ], ], 'ExpectedRoute' => [ 'base' => '

Information about the expected route in the route table.

', 'refs' => [ 'ExpectedRoutes$member' => NULL, ], ], 'ExpectedRoutes' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallInternetTrafficNotInspectedViolation$ExpectedFirewallSubnetRoutes' => '

The firewall subnet routes that are expected.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ExpectedInternetGatewayRoutes' => '

The internet gateway routes that are expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedFirewallSubnetRoutes' => '

The firewall subnet routes that are expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedInternetGatewayRoutes' => '

The expected routes for the internet gateway.

', 'NetworkFirewallMissingExpectedRoutesViolation$ExpectedRoutes' => '

The expected routes.

', ], ], 'FMSPolicyUpdateFirewallCreationConfigAction' => [ 'base' => '

Contains information about the actions that you can take to remediate scope violations caused by your policy\'s FirewallCreationConfig. FirewallCreationConfig is an optional configuration that you can use to choose which Availability Zones Firewall Manager creates Network Firewall endpoints in.

', 'refs' => [ 'RemediationAction$FMSPolicyUpdateFirewallCreationConfigAction' => '

The remedial action to take when updating a firewall configuration.

', ], ], 'FailedItem' => [ 'base' => '

Details of a resource that failed when trying to update it\'s association to a resource set.

', 'refs' => [ 'FailedItemList$member' => NULL, ], ], 'FailedItemList' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateResourceResponse$FailedItems' => '

The resources that failed to associate to the resource set.

', 'BatchDisassociateResourceResponse$FailedItems' => '

The resources that failed to disassociate from the resource set.

', ], ], 'FailedItemReason' => [ 'base' => NULL, 'refs' => [ 'FailedItem$Reason' => '

The reason the resource\'s association could not be updated.

', ], ], 'FirewallDeploymentModel' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicy$FirewallDeploymentModel' => '

Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to NULL.

', 'ThirdPartyFirewallPolicy$FirewallDeploymentModel' => '

Defines the deployment model to use for the third-party firewall policy.

', ], ], 'FirewallPolicyId' => [ 'base' => NULL, 'refs' => [ 'ThirdPartyFirewallFirewallPolicy$FirewallPolicyId' => '

The ID of the specified firewall policy.

', ], ], 'FirewallPolicyName' => [ 'base' => NULL, 'refs' => [ 'ThirdPartyFirewallFirewallPolicy$FirewallPolicyName' => '

The name of the specified firewall policy.

', ], ], 'FirewallSubnetIsOutOfScopeViolation' => [ 'base' => '

Contains details about the firewall subnet that violates the policy scope.

', 'refs' => [ 'ResourceViolation$FirewallSubnetIsOutOfScopeViolation' => '

Contains details about the firewall subnet that violates the policy scope.

', ], ], 'FirewallSubnetMissingVPCEndpointViolation' => [ 'base' => '

The violation details for a firewall subnet\'s VPC endpoint that\'s deleted or missing.

', 'refs' => [ 'ResourceViolation$FirewallSubnetMissingVPCEndpointViolation' => '

The violation details for a third-party firewall\'s VPC endpoint subnet that was deleted.

', ], ], 'GetAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAdminAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAdminScopeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAdminScopeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAppsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAppsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetComplianceDetailRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetComplianceDetailResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNotificationChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNotificationChannelResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProtectionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProtectionStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProtocolsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProtocolsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetThirdPartyFirewallAssociationStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetThirdPartyFirewallAssociationStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetViolationDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetViolationDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'IPPortNumber' => [ 'base' => NULL, 'refs' => [ 'App$Port' => '

The application\'s port number, for example 80.

', 'SecurityGroupRuleDescription$FromPort' => '

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

', 'SecurityGroupRuleDescription$ToPort' => '

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes.

', ], ], 'IPPortNumberInteger' => [ 'base' => NULL, 'refs' => [ 'NetworkAclPortRange$From' => '

The beginning port number of the range.

', 'NetworkAclPortRange$To' => '

The ending port number of the range.

', ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateResourceRequest$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'BatchAssociateResourceResponse$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'BatchDisassociateResourceRequest$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'BatchDisassociateResourceResponse$ResourceSetIdentifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'DiscoveredResource$URI' => '

The universal resource identifier (URI) of the discovered resource.

', 'FailedItem$URI' => '

The univeral resource indicator (URI) of the resource that failed.

', 'IdentifierList$member' => NULL, 'Resource$URI' => '

The resource\'s universal resource indicator (URI).

', ], ], 'IdentifierList' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateResourceRequest$Items' => '

The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).

', 'BatchDisassociateResourceRequest$Items' => '

The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).

', ], ], 'IntegerObject' => [ 'base' => NULL, 'refs' => [ 'NetworkAclIcmpTypeCode$Code' => '

ICMP code.

', 'NetworkAclIcmpTypeCode$Type' => '

ICMP type.

', ], ], 'IntegerObjectMinimum0' => [ 'base' => NULL, 'refs' => [ 'EntryDescription$EntryRuleNumber' => '

The rule number for the entry. ACL entries are processed in ascending order by rule number. In a Firewall Manager network ACL policy, Firewall Manager assigns rule numbers.

', ], ], 'InternalErrorException' => [ 'base' => '

The operation failed because of a system problem, even though the request was valid. Retry your request.

', 'refs' => [], ], 'InvalidInputException' => [ 'base' => '

The parameters of the request were invalid.

', 'refs' => [], ], 'InvalidNetworkAclEntriesViolation' => [ 'base' => '

Violation detail for the entries in a network ACL resource.

', 'refs' => [ 'ResourceViolation$InvalidNetworkAclEntriesViolation' => '

Violation detail for the entries in a network ACL resource.

', ], ], 'InvalidOperationException' => [ 'base' => '

The operation failed because there was nothing to do or the operation wasn\'t possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that\'s disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

', 'refs' => [], ], 'InvalidTypeException' => [ 'base' => '

The value of the Type parameter is invalid.

', 'refs' => [], ], 'IssueInfoMap' => [ 'base' => NULL, 'refs' => [ 'PolicyComplianceDetail$IssueInfoMap' => '

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

', 'PolicyComplianceStatus$IssueInfoMap' => '

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

', ], ], 'LengthBoundedNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntry$CidrBlock' => '

The IPv4 network range to allow or deny, in CIDR notation.

', 'NetworkAclEntry$Ipv6CidrBlock' => '

The IPv6 network range to allow or deny, in CIDR notation.

', ], ], 'LengthBoundedString' => [ 'base' => NULL, 'refs' => [ 'ActionTarget$Description' => '

A description of the remediation action target.

', 'AwsVPCSecurityGroupViolation$ViolationTargetDescription' => '

A description of the security group that violates the policy.

', 'ComplianceViolatorMetadata$key' => NULL, 'ComplianceViolatorMetadata$value' => NULL, 'CreateNetworkAclAction$Description' => '

Brief description of this remediation action.

', 'CreateNetworkAclEntriesAction$Description' => '

Brief description of this remediation action.

', 'DeleteNetworkAclEntriesAction$Description' => '

Brief description of this remediation action.

', 'DnsDuplicateRuleGroupViolation$ViolationTargetDescription' => '

A description of the violation that specifies the rule group and VPC.

', 'DnsRuleGroupLimitExceededViolation$ViolationTargetDescription' => '

A description of the violation that specifies the rule group and VPC.

', 'DnsRuleGroupPriorityConflictViolation$ViolationTargetDescription' => '

A description of the violation that specifies the VPC and the rule group that\'s already associated with it.

', 'EC2AssociateRouteTableAction$Description' => '

A description of the EC2 route table that is associated with the remediation action.

', 'EC2CopyRouteTableAction$Description' => '

A description of the copied EC2 route table that is associated with the remediation action.

', 'EC2CreateRouteAction$Description' => '

A description of CreateRoute action in Amazon EC2.

', 'EC2CreateRouteTableAction$Description' => '

A description of the CreateRouteTable action.

', 'EC2DeleteRouteAction$Description' => '

A description of the DeleteRoute action.

', 'EC2ReplaceRouteAction$Description' => '

A description of the ReplaceRoute action in Amazon EC2.

', 'EC2ReplaceRouteTableAssociationAction$Description' => '

A description of the ReplaceRouteTableAssociation action in Amazon EC2.

', 'EntryViolation$ExpectedEvaluationOrder' => '

The evaluation location within the ordered list of entries where the ExpectedEntry should be, according to the network ACL policy specifications.

', 'EntryViolation$ActualEvaluationOrder' => '

The evaluation location within the ordered list of entries where the ExpectedEntry is currently located.

', 'FMSPolicyUpdateFirewallCreationConfigAction$Description' => '

Describes the remedial action.

', 'FirewallSubnetIsOutOfScopeViolation$SubnetAvailabilityZone' => '

The Availability Zone of the firewall subnet that violates the policy scope.

', 'FirewallSubnetIsOutOfScopeViolation$SubnetAvailabilityZoneId' => '

The Availability Zone ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetMissingVPCEndpointViolation$SubnetAvailabilityZone' => '

The name of the Availability Zone of the deleted VPC subnet.

', 'FirewallSubnetMissingVPCEndpointViolation$SubnetAvailabilityZoneId' => '

The ID of the Availability Zone of the deleted VPC subnet.

', 'InvalidNetworkAclEntriesViolation$SubnetAvailabilityZone' => '

The Availability Zone where the network ACL is in use.

', 'LengthBoundedStringList$member' => NULL, 'NetworkAclEntry$Protocol' => '

The protocol number. A value of "-1" means all protocols.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$SubnetAvailabilityZone' => '

The subnet Availability Zone.

', 'NetworkFirewallMissingExpectedRTViolation$AvailabilityZone' => '

The Availability Zone of a violating subnet.

', 'NetworkFirewallMissingFirewallViolation$AvailabilityZone' => '

The Availability Zone of a violating subnet.

', 'NetworkFirewallMissingSubnetViolation$AvailabilityZone' => '

The Availability Zone of a violating subnet.

', 'PossibleRemediationAction$Description' => '

A description of the list of remediation actions.

', 'PossibleRemediationActions$Description' => '

A description of the possible remediation actions list.

', 'RemediationAction$Description' => '

A description of a remediation action.

', 'ReplaceNetworkAclAssociationAction$Description' => '

Brief description of this remediation action.

', 'Route$Destination' => '

The destination of the route.

', 'Route$Target' => '

The route\'s target.

', 'RouteHasOutOfScopeEndpointViolation$SubnetAvailabilityZone' => '

The subnet\'s Availability Zone.

', 'RouteHasOutOfScopeEndpointViolation$SubnetAvailabilityZoneId' => '

The ID of the subnet\'s Availability Zone.

', 'SecurityGroupRuleDescription$Protocol' => '

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$AvailabilityZone' => '

The Availability Zone of the firewall subnet that\'s causing the violation.

', 'ThirdPartyFirewallMissingFirewallViolation$AvailabilityZone' => '

The Availability Zone of the third-party firewall that\'s causing the violation.

', 'ThirdPartyFirewallMissingSubnetViolation$AvailabilityZone' => '

The Availability Zone of a subnet that\'s causing the violation.

', 'ViolationDetail$ResourceDescription' => '

Brief description for the requested resource.

', ], ], 'LengthBoundedStringList' => [ 'base' => NULL, 'refs' => [ 'ExpectedRoute$AllowedTargets' => '

Information about the allowed targets.

', ], ], 'LimitExceededException' => [ 'base' => '

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

', 'refs' => [], ], 'ListAdminAccountsForOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAdminAccountsForOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAdminsManagingAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAdminsManagingAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListComplianceStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListComplianceStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDiscoveredResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDiscoveredResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListId' => [ 'base' => NULL, 'refs' => [ 'AppsListData$ListId' => '

The ID of the Firewall Manager applications list.

', 'AppsListDataSummary$ListId' => '

The ID of the applications list.

', 'DeleteAppsListRequest$ListId' => '

The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList.

', 'DeleteProtocolsListRequest$ListId' => '

The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.

', 'GetAppsListRequest$ListId' => '

The ID of the Firewall Manager applications list that you want the details for.

', 'GetProtocolsListRequest$ListId' => '

The ID of the Firewall Manager protocols list that you want the details for.

', 'ProtocolsListData$ListId' => '

The ID of the Firewall Manager protocols list.

', 'ProtocolsListDataSummary$ListId' => '

The ID of the specified protocols list.

', ], ], 'ListMemberAccountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMemberAccountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProtocolsListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProtocolsListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThirdPartyFirewallFirewallPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThirdPartyFirewallFirewallPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ManagedServiceData' => [ 'base' => NULL, 'refs' => [ 'FMSPolicyUpdateFirewallCreationConfigAction$FirewallCreationConfig' => '

A FirewallCreationConfig that you can copy into your current policy\'s SecurityServiceData in order to remedy scope violations.

', 'SecurityServicePolicyData$ManagedServiceData' => '

Details about the service that are specific to the service type, in JSON format.

', ], ], 'MarketplaceSubscriptionOnboardingStatus' => [ 'base' => NULL, 'refs' => [ 'GetThirdPartyFirewallAssociationStatusResponse$MarketplaceOnboardingStatus' => '

The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.

', ], ], 'MemberAccounts' => [ 'base' => NULL, 'refs' => [ 'ListMemberAccountsResponse$MemberAccounts' => '

An array of account IDs.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ResourceSet$Name' => '

The descriptive name of the resource set. You can\'t change the name of a resource set after you create it.

', 'ResourceSetSummary$Name' => '

The descriptive name of the resource set. You can\'t change the name of a resource set after you create it.

', ], ], 'NetworkAclCommonPolicy' => [ 'base' => '

Defines a Firewall Manager network ACL policy. This is used in the PolicyOption of a SecurityServicePolicyData for a Policy, when the SecurityServicePolicyData type is set to NETWORK_ACL_COMMON.

For information about network ACLs, see Control traffic to subnets using network ACLs in the Amazon Virtual Private Cloud User Guide.

', 'refs' => [ 'PolicyOption$NetworkAclCommonPolicy' => '

Defines a Firewall Manager network ACL policy.

', ], ], 'NetworkAclEntries' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntrySet$FirstEntries' => '

The rules that you want to run first in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

You must specify at least one first entry or one last entry in any network ACL policy.

', 'NetworkAclEntrySet$LastEntries' => '

The rules that you want to run last in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

You must specify at least one first entry or one last entry in any network ACL policy.

', ], ], 'NetworkAclEntry' => [ 'base' => '

Describes a rule in a network ACL.

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the entries in the network ACL according to the rule numbers, in ascending order.

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

', 'refs' => [ 'EntryDescription$EntryDetail' => '

Describes a rule in a network ACL.

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the entries in the network ACL according to the rule numbers, in ascending order.

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

', 'NetworkAclEntries$member' => NULL, ], ], 'NetworkAclEntrySet' => [ 'base' => '

The configuration of the first and last rules for the network ACL policy, and the remediation settings for each.

', 'refs' => [ 'NetworkAclCommonPolicy$NetworkAclEntrySet' => '

The definition of the first and last rules for the network ACL policy.

', ], ], 'NetworkAclIcmpTypeCode' => [ 'base' => '

ICMP protocol: The ICMP type and code.

', 'refs' => [ 'NetworkAclEntry$IcmpTypeCode' => '

ICMP protocol: The ICMP type and code.

', ], ], 'NetworkAclPortRange' => [ 'base' => '

TCP or UDP protocols: The range of ports the rule applies to.

', 'refs' => [ 'NetworkAclEntry$PortRange' => '

TCP or UDP protocols: The range of ports the rule applies to.

', ], ], 'NetworkAclRuleAction' => [ 'base' => NULL, 'refs' => [ 'NetworkAclEntry$RuleAction' => '

Indicates whether to allow or deny the traffic that matches the rule.

', ], ], 'NetworkFirewallAction' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallActionList$member' => NULL, ], ], 'NetworkFirewallActionList' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicyDescription$StatelessDefaultActions' => '

The actions to take on packets that don\'t match any of the stateless rule groups.

', 'NetworkFirewallPolicyDescription$StatelessFragmentDefaultActions' => '

The actions to take on packet fragments that don\'t match any of the stateless rule groups.

', 'NetworkFirewallPolicyDescription$StatelessCustomActions' => '

Names of custom actions that are available for use in the stateless default actions settings.

', 'NetworkFirewallPolicyDescription$StatefulDefaultActions' => '

The default actions to take on a packet that doesn\'t match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

', ], ], 'NetworkFirewallBlackHoleRouteDetectedViolation' => [ 'base' => '

Violation detail for an internet gateway route with an inactive state in the customer subnet route table or Network Firewall subnet route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallBlackHoleRouteDetectedViolation' => NULL, ], ], 'NetworkFirewallInternetTrafficNotInspectedViolation' => [ 'base' => '

Violation detail for the subnet for which internet traffic that hasn\'t been inspected.

', 'refs' => [ 'ResourceViolation$NetworkFirewallInternetTrafficNotInspectedViolation' => '

Violation detail for the subnet for which internet traffic hasn\'t been inspected.

', ], ], 'NetworkFirewallInvalidRouteConfigurationViolation' => [ 'base' => '

Violation detail for the improperly configured subnet route. It\'s possible there is a missing route table route, or a configuration that causes traffic to cross an Availability Zone boundary.

', 'refs' => [ 'ResourceViolation$NetworkFirewallInvalidRouteConfigurationViolation' => '

The route configuration is invalid.

', ], ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'base' => '

Violation detail for Network Firewall for a subnet that\'s not associated to the expected Firewall Manager managed route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingExpectedRTViolation' => '

Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.

', ], ], 'NetworkFirewallMissingExpectedRoutesViolation' => [ 'base' => '

Violation detail for an expected route missing in Network Firewall.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingExpectedRoutesViolation' => '

Expected routes are missing from Network Firewall.

', ], ], 'NetworkFirewallMissingFirewallViolation' => [ 'base' => '

Violation detail for Network Firewall for a subnet that doesn\'t have a Firewall Manager managed firewall in its VPC.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingFirewallViolation' => '

Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.

', ], ], 'NetworkFirewallMissingSubnetViolation' => [ 'base' => '

Violation detail for Network Firewall for an Availability Zone that\'s missing the expected Firewall Manager managed subnet.

', 'refs' => [ 'ResourceViolation$NetworkFirewallMissingSubnetViolation' => '

Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.

', ], ], 'NetworkFirewallOverrideAction' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallStatefulRuleGroupOverride$Action' => '

The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.

', ], ], 'NetworkFirewallPolicy' => [ 'base' => '

Configures the firewall policy deployment model of Network Firewall. For information about Network Firewall deployment models, see Network Firewall example architectures with routing in the Network Firewall Developer Guide.

', 'refs' => [ 'PolicyOption$NetworkFirewallPolicy' => '

Defines the deployment model to use for the firewall policy.

', ], ], 'NetworkFirewallPolicyDescription' => [ 'base' => '

The definition of the Network Firewall firewall policy.

', 'refs' => [ 'NetworkFirewallPolicyModifiedViolation$CurrentPolicyDescription' => '

The policy that\'s currently in use in the individual account.

', 'NetworkFirewallPolicyModifiedViolation$ExpectedPolicyDescription' => '

The policy that should be in use in the individual account in order to be compliant.

', ], ], 'NetworkFirewallPolicyModifiedViolation' => [ 'base' => '

Violation detail for Network Firewall for a firewall policy that has a different NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.

', 'refs' => [ 'ResourceViolation$NetworkFirewallPolicyModifiedViolation' => '

Violation detail for an Network Firewall policy that indicates that a firewall policy in an individual account has been modified in a way that makes it noncompliant. For example, the individual account owner might have deleted a rule group, changed the priority of a stateless rule group, or changed a policy default action.

', ], ], 'NetworkFirewallResourceName' => [ 'base' => NULL, 'refs' => [ 'StatefulRuleGroup$RuleGroupName' => '

The name of the rule group.

', 'StatelessRuleGroup$RuleGroupName' => '

The name of the rule group.

', ], ], 'NetworkFirewallStatefulRuleGroupOverride' => [ 'base' => '

The setting that allows the policy owner to change the behavior of the rule group within a policy.

', 'refs' => [ 'StatefulRuleGroup$Override' => '

The action that allows the policy owner to override the behavior of the rule group within a policy.

', ], ], 'NetworkFirewallUnexpectedFirewallRoutesViolation' => [ 'base' => '

Violation detail for an unexpected route that\'s present in a route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallUnexpectedFirewallRoutesViolation' => '

There\'s an unexpected firewall route.

', ], ], 'NetworkFirewallUnexpectedGatewayRoutesViolation' => [ 'base' => '

Violation detail for an unexpected gateway route that’s present in a route table.

', 'refs' => [ 'ResourceViolation$NetworkFirewallUnexpectedGatewayRoutesViolation' => '

There\'s an unexpected gateway route.

', ], ], 'OrderedRemediationActions' => [ 'base' => NULL, 'refs' => [ 'PossibleRemediationAction$OrderedRemediationActions' => '

The ordered list of remediation actions.

', ], ], 'OrganizationStatus' => [ 'base' => NULL, 'refs' => [ 'AdminAccountSummary$Status' => '

The current status of the request to onboard a member account as an Firewall Manager administrator.

', 'GetAdminScopeResponse$Status' => '

The current status of the request to onboard a member account as an Firewall Manager administrator.

', ], ], 'OrganizationalUnitId' => [ 'base' => NULL, 'refs' => [ 'OrganizationalUnitIdList$member' => NULL, ], ], 'OrganizationalUnitIdList' => [ 'base' => NULL, 'refs' => [ 'OrganizationalUnitScope$OrganizationalUnits' => '

The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to true, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to false, then the Firewall Manager administrator can only apply policies to the OUs in this list.

', ], ], 'OrganizationalUnitScope' => [ 'base' => '

Defines the Organizations organizational units (OUs) that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

', 'refs' => [ 'AdminScope$OrganizationalUnitScope' => '

Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

', ], ], 'PaginationMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusRequest$MaxResults' => '

Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

', 'ListAdminAccountsForOrganizationRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListAdminsManagingAccountRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListAppsListsRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify this, Firewall Manager returns all available objects.

', 'ListComplianceStatusRequest$MaxResults' => '

Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.

', 'ListDiscoveredResourcesRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListMemberAccountsRequest$MaxResults' => '

Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

', 'ListPoliciesRequest$MaxResults' => '

Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

', 'ListProtocolsListsRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify this, Firewall Manager returns all available objects.

', 'ListResourceSetResourcesRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListResourceSetsRequest$MaxResults' => '

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

', 'ListThirdPartyFirewallFirewallPoliciesRequest$MaxResults' => '

The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than MaxResults firewall policies, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusRequest$NextToken' => '

If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

', 'GetProtectionStatusResponse$NextToken' => '

If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

', 'ListAdminAccountsForOrganizationRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAdminAccountsForOrganizationResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAdminsManagingAccountRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAdminsManagingAccountResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListAppsListsRequest$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

', 'ListAppsListsResponse$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

', 'ListComplianceStatusRequest$NextToken' => '

If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

', 'ListComplianceStatusResponse$NextToken' => '

If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

', 'ListDiscoveredResourcesRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListDiscoveredResourcesResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListMemberAccountsRequest$NextToken' => '

If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

', 'ListMemberAccountsResponse$NextToken' => '

If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

', 'ListPoliciesRequest$NextToken' => '

If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

', 'ListPoliciesResponse$NextToken' => '

If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

', 'ListProtocolsListsRequest$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

', 'ListProtocolsListsResponse$NextToken' => '

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

', 'ListResourceSetResourcesRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListResourceSetResourcesResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListResourceSetsRequest$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListResourceSetsResponse$NextToken' => '

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

', 'ListThirdPartyFirewallFirewallPoliciesRequest$NextToken' => '

If the previous response included a NextToken element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another ListThirdPartyFirewallFirewallPoliciesRequest request.

For the value of NextToken, specify the value of NextToken from the previous response. If the previous response didn\'t include a NextToken element, there are no more third-party firewall policies to get.

', 'ListThirdPartyFirewallFirewallPoliciesResponse$NextToken' => '

The value that you will use for NextToken in the next ListThirdPartyFirewallFirewallPolicies request.

', ], ], 'PartialMatch' => [ 'base' => '

The reference rule that partially matches the ViolationTarget rule and violation reason.

', 'refs' => [ 'PartialMatches$member' => NULL, ], ], 'PartialMatches' => [ 'base' => NULL, 'refs' => [ 'AwsVPCSecurityGroupViolation$PartialMatches' => '

List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule.

', ], ], 'Policy' => [ 'base' => '

An Firewall Manager policy.

', 'refs' => [ 'GetPolicyResponse$Policy' => '

Information about the specified Firewall Manager policy.

', 'PutPolicyRequest$Policy' => '

The details of the Firewall Manager policy to be created.

', 'PutPolicyResponse$Policy' => '

The details of the Firewall Manager policy.

', ], ], 'PolicyComplianceDetail' => [ 'base' => '

Describes the noncompliant resources in a member account for a specific Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded is set to True.

', 'refs' => [ 'GetComplianceDetailResponse$PolicyComplianceDetail' => '

Information about the resources and the policy that you specified in the GetComplianceDetail request.

', ], ], 'PolicyComplianceStatus' => [ 'base' => '

Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

', 'refs' => [ 'PolicyComplianceStatusList$member' => NULL, ], ], 'PolicyComplianceStatusList' => [ 'base' => NULL, 'refs' => [ 'ListComplianceStatusResponse$PolicyComplianceStatusList' => '

An array of PolicyComplianceStatus objects.

', ], ], 'PolicyComplianceStatusType' => [ 'base' => NULL, 'refs' => [ 'EvaluationResult$ComplianceStatus' => '

Describes an Amazon Web Services account\'s compliance with the Firewall Manager policy.

', ], ], 'PolicyId' => [ 'base' => NULL, 'refs' => [ 'DeletePolicyRequest$PolicyId' => '

The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

', 'DnsRuleGroupPriorityConflictViolation$ConflictingPolicyId' => '

The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy contains the rule group that\'s already associated with the VPC.

', 'GetComplianceDetailRequest$PolicyId' => '

The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.

', 'GetPolicyRequest$PolicyId' => '

The ID of the Firewall Manager policy that you want the details for.

', 'GetProtectionStatusRequest$PolicyId' => '

The ID of the policy for which you want to get the attack information.

', 'GetViolationDetailsRequest$PolicyId' => '

The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:

', 'ListComplianceStatusRequest$PolicyId' => '

The ID of the Firewall Manager policy that you want the details for.

', 'Policy$PolicyId' => '

The ID of the Firewall Manager policy.

', 'PolicyComplianceDetail$PolicyId' => '

The ID of the Firewall Manager policy.

', 'PolicyComplianceStatus$PolicyId' => '

The ID of the Firewall Manager policy.

', 'PolicySummary$PolicyId' => '

The ID of the specified policy.

', 'ViolationDetail$PolicyId' => '

The ID of the Firewall Manager policy that the violation details were requested for.

', ], ], 'PolicyOption' => [ 'base' => '

Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.

', 'refs' => [ 'SecurityServicePolicyData$PolicyOption' => '

Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.

', ], ], 'PolicySummary' => [ 'base' => '

Details of the Firewall Manager policy.

', 'refs' => [ 'PolicySummaryList$member' => NULL, ], ], 'PolicySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPoliciesResponse$PolicyList' => '

An array of PolicySummary objects.

', ], ], 'PolicyTypeScope' => [ 'base' => '

Defines the policy types that the specified Firewall Manager administrator can manage.

', 'refs' => [ 'AdminScope$PolicyTypeScope' => '

Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage.

', ], ], 'PolicyUpdateToken' => [ 'base' => NULL, 'refs' => [ 'Policy$PolicyUpdateToken' => '

A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

', ], ], 'PossibleRemediationAction' => [ 'base' => '

A list of remediation actions.

', 'refs' => [ 'PossibleRemediationActionList$member' => NULL, ], ], 'PossibleRemediationActionList' => [ 'base' => NULL, 'refs' => [ 'PossibleRemediationActions$Actions' => '

Information about the actions.

', ], ], 'PossibleRemediationActions' => [ 'base' => '

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

', 'refs' => [ 'ResourceViolation$PossibleRemediationActions' => '

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

', ], ], 'PreviousAppsList' => [ 'base' => NULL, 'refs' => [ 'AppsListData$PreviousAppsList' => '

A map of previous version numbers to their corresponding App object arrays.

', ], ], 'PreviousListVersion' => [ 'base' => NULL, 'refs' => [ 'PreviousAppsList$key' => NULL, 'PreviousProtocolsList$key' => NULL, ], ], 'PreviousProtocolsList' => [ 'base' => NULL, 'refs' => [ 'ProtocolsListData$PreviousProtocolsList' => '

A map of previous version numbers to their corresponding protocol arrays.

', ], ], 'PriorityNumber' => [ 'base' => NULL, 'refs' => [ 'StatefulRuleGroup$Priority' => '

An integer setting that indicates the order in which to run the stateful rule groups in a single Network Firewall firewall policy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.

Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. For information about

You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there\'s a wide range in between, for example use 100, 200, and so on.

', ], ], 'ProtectionData' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusResponse$Data' => '

Details about the attack, including the following:

The details are in JSON format.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'App$Protocol' => '

The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

', 'ProtocolsList$member' => NULL, ], ], 'ProtocolsList' => [ 'base' => NULL, 'refs' => [ 'PreviousProtocolsList$value' => NULL, 'ProtocolsListData$ProtocolsList' => '

An array of protocols in the Firewall Manager protocols list.

', 'ProtocolsListDataSummary$ProtocolsList' => '

An array of protocols in the Firewall Manager protocols list.

', ], ], 'ProtocolsListData' => [ 'base' => '

An Firewall Manager protocols list.

', 'refs' => [ 'GetProtocolsListResponse$ProtocolsList' => '

Information about the specified Firewall Manager protocols list.

', 'PutProtocolsListRequest$ProtocolsList' => '

The details of the Firewall Manager protocols list to be created.

', 'PutProtocolsListResponse$ProtocolsList' => '

The details of the Firewall Manager protocols list.

', ], ], 'ProtocolsListDataSummary' => [ 'base' => '

Details of the Firewall Manager protocols list.

', 'refs' => [ 'ProtocolsListsData$member' => NULL, ], ], 'ProtocolsListsData' => [ 'base' => NULL, 'refs' => [ 'ListProtocolsListsResponse$ProtocolsLists' => '

An array of ProtocolsListDataSummary objects.

', ], ], 'PutAdminAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAppsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAppsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutNotificationChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutProtocolsListRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutProtocolsListResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourceSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourceSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReferenceRule' => [ 'base' => NULL, 'refs' => [ 'PartialMatch$Reference' => '

The reference rule from the primary security group of the Firewall Manager policy.

', ], ], 'RegionScope' => [ 'base' => '

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can manage.

', 'refs' => [ 'AdminScope$RegionScope' => '

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

', ], ], 'RemediationAction' => [ 'base' => '

Information about an individual action you can take to remediate a violation.

', 'refs' => [ 'RemediationActionWithOrder$RemediationAction' => '

Information about an action you can take to remediate a violation.

', ], ], 'RemediationActionDescription' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupRemediationAction$Description' => '

Brief description of the action that will be performed.

', ], ], 'RemediationActionType' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupRemediationAction$RemediationActionType' => '

The remediation action that will be performed.

', ], ], 'RemediationActionWithOrder' => [ 'base' => '

An ordered list of actions you can take to remediate a violation.

', 'refs' => [ 'OrderedRemediationActions$member' => NULL, ], ], 'ReplaceNetworkAclAssociationAction' => [ 'base' => '

Information about the ReplaceNetworkAclAssociation action in Amazon EC2. This is a remediation option in RemediationAction.

', 'refs' => [ 'RemediationAction$ReplaceNetworkAclAssociationAction' => '

Information about the ReplaceNetworkAclAssociation action in Amazon EC2.

', ], ], 'Resource' => [ 'base' => '

Details of a resource that is associated to an Firewall Manager resource set.

', 'refs' => [ 'ResourceList$member' => NULL, ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AppsListDataSummary$ListArn' => '

The Amazon Resource Name (ARN) of the applications list.

', 'GetAppsListResponse$AppsListArn' => '

The Amazon Resource Name (ARN) of the applications list.

', 'GetNotificationChannelResponse$SnsTopicArn' => '

The SNS topic that records Firewall Manager activity.

', 'GetNotificationChannelResponse$SnsRoleName' => '

The IAM role that is used by Firewall Manager to record activity to SNS.

', 'GetPolicyResponse$PolicyArn' => '

The Amazon Resource Name (ARN) of the specified policy.

', 'GetProtocolsListResponse$ProtocolsListArn' => '

The Amazon Resource Name (ARN) of the specified protocols list.

', 'GetResourceSetResponse$ResourceSetArn' => '

The Amazon Resource Name (ARN) of the resource set.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

', 'PolicySummary$PolicyArn' => '

The Amazon Resource Name (ARN) of the specified policy.

', 'ProtocolsListDataSummary$ListArn' => '

The Amazon Resource Name (ARN) of the specified protocols list.

', 'PutAppsListResponse$AppsListArn' => '

The Amazon Resource Name (ARN) of the applications list.

', 'PutNotificationChannelRequest$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from Firewall Manager.

', 'PutNotificationChannelRequest$SnsRoleName' => '

The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record Firewall Manager activity.

', 'PutPolicyResponse$PolicyArn' => '

The Amazon Resource Name (ARN) of the policy.

', 'PutProtocolsListResponse$ProtocolsListArn' => '

The Amazon Resource Name (ARN) of the protocols list.

', 'PutResourceSetResponse$ResourceSetArn' => '

The Amazon Resource Name (ARN) of the resource set.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

', ], ], 'ResourceCount' => [ 'base' => NULL, 'refs' => [ 'EvaluationResult$ViolatorCount' => '

The number of resources that are noncompliant with the specified policy. For WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn\'t comply with the rules of the policy and remediation is disabled or not possible.

', ], ], 'ResourceDescription' => [ 'base' => NULL, 'refs' => [ 'Policy$PolicyDescription' => '

The definition of the Network Firewall firewall policy.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ActionTarget$ResourceId' => '

The ID of the remediation target.

', 'ComplianceViolator$ResourceId' => '

The resource ID.

', 'EC2CreateRouteAction$DestinationPrefixListId' => '

Information about the ID of a prefix list used for the destination match.

', 'EC2DeleteRouteAction$DestinationPrefixListId' => '

Information about the ID of the prefix list for the route.

', 'EC2ReplaceRouteAction$DestinationPrefixListId' => '

Information about the ID of the prefix list for the route.

', 'ExpectedRoute$RouteTableId' => '

Information about the route table ID.

', 'FirewallSubnetIsOutOfScopeViolation$FirewallSubnetId' => '

The ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetIsOutOfScopeViolation$VpcId' => '

The VPC ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetIsOutOfScopeViolation$VpcEndpointId' => '

The VPC endpoint ID of the firewall subnet that violates the policy scope.

', 'FirewallSubnetMissingVPCEndpointViolation$FirewallSubnetId' => '

The ID of the firewall that this VPC endpoint is associated with.

', 'FirewallSubnetMissingVPCEndpointViolation$VpcId' => '

The resource ID of the VPC associated with the deleted VPC subnet.

', 'GetViolationDetailsRequest$ResourceId' => '

The ID of the resource that has violations.

', 'InvalidNetworkAclEntriesViolation$Vpc' => '

The VPC where the violation was found.

', 'InvalidNetworkAclEntriesViolation$Subnet' => '

The subnet that\'s associated with the network ACL.

', 'InvalidNetworkAclEntriesViolation$CurrentAssociatedNetworkAcl' => '

The network ACL containing the entry violations.

', 'ListResourceSetResourcesRequest$Identifier' => '

A unique identifier for the resource set, used in a request to refer to the resource set.

', 'NetworkFirewallBlackHoleRouteDetectedViolation$RouteTableId' => '

Information about the route table ID.

', 'NetworkFirewallBlackHoleRouteDetectedViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$SubnetId' => '

The subnet ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$RouteTableId' => '

Information about the route table ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$CurrentFirewallSubnetRouteTable' => '

Information about the subnet route table for the current firewall.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ExpectedFirewallEndpoint' => '

The expected endpoint for the current firewall.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$FirewallSubnetId' => '

The firewall subnet ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$InternetGatewayId' => '

The internet gateway ID.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$CurrentInternetGatewayRouteTable' => '

The current route table for the internet gateway.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallInvalidRouteConfigurationViolation$RouteTableId' => '

The route table ID.

', 'NetworkFirewallInvalidRouteConfigurationViolation$CurrentFirewallSubnetRouteTable' => '

The subnet route table for the current firewall.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedFirewallEndpoint' => '

The firewall endpoint that\'s expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualFirewallEndpoint' => '

The actual firewall endpoint.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ExpectedFirewallSubnetId' => '

The expected subnet ID for the firewall.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualFirewallSubnetId' => '

The actual subnet ID for the firewall.

', 'NetworkFirewallInvalidRouteConfigurationViolation$InternetGatewayId' => '

The internet gateway ID.

', 'NetworkFirewallInvalidRouteConfigurationViolation$CurrentInternetGatewayRouteTable' => '

The route table for the current internet gateway.

', 'NetworkFirewallInvalidRouteConfigurationViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallMissingExpectedRTViolation$VPC' => '

The resource ID of the VPC associated with a violating subnet.

', 'NetworkFirewallMissingExpectedRTViolation$CurrentRouteTable' => '

The resource ID of the current route table that\'s associated with the subnet, if one is available.

', 'NetworkFirewallMissingExpectedRTViolation$ExpectedRouteTable' => '

The resource ID of the route table that should be associated with the subnet.

', 'NetworkFirewallMissingExpectedRoutesViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallMissingFirewallViolation$VPC' => '

The resource ID of the VPC associated with a violating subnet.

', 'NetworkFirewallMissingSubnetViolation$VPC' => '

The resource ID of the VPC associated with a violating subnet.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$FirewallSubnetId' => '

The subnet ID for the firewall.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$RouteTableId' => '

The ID of the route table.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$FirewallEndpoint' => '

The endpoint of the firewall.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$VpcId' => '

Information about the VPC ID.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$GatewayId' => '

Information about the gateway ID.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$RouteTableId' => '

Information about the route table.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$VpcId' => '

Information about the VPC ID.

', 'ResourceIdList$member' => NULL, 'RouteHasOutOfScopeEndpointViolation$SubnetId' => '

The ID of the subnet associated with the route that violates the policy scope.

', 'RouteHasOutOfScopeEndpointViolation$VpcId' => '

The VPC ID of the route that violates the policy scope.

', 'RouteHasOutOfScopeEndpointViolation$RouteTableId' => '

The ID of the route table.

', 'RouteHasOutOfScopeEndpointViolation$CurrentFirewallSubnetRouteTable' => '

The route table associated with the current firewall subnet.

', 'RouteHasOutOfScopeEndpointViolation$FirewallSubnetId' => '

The ID of the firewall subnet.

', 'RouteHasOutOfScopeEndpointViolation$InternetGatewayId' => '

The ID of the Internet Gateway.

', 'RouteHasOutOfScopeEndpointViolation$CurrentInternetGatewayRouteTable' => '

The current route table associated with the Internet Gateway.

', 'SecurityGroupRuleDescription$PrefixListId' => '

The ID of the prefix list for the security group rule.

', 'StatefulRuleGroup$ResourceId' => '

The resource ID of the rule group.

', 'StatelessRuleGroup$ResourceId' => '

The resource ID of the rule group.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$VPC' => '

The resource ID of the VPC associated with a fireawll subnet that\'s causing the violation.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$CurrentRouteTable' => '

The resource ID of the current route table that\'s associated with the subnet, if one is available.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$ExpectedRouteTable' => '

The resource ID of the route table that should be associated with the subnet.

', 'ThirdPartyFirewallMissingFirewallViolation$VPC' => '

The resource ID of the VPC associated with a third-party firewall.

', 'ThirdPartyFirewallMissingSubnetViolation$VPC' => '

The resource ID of the VPC associated with a subnet that\'s causing the violation.

', 'ViolationDetail$ResourceId' => '

The resource ID that the violation details were requested for.

', ], ], 'ResourceIdList' => [ 'base' => NULL, 'refs' => [ 'AwsEc2NetworkInterfaceViolation$ViolatingSecurityGroups' => '

List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.

', 'ExpectedRoute$ContributingSubnets' => '

Information about the contributing subnets.

', 'NetworkFirewallInvalidRouteConfigurationViolation$AffectedSubnets' => '

The subnets that are affected.

', ], ], 'ResourceList' => [ 'base' => NULL, 'refs' => [ 'ListResourceSetResourcesResponse$Items' => '

An array of the associated resources\' uniform resource identifiers (URI).

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'App$AppName' => '

The application\'s name.

', 'AppsListData$ListName' => '

The name of the Firewall Manager applications list.

', 'AppsListDataSummary$ListName' => '

The name of the applications list.

', 'DiscoveredResource$Name' => '

The name of the discovered resource.

', 'Policy$PolicyName' => '

The name of the Firewall Manager policy.

', 'PolicyComplianceStatus$PolicyName' => '

The name of the Firewall Manager policy.

', 'PolicySummary$PolicyName' => '

The name of the specified policy.

', 'ProtocolsListData$ListName' => '

The name of the Firewall Manager protocols list.

', 'ProtocolsListDataSummary$ListName' => '

The name of the specified protocols list.

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

The specified resource was not found.

', 'refs' => [], ], 'ResourceSet' => [ 'base' => '

A set of resources to include in a policy.

', 'refs' => [ 'GetResourceSetResponse$ResourceSet' => '

Information about the specified resource set.

', 'PutResourceSetRequest$ResourceSet' => '

Details about the resource set to be created or updated.>

', 'PutResourceSetResponse$ResourceSet' => '

Details about the resource set.

', ], ], 'ResourceSetIds' => [ 'base' => NULL, 'refs' => [ 'Policy$ResourceSetIds' => '

The unique identifiers of the resource sets used by the policy.

', ], ], 'ResourceSetStatus' => [ 'base' => NULL, 'refs' => [ 'ResourceSet$ResourceSetStatus' => '

Indicates whether the resource set is in or out of an admin\'s Region scope.

', 'ResourceSetSummary$ResourceSetStatus' => '

Indicates whether the resource set is in or out of an admin\'s Region scope.

', ], ], 'ResourceSetSummary' => [ 'base' => '

Summarizes the resource sets used in a policy.

', 'refs' => [ 'ResourceSetSummaryList$member' => NULL, ], ], 'ResourceSetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListResourceSetsResponse$ResourceSets' => '

An array of ResourceSetSummary objects.

', ], ], 'ResourceTag' => [ 'base' => '

The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.

', 'refs' => [ 'ResourceTags$member' => NULL, ], ], 'ResourceTagKey' => [ 'base' => NULL, 'refs' => [ 'ResourceTag$Key' => '

The resource tag key.

', ], ], 'ResourceTagValue' => [ 'base' => NULL, 'refs' => [ 'ResourceTag$Value' => '

The resource tag value.

', ], ], 'ResourceTags' => [ 'base' => NULL, 'refs' => [ 'Policy$ResourceTags' => '

An array of ResourceTag objects.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ComplianceViolator$ResourceType' => '

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.

', 'DiscoveredResource$Type' => '

The type of the discovered resource.

', 'GetViolationDetailsRequest$ResourceType' => '

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.

', 'ListDiscoveredResourcesRequest$ResourceType' => '

The type of resources to discover.

', 'Policy$ResourceType' => '

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

The following are valid resource types for each Firewall Manager policy type:

', 'PolicySummary$ResourceType' => '

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.

', 'ResourceTypeList$member' => NULL, 'ViolationDetail$ResourceType' => '

The resource type that the violation details were requested for.

', ], ], 'ResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'Policy$ResourceTypeList' => '

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.

', 'ResourceSet$ResourceTypeList' => '

Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

', ], ], 'ResourceViolation' => [ 'base' => '

Violation detail based on resource type.

', 'refs' => [ 'ResourceViolations$member' => NULL, ], ], 'ResourceViolations' => [ 'base' => NULL, 'refs' => [ 'ViolationDetail$ResourceViolations' => '

List of violations for the requested resource.

', ], ], 'Route' => [ 'base' => '

Describes a route in a route table.

', 'refs' => [ 'NetworkFirewallInvalidRouteConfigurationViolation$ViolatingRoute' => '

The route that\'s in violation.

', 'Routes$member' => NULL, ], ], 'RouteHasOutOfScopeEndpointViolation' => [ 'base' => '

Contains details about the route endpoint that violates the policy scope.

', 'refs' => [ 'ResourceViolation$RouteHasOutOfScopeEndpointViolation' => '

Contains details about the route endpoint that violates the policy scope.

', ], ], 'Routes' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallBlackHoleRouteDetectedViolation$ViolatingRoutes' => '

Information about the route or routes that are in violation.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ViolatingRoutes' => '

The route or routes that are in violation.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ActualFirewallSubnetRoutes' => '

The actual firewall subnet routes.

', 'NetworkFirewallInternetTrafficNotInspectedViolation$ActualInternetGatewayRoutes' => '

The actual internet gateway routes.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualFirewallSubnetRoutes' => '

The actual firewall subnet routes that are expected.

', 'NetworkFirewallInvalidRouteConfigurationViolation$ActualInternetGatewayRoutes' => '

The actual internet gateway routes.

', 'NetworkFirewallUnexpectedFirewallRoutesViolation$ViolatingRoutes' => '

The routes that are in violation.

', 'NetworkFirewallUnexpectedGatewayRoutesViolation$ViolatingRoutes' => '

The routes that are in violation.

', 'RouteHasOutOfScopeEndpointViolation$ViolatingRoutes' => '

The list of routes that violate the route table.

', 'RouteHasOutOfScopeEndpointViolation$FirewallSubnetRoutes' => '

The list of firewall subnet routes.

', 'RouteHasOutOfScopeEndpointViolation$InternetGatewayRoutes' => '

The routes in the route table associated with the Internet Gateway.

', ], ], 'RuleOrder' => [ 'base' => NULL, 'refs' => [ 'StatefulEngineOptions$RuleOrder' => '

Indicates how to manage the order of stateful rule evaluation for the policy. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

Default: DEFAULT_ACTION_ORDER

', ], ], 'SecurityGroupRemediationAction' => [ 'base' => '

Remediation option for the rule specified in the ViolationTarget.

', 'refs' => [ 'SecurityGroupRemediationActions$member' => NULL, ], ], 'SecurityGroupRemediationActions' => [ 'base' => NULL, 'refs' => [ 'AwsVPCSecurityGroupViolation$PossibleSecurityGroupRemediationActions' => '

Remediation options for the rule specified in the ViolationTarget.

', ], ], 'SecurityGroupRuleDescription' => [ 'base' => '

Describes a set of permissions for a security group rule.

', 'refs' => [ 'SecurityGroupRemediationAction$RemediationResult' => '

The final state of the rule specified in the ViolationTarget after it is remediated.

', ], ], 'SecurityServicePolicyData' => [ 'base' => '

Details about the security service that is being used to protect the resources.

', 'refs' => [ 'Policy$SecurityServicePolicyData' => '

Details about the security service that is being used to protect the resources.

', ], ], 'SecurityServiceType' => [ 'base' => NULL, 'refs' => [ 'GetProtectionStatusResponse$ServiceType' => '

The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.

', 'PolicySummary$SecurityServiceType' => '

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.

', 'SecurityServicePolicyData$Type' => '

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting Amazon Web Services Support.

', 'SecurityServiceTypeList$member' => NULL, ], ], 'SecurityServiceTypeList' => [ 'base' => NULL, 'refs' => [ 'PolicyTypeScope$PolicyTypes' => '

The list of policy types that the specified Firewall Manager administrator can manage.

', ], ], 'StatefulEngineOptions' => [ 'base' => '

Configuration settings for the handling of the stateful rule groups in a Network Firewall firewall policy.

', 'refs' => [ 'NetworkFirewallPolicyDescription$StatefulEngineOptions' => '

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

', ], ], 'StatefulRuleGroup' => [ 'base' => '

Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.

', 'refs' => [ 'StatefulRuleGroupList$member' => NULL, ], ], 'StatefulRuleGroupList' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicyDescription$StatefulRuleGroups' => '

The stateful rule groups that are used in the Network Firewall firewall policy.

', ], ], 'StatelessRuleGroup' => [ 'base' => '

Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.

', 'refs' => [ 'StatelessRuleGroupList$member' => NULL, ], ], 'StatelessRuleGroupList' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallPolicyDescription$StatelessRuleGroups' => '

The stateless rule groups that are used in the Network Firewall firewall policy.

', ], ], 'StatelessRuleGroupPriority' => [ 'base' => NULL, 'refs' => [ 'StatelessRuleGroup$Priority' => '

The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

', ], ], 'StreamExceptionPolicy' => [ 'base' => NULL, 'refs' => [ 'StatefulEngineOptions$StreamExceptionPolicy' => '

Indicates how Network Firewall should handle traffic when a network connection breaks midstream.

For more information, see Stream exception policy in your firewall policy in the Network Firewall Developer Guide.

Default: FMS_IGNORE

', ], ], 'Tag' => [ 'base' => '

A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each Amazon Web Services resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], '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' => '

The keys of the tags to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceResponse$TagList' => '

The tags associated with the resource.

', 'PutAppsListRequest$TagList' => '

The tags associated with the resource.

', 'PutPolicyRequest$TagList' => '

The tags to add to the Amazon Web Services resource.

', 'PutProtocolsListRequest$TagList' => '

The tags associated with the resource.

', 'PutResourceSetRequest$TagList' => '

Retrieves the tags associated with the specified resource set. 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.

', 'TagResourceRequest$TagList' => '

The tags to add to the resource.

', 'ViolationDetail$ResourceTags' => '

The ResourceTag objects associated 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.

', ], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Route$TargetType' => '

The type of target for the route.

', ], ], 'TargetViolationReason' => [ 'base' => NULL, 'refs' => [ 'NetworkFirewallMissingFirewallViolation$TargetViolationReason' => '

The reason the resource has this violation, if one is available.

', 'NetworkFirewallMissingSubnetViolation$TargetViolationReason' => '

The reason the resource has this violation, if one is available.

', 'TargetViolationReasons$member' => NULL, 'ThirdPartyFirewallMissingFirewallViolation$TargetViolationReason' => '

The reason the resource is causing this violation, if a reason is available.

', 'ThirdPartyFirewallMissingSubnetViolation$TargetViolationReason' => '

The reason the resource is causing the violation, if a reason is available.

', ], ], 'TargetViolationReasons' => [ 'base' => NULL, 'refs' => [ 'PartialMatch$TargetViolationReasons' => '

The violation reason.

', ], ], 'ThirdPartyFirewall' => [ 'base' => NULL, 'refs' => [ 'AssociateThirdPartyFirewallRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', 'DisassociateThirdPartyFirewallRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', 'GetThirdPartyFirewallAssociationStatusRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', 'ListThirdPartyFirewallFirewallPoliciesRequest$ThirdPartyFirewall' => '

The name of the third-party firewall vendor.

', ], ], 'ThirdPartyFirewallAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'AssociateThirdPartyFirewallResponse$ThirdPartyFirewallStatus' => '

The current status for setting a Firewall Manager policy administrator\'s account as an administrator of the third-party firewall tenant.

', 'DisassociateThirdPartyFirewallResponse$ThirdPartyFirewallStatus' => '

The current status for the disassociation of a Firewall Manager administrators account with a third-party firewall.

', 'GetThirdPartyFirewallAssociationStatusResponse$ThirdPartyFirewallStatus' => '

The current status for setting a Firewall Manager policy administrators account as an administrator of the third-party firewall tenant.

', ], ], 'ThirdPartyFirewallFirewallPolicies' => [ 'base' => NULL, 'refs' => [ 'ListThirdPartyFirewallFirewallPoliciesResponse$ThirdPartyFirewallFirewallPolicies' => '

A list that contains one ThirdPartyFirewallFirewallPolicies element for each third-party firewall policies that the specified third-party firewall vendor is associated with. Each ThirdPartyFirewallFirewallPolicies element contains the firewall policy name and ID.

', ], ], 'ThirdPartyFirewallFirewallPolicy' => [ 'base' => '

Configures the third-party firewall\'s firewall policy.

', 'refs' => [ 'ThirdPartyFirewallFirewallPolicies$member' => NULL, ], ], 'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [ 'base' => '

The violation details for a third-party firewall that\'s not associated with an Firewall Manager managed route table.

', 'refs' => [ 'ResourceViolation$ThirdPartyFirewallMissingExpectedRouteTableViolation' => '

The violation details for a third-party firewall that has the Firewall Manager managed route table that was associated with the third-party firewall has been deleted.

', ], ], 'ThirdPartyFirewallMissingFirewallViolation' => [ 'base' => '

The violation details about a third-party firewall\'s subnet that doesn\'t have a Firewall Manager managed firewall in its VPC.

', 'refs' => [ 'ResourceViolation$ThirdPartyFirewallMissingFirewallViolation' => '

The violation details for a third-party firewall that\'s been deleted.

', ], ], 'ThirdPartyFirewallMissingSubnetViolation' => [ 'base' => '

The violation details for a third-party firewall for an Availability Zone that\'s missing the Firewall Manager managed subnet.

', 'refs' => [ 'ResourceViolation$ThirdPartyFirewallMissingSubnetViolation' => '

The violation details for a third-party firewall\'s subnet that\'s been deleted.

', ], ], 'ThirdPartyFirewallPolicy' => [ 'base' => '

Configures the deployment model for the third-party firewall.

', 'refs' => [ 'PolicyOption$ThirdPartyFirewallPolicy' => '

Defines the policy options for a third-party firewall policy.

', ], ], 'TimeStamp' => [ 'base' => NULL, 'refs' => [ 'AppsListData$CreateTime' => '

The time that the Firewall Manager applications list was created.

', 'AppsListData$LastUpdateTime' => '

The time that the Firewall Manager applications list was last updated.

', 'GetProtectionStatusRequest$StartTime' => '

The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

', 'GetProtectionStatusRequest$EndTime' => '

The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

', 'PolicyComplianceDetail$ExpiredAt' => '

A timestamp that indicates when the returned information should be considered out of date.

', 'PolicyComplianceStatus$LastUpdated' => '

Timestamp of the last update to the EvaluationResult objects.

', 'ProtocolsListData$CreateTime' => '

The time that the Firewall Manager protocols list was created.

', 'ProtocolsListData$LastUpdateTime' => '

The time that the Firewall Manager protocols list was last updated.

', 'ResourceSet$LastUpdateTime' => '

The last time that the resource set was changed.

', 'ResourceSetSummary$LastUpdateTime' => '

The last time that the resource set was changed.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateToken' => [ 'base' => NULL, 'refs' => [ 'AppsListData$ListUpdateToken' => '

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

', 'ProtocolsListData$ListUpdateToken' => '

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

', 'ResourceSet$UpdateToken' => '

An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn\'t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

', ], ], 'ViolationDetail' => [ 'base' => '

Violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

', 'refs' => [ 'GetViolationDetailsResponse$ViolationDetail' => '

Violation detail for a resource.

', ], ], 'ViolationReason' => [ 'base' => NULL, 'refs' => [ 'ComplianceViolator$ViolationReason' => '

The reason that the resource is not protected by the policy.

', ], ], 'ViolationTarget' => [ 'base' => NULL, 'refs' => [ 'AwsEc2InstanceViolation$ViolationTarget' => '

The resource ID of the EC2 instance.

', 'AwsEc2NetworkInterfaceViolation$ViolationTarget' => '

The resource ID of the network interface.

', 'AwsVPCSecurityGroupViolation$ViolationTarget' => '

The security group rule that is being evaluated.

', 'DnsDuplicateRuleGroupViolation$ViolationTarget' => '

Information about the VPC ID.

', 'DnsRuleGroupLimitExceededViolation$ViolationTarget' => '

Information about the VPC ID.

', 'DnsRuleGroupPriorityConflictViolation$ViolationTarget' => '

Information about the VPC ID.

', 'NetworkFirewallBlackHoleRouteDetectedViolation$ViolationTarget' => '

The subnet that has an inactive state.

', 'NetworkFirewallMissingExpectedRTViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'NetworkFirewallMissingExpectedRoutesViolation$ViolationTarget' => '

The target of the violation.

', 'NetworkFirewallMissingFirewallViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'NetworkFirewallMissingSubnetViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'NetworkFirewallPolicyModifiedViolation$ViolationTarget' => '

The ID of the Network Firewall or VPC resource that\'s in violation.

', 'ThirdPartyFirewallMissingExpectedRouteTableViolation$ViolationTarget' => '

The ID of the third-party firewall or VPC resource that\'s causing the violation.

', 'ThirdPartyFirewallMissingFirewallViolation$ViolationTarget' => '

The ID of the third-party firewall that\'s causing the violation.

', 'ThirdPartyFirewallMissingSubnetViolation$ViolationTarget' => '

The ID of the third-party firewall or VPC resource that\'s causing the violation.

', ], ], ],]; diff --git a/src/data/omics/2022-11-28/api-2.json b/src/data/omics/2022-11-28/api-2.json index 2eec3ee697..cedeffac89 100644 --- a/src/data/omics/2022-11-28/api-2.json +++ b/src/data/omics/2022-11-28/api-2.json @@ -2713,7 +2713,8 @@ "type":"structure", "members":{ "resourceArns":{"shape":"ArnList"}, - "status":{"shape":"StatusList"} + "status":{"shape":"StatusList"}, + "type":{"shape":"TypeList"} } }, "FormatOptions":{ @@ -3351,7 +3352,9 @@ "failureReason":{"shape":"RunFailureReason"}, "logLocation":{"shape":"RunLogLocation"}, "uuid":{"shape":"RunUuid"}, - "runOutputUri":{"shape":"RunOutputUri"} + "runOutputUri":{"shape":"RunOutputUri"}, + "storageType":{"shape":"StorageType"}, + "workflowOwnerId":{"shape":"WorkflowOwnerId"} } }, "GetRunResponsePriorityInteger":{ @@ -3563,6 +3566,11 @@ "shape":"WorkflowExportList", "location":"querystring", "locationName":"export" + }, + "workflowOwnerId":{ + "shape":"WorkflowOwnerId", + "location":"querystring", + "locationName":"workflowOwnerId" } } }, @@ -5215,7 +5223,8 @@ "storageCapacity":{"shape":"RunListItemStorageCapacityInteger"}, "creationTime":{"shape":"RunTimestamp"}, "startTime":{"shape":"RunTimestamp"}, - "stopTime":{"shape":"RunTimestamp"} + "stopTime":{"shape":"RunTimestamp"}, + "storageType":{"shape":"StorageType"} } }, "RunListItemPriorityInteger":{ @@ -5482,6 +5491,7 @@ "members":{ "shareId":{"shape":"String"}, "resourceArn":{"shape":"String"}, + "resourceId":{"shape":"String"}, "principalSubscriber":{"shape":"String"}, "ownerId":{"shape":"String"}, "status":{"shape":"ShareStatus"}, @@ -5501,6 +5511,14 @@ "min":1, "pattern":"[a-zA-Z0-9_-]+" }, + "ShareResourceType":{ + "type":"string", + "enum":[ + "VARIANT_STORE", + "ANNOTATION_STORE", + "WORKFLOW" + ] + }, "ShareStatus":{ "type":"string", "enum":[ @@ -5783,7 +5801,9 @@ "shape":"RunRequestId", "idempotencyToken":true }, - "retentionMode":{"shape":"RunRetentionMode"} + "retentionMode":{"shape":"RunRetentionMode"}, + "storageType":{"shape":"StorageType"}, + "workflowOwnerId":{"shape":"WorkflowOwnerId"} } }, "StartRunRequestPriorityInteger":{ @@ -5833,13 +5853,24 @@ }, "StatusList":{ "type":"list", - "member":{"shape":"ShareStatus"} + "member":{"shape":"ShareStatus"}, + "max":10, + "min":1 }, "StatusMessage":{ "type":"string", "max":1000, "min":0 }, + "StorageType":{ + "type":"string", + "enum":[ + "STATIC", + "DYNAMIC" + ], + "max":64, + "min":1 + }, "StoreFormat":{ "type":"string", "enum":[ @@ -6070,6 +6101,12 @@ "max":5000, "min":1 }, + "TypeList":{ + "type":"list", + "member":{"shape":"ShareResourceType"}, + "max":10, + "min":1 + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -6567,6 +6604,10 @@ "min":1, "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" }, + "WorkflowOwnerId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, "WorkflowParameter":{ "type":"structure", "members":{ diff --git a/src/data/omics/2022-11-28/api-2.json.php b/src/data/omics/2022-11-28/api-2.json.php index 5eb800a199..c7ab277c5d 100644 --- a/src/data/omics/2022-11-28/api-2.json.php +++ b/src/data/omics/2022-11-28/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2022-11-28', 'endpointPrefix' => 'omics', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon Omics', 'serviceId' => 'Omics', 'signatureVersion' => 'v4', 'signingName' => 'omics', 'uid' => 'omics-2022-11-28', ], 'operations' => [ 'AbortMultipartReadSetUpload' => [ 'name' => 'AbortMultipartReadSetUpload', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/abort', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AbortMultipartReadSetUploadRequest', ], 'output' => [ 'shape' => 'AbortMultipartReadSetUploadResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'AcceptShare' => [ 'name' => 'AcceptShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/share/{shareId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AcceptShareRequest', ], 'output' => [ 'shape' => 'AcceptShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'BatchDeleteReadSet' => [ 'name' => 'BatchDeleteReadSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/readset/batch/delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchDeleteReadSetRequest', ], 'output' => [ 'shape' => 'BatchDeleteReadSetResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'CancelAnnotationImportJob' => [ 'name' => 'CancelAnnotationImportJob', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/import/annotation/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CancelAnnotationImportRequest', ], 'output' => [ 'shape' => 'CancelAnnotationImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'CancelRun' => [ 'name' => 'CancelRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/run/{id}/cancel', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CancelRunRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'CancelVariantImportJob' => [ 'name' => 'CancelVariantImportJob', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/import/variant/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CancelVariantImportRequest', ], 'output' => [ 'shape' => 'CancelVariantImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'CompleteMultipartReadSetUpload' => [ 'name' => 'CompleteMultipartReadSetUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/complete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CompleteMultipartReadSetUploadRequest', ], 'output' => [ 'shape' => 'CompleteMultipartReadSetUploadResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], 'CreateAnnotationStore' => [ 'name' => 'CreateAnnotationStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAnnotationStoreRequest', ], 'output' => [ 'shape' => 'CreateAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateAnnotationStoreVersion' => [ 'name' => 'CreateAnnotationStoreVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAnnotationStoreVersionRequest', ], 'output' => [ 'shape' => 'CreateAnnotationStoreVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateMultipartReadSetUpload' => [ 'name' => 'CreateMultipartReadSetUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateMultipartReadSetUploadRequest', ], 'output' => [ 'shape' => 'CreateMultipartReadSetUploadResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'CreateReferenceStore' => [ 'name' => 'CreateReferenceStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateReferenceStoreRequest', ], 'output' => [ 'shape' => 'CreateReferenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'CreateRunGroup' => [ 'name' => 'CreateRunGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/runGroup', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateRunGroupRequest', ], 'output' => [ 'shape' => 'CreateRunGroupResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'CreateSequenceStore' => [ 'name' => 'CreateSequenceStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSequenceStoreRequest', ], 'output' => [ 'shape' => 'CreateSequenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'CreateShare' => [ 'name' => 'CreateShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/share', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateShareRequest', ], 'output' => [ 'shape' => 'CreateShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateVariantStore' => [ 'name' => 'CreateVariantStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/variantStore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateVariantStoreRequest', ], 'output' => [ 'shape' => 'CreateVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateWorkflow' => [ 'name' => 'CreateWorkflow', 'http' => [ 'method' => 'POST', 'requestUri' => '/workflow', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateWorkflowRequest', ], 'output' => [ 'shape' => 'CreateWorkflowResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'DeleteAnnotationStore' => [ 'name' => 'DeleteAnnotationStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/annotationStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAnnotationStoreRequest', ], 'output' => [ 'shape' => 'DeleteAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteAnnotationStoreVersions' => [ 'name' => 'DeleteAnnotationStoreVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/versions/delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAnnotationStoreVersionsRequest', ], 'output' => [ 'shape' => 'DeleteAnnotationStoreVersionsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteReference' => [ 'name' => 'DeleteReference', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/referencestore/{referenceStoreId}/reference/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteReferenceRequest', ], 'output' => [ 'shape' => 'DeleteReferenceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'DeleteReferenceStore' => [ 'name' => 'DeleteReferenceStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/referencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteReferenceStoreRequest', ], 'output' => [ 'shape' => 'DeleteReferenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'DeleteRun' => [ 'name' => 'DeleteRun', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/run/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteRunRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], 'idempotent' => true, ], 'DeleteRunGroup' => [ 'name' => 'DeleteRunGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/runGroup/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteRunGroupRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], 'idempotent' => true, ], 'DeleteSequenceStore' => [ 'name' => 'DeleteSequenceStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sequencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteSequenceStoreRequest', ], 'output' => [ 'shape' => 'DeleteSequenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'DeleteShare' => [ 'name' => 'DeleteShare', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/share/{shareId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteShareRequest', ], 'output' => [ 'shape' => 'DeleteShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteVariantStore' => [ 'name' => 'DeleteVariantStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/variantStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteVariantStoreRequest', ], 'output' => [ 'shape' => 'DeleteVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteWorkflow' => [ 'name' => 'DeleteWorkflow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/workflow/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteWorkflowRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], 'idempotent' => true, ], 'GetAnnotationImportJob' => [ 'name' => 'GetAnnotationImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/import/annotation/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAnnotationImportRequest', ], 'output' => [ 'shape' => 'GetAnnotationImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetAnnotationStore' => [ 'name' => 'GetAnnotationStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/annotationStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAnnotationStoreRequest', ], 'output' => [ 'shape' => 'GetAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetAnnotationStoreVersion' => [ 'name' => 'GetAnnotationStoreVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/annotationStore/{name}/version/{versionName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAnnotationStoreVersionRequest', ], 'output' => [ 'shape' => 'GetAnnotationStoreVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetReadSet' => [ 'name' => 'GetReadSet', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/readset/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetRequest', ], 'output' => [ 'shape' => 'GetReadSetResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'RangeNotSatisfiableException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], 'GetReadSetActivationJob' => [ 'name' => 'GetReadSetActivationJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/activationjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetActivationJobRequest', ], 'output' => [ 'shape' => 'GetReadSetActivationJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReadSetExportJob' => [ 'name' => 'GetReadSetExportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/exportjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetExportJobRequest', ], 'output' => [ 'shape' => 'GetReadSetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReadSetImportJob' => [ 'name' => 'GetReadSetImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/importjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetImportJobRequest', ], 'output' => [ 'shape' => 'GetReadSetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReadSetMetadata' => [ 'name' => 'GetReadSetMetadata', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/readset/{id}/metadata', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetMetadataRequest', ], 'output' => [ 'shape' => 'GetReadSetMetadataResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReference' => [ 'name' => 'GetReference', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{referenceStoreId}/reference/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceRequest', ], 'output' => [ 'shape' => 'GetReferenceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'RangeNotSatisfiableException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], 'GetReferenceImportJob' => [ 'name' => 'GetReferenceImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{referenceStoreId}/importjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceImportJobRequest', ], 'output' => [ 'shape' => 'GetReferenceImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReferenceMetadata' => [ 'name' => 'GetReferenceMetadata', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{referenceStoreId}/reference/{id}/metadata', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceMetadataRequest', ], 'output' => [ 'shape' => 'GetReferenceMetadataResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReferenceStore' => [ 'name' => 'GetReferenceStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceStoreRequest', ], 'output' => [ 'shape' => 'GetReferenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetRun' => [ 'name' => 'GetRun', 'http' => [ 'method' => 'GET', 'requestUri' => '/run/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRunRequest', ], 'output' => [ 'shape' => 'GetRunResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'GetRunGroup' => [ 'name' => 'GetRunGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/runGroup/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRunGroupRequest', ], 'output' => [ 'shape' => 'GetRunGroupResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'GetRunTask' => [ 'name' => 'GetRunTask', 'http' => [ 'method' => 'GET', 'requestUri' => '/run/{id}/task/{taskId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRunTaskRequest', ], 'output' => [ 'shape' => 'GetRunTaskResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'GetSequenceStore' => [ 'name' => 'GetSequenceStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSequenceStoreRequest', ], 'output' => [ 'shape' => 'GetSequenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetShare' => [ 'name' => 'GetShare', 'http' => [ 'method' => 'GET', 'requestUri' => '/share/{shareId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetShareRequest', ], 'output' => [ 'shape' => 'GetShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetVariantImportJob' => [ 'name' => 'GetVariantImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/import/variant/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVariantImportRequest', ], 'output' => [ 'shape' => 'GetVariantImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetVariantStore' => [ 'name' => 'GetVariantStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/variantStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVariantStoreRequest', ], 'output' => [ 'shape' => 'GetVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetWorkflow' => [ 'name' => 'GetWorkflow', 'http' => [ 'method' => 'GET', 'requestUri' => '/workflow/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWorkflowRequest', ], 'output' => [ 'shape' => 'GetWorkflowResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListAnnotationImportJobs' => [ 'name' => 'ListAnnotationImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/annotations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAnnotationImportJobsRequest', ], 'output' => [ 'shape' => 'ListAnnotationImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListAnnotationStoreVersions' => [ 'name' => 'ListAnnotationStoreVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAnnotationStoreVersionsRequest', ], 'output' => [ 'shape' => 'ListAnnotationStoreVersionsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListAnnotationStores' => [ 'name' => 'ListAnnotationStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAnnotationStoresRequest', ], 'output' => [ 'shape' => 'ListAnnotationStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListMultipartReadSetUploads' => [ 'name' => 'ListMultipartReadSetUploads', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/uploads', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListMultipartReadSetUploadsRequest', ], 'output' => [ 'shape' => 'ListMultipartReadSetUploadsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetActivationJobs' => [ 'name' => 'ListReadSetActivationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/activationjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetActivationJobsRequest', ], 'output' => [ 'shape' => 'ListReadSetActivationJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetExportJobs' => [ 'name' => 'ListReadSetExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/exportjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetExportJobsRequest', ], 'output' => [ 'shape' => 'ListReadSetExportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetImportJobs' => [ 'name' => 'ListReadSetImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/importjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetImportJobsRequest', ], 'output' => [ 'shape' => 'ListReadSetImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetUploadParts' => [ 'name' => 'ListReadSetUploadParts', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/parts', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetUploadPartsRequest', ], 'output' => [ 'shape' => 'ListReadSetUploadPartsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSets' => [ 'name' => 'ListReadSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/readsets', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetsRequest', ], 'output' => [ 'shape' => 'ListReadSetsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReferenceImportJobs' => [ 'name' => 'ListReferenceImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore/{referenceStoreId}/importjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReferenceImportJobsRequest', ], 'output' => [ 'shape' => 'ListReferenceImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReferenceStores' => [ 'name' => 'ListReferenceStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReferenceStoresRequest', ], 'output' => [ 'shape' => 'ListReferenceStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReferences' => [ 'name' => 'ListReferences', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore/{referenceStoreId}/references', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReferencesRequest', ], 'output' => [ 'shape' => 'ListReferencesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListRunGroups' => [ 'name' => 'ListRunGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/runGroup', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRunGroupsRequest', ], 'output' => [ 'shape' => 'ListRunGroupsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListRunTasks' => [ 'name' => 'ListRunTasks', 'http' => [ 'method' => 'GET', 'requestUri' => '/run/{id}/task', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRunTasksRequest', ], 'output' => [ 'shape' => 'ListRunTasksResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListRuns' => [ 'name' => 'ListRuns', 'http' => [ 'method' => 'GET', 'requestUri' => '/run', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRunsRequest', ], 'output' => [ 'shape' => 'ListRunsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListSequenceStores' => [ 'name' => 'ListSequenceStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSequenceStoresRequest', ], 'output' => [ 'shape' => 'ListSequenceStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListShares' => [ 'name' => 'ListShares', 'http' => [ 'method' => 'POST', 'requestUri' => '/shares', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSharesRequest', ], 'output' => [ 'shape' => 'ListSharesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'tags-', ], ], 'ListVariantImportJobs' => [ 'name' => 'ListVariantImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/variants', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVariantImportJobsRequest', ], 'output' => [ 'shape' => 'ListVariantImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListVariantStores' => [ 'name' => 'ListVariantStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/variantStores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVariantStoresRequest', ], 'output' => [ 'shape' => 'ListVariantStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListWorkflows' => [ 'name' => 'ListWorkflows', 'http' => [ 'method' => 'GET', 'requestUri' => '/workflow', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWorkflowsRequest', ], 'output' => [ 'shape' => 'ListWorkflowsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'StartAnnotationImportJob' => [ 'name' => 'StartAnnotationImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/annotation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartAnnotationImportRequest', ], 'output' => [ 'shape' => 'StartAnnotationImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'StartReadSetActivationJob' => [ 'name' => 'StartReadSetActivationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/activationjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReadSetActivationJobRequest', ], 'output' => [ 'shape' => 'StartReadSetActivationJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartReadSetExportJob' => [ 'name' => 'StartReadSetExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/exportjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReadSetExportJobRequest', ], 'output' => [ 'shape' => 'StartReadSetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartReadSetImportJob' => [ 'name' => 'StartReadSetImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/importjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReadSetImportJobRequest', ], 'output' => [ 'shape' => 'StartReadSetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartReferenceImportJob' => [ 'name' => 'StartReferenceImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore/{referenceStoreId}/importjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReferenceImportJobRequest', ], 'output' => [ 'shape' => 'StartReferenceImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartRun' => [ 'name' => 'StartRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/run', 'responseCode' => 201, ], 'input' => [ 'shape' => 'StartRunRequest', ], 'output' => [ 'shape' => 'StartRunResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'StartVariantImportJob' => [ 'name' => 'StartVariantImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/variant', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartVariantImportRequest', ], 'output' => [ 'shape' => 'StartVariantImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'tags-', ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'tags-', ], 'idempotent' => true, ], 'UpdateAnnotationStore' => [ 'name' => 'UpdateAnnotationStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAnnotationStoreRequest', ], 'output' => [ 'shape' => 'UpdateAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'UpdateAnnotationStoreVersion' => [ 'name' => 'UpdateAnnotationStoreVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/version/{versionName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAnnotationStoreVersionRequest', ], 'output' => [ 'shape' => 'UpdateAnnotationStoreVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'UpdateRunGroup' => [ 'name' => 'UpdateRunGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/runGroup/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateRunGroupRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'UpdateVariantStore' => [ 'name' => 'UpdateVariantStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/variantStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVariantStoreRequest', ], 'output' => [ 'shape' => 'UpdateVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'UpdateWorkflow' => [ 'name' => 'UpdateWorkflow', 'http' => [ 'method' => 'POST', 'requestUri' => '/workflow/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateWorkflowRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'UploadReadSetPart' => [ 'name' => 'UploadReadSetPart', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/part', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UploadReadSetPartRequest', ], 'output' => [ 'shape' => 'UploadReadSetPartResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'authtype' => 'v4-unsigned-body', 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], ], 'shapes' => [ 'AbortMultipartReadSetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], ], ], 'AbortMultipartReadSetUploadResponse' => [ 'type' => 'structure', 'members' => [], ], 'Accelerators' => [ 'type' => 'string', 'enum' => [ 'GPU', ], 'max' => 64, 'min' => 1, ], 'AcceptShareRequest' => [ 'type' => 'structure', 'required' => [ 'shareId', ], 'members' => [ 'shareId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'shareId', ], ], ], 'AcceptShareResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ShareStatus', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActivateReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ActivateReadSetJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ActivateReadSetJobList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActivateReadSetJobItem', ], ], 'ActivateReadSetSourceItem' => [ 'type' => 'structure', 'required' => [ 'readSetId', 'status', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], 'status' => [ 'shape' => 'ReadSetActivationJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], ], ], 'ActivateReadSetSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActivateReadSetSourceItem', ], ], 'ActivationJobId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'AnnotationFieldMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'AnnotationFieldMapKeyString', ], 'value' => [ 'shape' => 'AnnotationFieldMapValueString', ], ], 'AnnotationFieldMapKeyString' => [ 'type' => 'string', 'max' => 21, 'min' => 1, ], 'AnnotationFieldMapValueString' => [ 'type' => 'string', 'max' => 21, 'min' => 1, ], 'AnnotationImportItemDetail' => [ 'type' => 'structure', 'required' => [ 'source', 'jobStatus', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], 'jobStatus' => [ 'shape' => 'JobStatus', ], ], ], 'AnnotationImportItemDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationImportItemDetail', ], 'max' => 1, 'min' => 1, ], 'AnnotationImportItemSource' => [ 'type' => 'structure', 'required' => [ 'source', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], ], ], 'AnnotationImportItemSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationImportItemSource', ], 'min' => 1, ], 'AnnotationImportJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'versionName', 'roleArn', 'status', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'destinationName' => [ 'shape' => 'String', ], 'versionName' => [ 'shape' => 'VersionName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'AnnotationImportJobItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationImportJobItem', ], ], 'AnnotationStoreItem' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'storeFormat', 'description', 'sseConfig', 'creationTime', 'updateTime', 'statusMessage', 'storeSizeBytes', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], ], ], 'AnnotationStoreItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationStoreItem', ], ], 'AnnotationStoreVersionItem' => [ 'type' => 'structure', 'required' => [ 'storeId', 'id', 'status', 'versionArn', 'name', 'versionName', 'description', 'creationTime', 'updateTime', 'statusMessage', 'versionSizeBytes', ], 'members' => [ 'storeId' => [ 'shape' => 'ResourceId', ], 'id' => [ 'shape' => 'ResourceId', ], 'status' => [ 'shape' => 'VersionStatus', ], 'versionArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'versionSizeBytes' => [ 'shape' => 'Long', ], ], ], 'AnnotationStoreVersionItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationStoreVersionItem', ], ], 'AnnotationType' => [ 'type' => 'string', 'enum' => [ 'GENERIC', 'CHR_POS', 'CHR_POS_REF_ALT', 'CHR_START_END_ONE_BASE', 'CHR_START_END_REF_ALT_ONE_BASE', 'CHR_START_END_ZERO_BASE', 'CHR_START_END_REF_ALT_ZERO_BASE', ], ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 10, 'min' => 1, ], 'BatchDeleteReadSetRequest' => [ 'type' => 'structure', 'required' => [ 'ids', 'sequenceStoreId', ], 'members' => [ 'ids' => [ 'shape' => 'ReadSetIdList', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'BatchDeleteReadSetResponse' => [ 'type' => 'structure', 'members' => [ 'errors' => [ 'shape' => 'ReadSetBatchErrorList', ], ], ], 'Blob' => [ 'type' => 'blob', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'CancelAnnotationImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'CancelAnnotationImportResponse' => [ 'type' => 'structure', 'members' => [], ], 'CancelRunRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'CancelVariantImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'CancelVariantImportResponse' => [ 'type' => 'structure', 'members' => [], ], 'ClientToken' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'CommentChar' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'CompleteMultipartReadSetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'parts', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], 'parts' => [ 'shape' => 'CompleteReadSetUploadPartList', ], ], ], 'CompleteMultipartReadSetUploadResponse' => [ 'type' => 'structure', 'required' => [ 'readSetId', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], ], ], 'CompleteReadSetUploadPartList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompleteReadSetUploadPartListItem', ], ], 'CompleteReadSetUploadPartListItem' => [ 'type' => 'structure', 'required' => [ 'partNumber', 'partSource', 'checksum', ], 'members' => [ 'partNumber' => [ 'shape' => 'CompleteReadSetUploadPartListItemPartNumberInteger', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', ], 'checksum' => [ 'shape' => 'CompleteReadSetUploadPartListItemChecksumString', ], ], ], 'CompleteReadSetUploadPartListItemChecksumString' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'CompleteReadSetUploadPartListItemPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'CompletionTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'CreateAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'storeFormat', ], 'members' => [ 'reference' => [ 'shape' => 'ReferenceItem', ], 'name' => [ 'shape' => 'StoreName', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'TagMap', ], 'versionName' => [ 'shape' => 'VersionName', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], ], ], 'CreateAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'status', 'name', 'versionName', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'versionName' => [ 'shape' => 'VersionName', ], 'creationTime' => [ 'shape' => 'CreationTime', ], ], ], 'CreateAnnotationStoreVersionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versionName', ], 'members' => [ 'name' => [ 'shape' => 'StoreName', 'location' => 'uri', 'locationName' => 'name', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'versionOptions' => [ 'shape' => 'VersionOptions', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateAnnotationStoreVersionResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'versionName', 'storeId', 'name', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'versionName' => [ 'shape' => 'VersionName', ], 'storeId' => [ 'shape' => 'ResourceId', ], 'versionOptions' => [ 'shape' => 'VersionOptions', ], 'name' => [ 'shape' => 'StoreName', ], 'status' => [ 'shape' => 'VersionStatus', ], 'creationTime' => [ 'shape' => 'CreationTime', ], ], ], 'CreateMultipartReadSetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'sourceFileType', 'subjectId', 'sampleId', 'name', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateMultipartReadSetUploadResponse' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'sourceFileType', 'subjectId', 'sampleId', 'referenceArn', 'creationTime', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'CreateReferenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'tags' => [ 'shape' => 'TagMap', ], 'clientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreateReferenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', ], 'arn' => [ 'shape' => 'ReferenceStoreArn', ], 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'CreateRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'requestId', ], 'members' => [ 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'CreateRunGroupRequestMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'CreateRunGroupRequestMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'CreateRunGroupRequestMaxDurationInteger', ], 'tags' => [ 'shape' => 'TagMap', ], 'requestId' => [ 'shape' => 'RunGroupRequestId', 'idempotencyToken' => true, ], 'maxGpus' => [ 'shape' => 'CreateRunGroupRequestMaxGpusInteger', ], ], ], 'CreateRunGroupRequestMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupRequestMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupRequestMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupRequestMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunGroupArn', ], 'id' => [ 'shape' => 'RunGroupId', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateSequenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'tags' => [ 'shape' => 'TagMap', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'CreateSequenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', ], 'arn' => [ 'shape' => 'SequenceStoreArn', ], 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'CreateShareRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'principalSubscriber', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'principalSubscriber' => [ 'shape' => 'String', ], 'shareName' => [ 'shape' => 'ShareName', ], ], ], 'CreateShareResponse' => [ 'type' => 'structure', 'members' => [ 'shareId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'ShareStatus', ], 'shareName' => [ 'shape' => 'ShareName', ], ], ], 'CreateVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'reference', ], 'members' => [ 'reference' => [ 'shape' => 'ReferenceItem', ], 'name' => [ 'shape' => 'StoreName', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'TagMap', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], ], ], 'CreateVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'status', 'name', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'creationTime' => [ 'shape' => 'CreationTime', ], ], ], 'CreateWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'requestId', ], 'members' => [ 'name' => [ 'shape' => 'WorkflowName', ], 'description' => [ 'shape' => 'WorkflowDescription', ], 'engine' => [ 'shape' => 'WorkflowEngine', ], 'definitionZip' => [ 'shape' => 'Blob', ], 'definitionUri' => [ 'shape' => 'WorkflowDefinition', ], 'main' => [ 'shape' => 'WorkflowMain', ], 'parameterTemplate' => [ 'shape' => 'WorkflowParameterTemplate', ], 'storageCapacity' => [ 'shape' => 'CreateWorkflowRequestStorageCapacityInteger', ], 'tags' => [ 'shape' => 'TagMap', ], 'requestId' => [ 'shape' => 'WorkflowRequestId', 'idempotencyToken' => true, ], 'accelerators' => [ 'shape' => 'Accelerators', ], ], ], 'CreateWorkflowRequestStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'CreateWorkflowResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'WorkflowArn', ], 'id' => [ 'shape' => 'WorkflowId', ], 'status' => [ 'shape' => 'WorkflowStatus', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'CreationType' => [ 'type' => 'string', 'enum' => [ 'IMPORT', 'UPLOAD', ], ], 'DeleteAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'force' => [ 'shape' => 'PrimitiveBoolean', 'location' => 'querystring', 'locationName' => 'force', ], ], ], 'DeleteAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'DeleteAnnotationStoreVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versions', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'versions' => [ 'shape' => 'VersionList', ], 'force' => [ 'shape' => 'PrimitiveBoolean', 'location' => 'querystring', 'locationName' => 'force', ], ], ], 'DeleteAnnotationStoreVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'errors' => [ 'shape' => 'VersionDeleteErrorList', ], ], ], 'DeleteReferenceRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], ], ], 'DeleteReferenceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteReferenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteReferenceStoreResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunGroupId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteRunRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteSequenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteSequenceStoreResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteShareRequest' => [ 'type' => 'structure', 'required' => [ 'shareId', ], 'members' => [ 'shareId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'shareId', ], ], ], 'DeleteShareResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ShareStatus', ], ], ], 'DeleteVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'force' => [ 'shape' => 'PrimitiveBoolean', 'location' => 'querystring', 'locationName' => 'force', ], ], ], 'DeleteVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'DeleteWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'WorkflowId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'ETag' => [ 'type' => 'structure', 'members' => [ 'algorithm' => [ 'shape' => 'ETagAlgorithm', ], 'source1' => [ 'shape' => 'String', ], 'source2' => [ 'shape' => 'String', ], ], ], 'ETagAlgorithm' => [ 'type' => 'string', 'enum' => [ 'FASTQ_MD5up', 'BAM_MD5up', 'CRAM_MD5up', 'FASTQ_SHA256up', 'BAM_SHA256up', 'CRAM_SHA256up', 'FASTQ_SHA512up', 'BAM_SHA512up', 'CRAM_SHA512up', ], ], 'ETagAlgorithmFamily' => [ 'type' => 'string', 'enum' => [ 'MD5up', 'SHA256up', 'SHA512up', ], ], 'Encoding' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'EncryptionType' => [ 'type' => 'string', 'enum' => [ 'KMS', ], ], 'EngineLogStream' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'EscapeChar' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'EscapeQuotes' => [ 'type' => 'boolean', ], 'ExportJobId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ExportReadSet' => [ 'type' => 'structure', 'required' => [ 'readSetId', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], ], ], 'ExportReadSetDetail' => [ 'type' => 'structure', 'required' => [ 'id', 'status', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'status' => [ 'shape' => 'ReadSetExportJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], ], ], 'ExportReadSetDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportReadSetDetail', ], ], 'ExportReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ExportReadSetJobDetail' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'destination', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ExportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ExportReadSetJobDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportReadSetJobDetail', ], ], 'FileInformation' => [ 'type' => 'structure', 'members' => [ 'totalParts' => [ 'shape' => 'FileInformationTotalPartsInteger', ], 'partSize' => [ 'shape' => 'FileInformationPartSizeLong', ], 'contentLength' => [ 'shape' => 'FileInformationContentLengthLong', ], 's3Access' => [ 'shape' => 'ReadSetS3Access', ], ], ], 'FileInformationContentLengthLong' => [ 'type' => 'long', 'box' => true, 'max' => 5497558138880, 'min' => 1, ], 'FileInformationPartSizeLong' => [ 'type' => 'long', 'box' => true, 'max' => 5368709120, 'min' => 1, ], 'FileInformationTotalPartsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'FileType' => [ 'type' => 'string', 'enum' => [ 'FASTQ', 'BAM', 'CRAM', 'UBAM', ], ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'resourceArns' => [ 'shape' => 'ArnList', ], 'status' => [ 'shape' => 'StatusList', ], ], ], 'FormatOptions' => [ 'type' => 'structure', 'members' => [ 'tsvOptions' => [ 'shape' => 'TsvOptions', ], 'vcfOptions' => [ 'shape' => 'VcfOptions', ], ], 'union' => true, ], 'FormatToHeader' => [ 'type' => 'map', 'key' => [ 'shape' => 'FormatToHeaderKey', ], 'value' => [ 'shape' => 'FormatToHeaderValueString', ], ], 'FormatToHeaderKey' => [ 'type' => 'string', 'enum' => [ 'CHR', 'START', 'END', 'REF', 'ALT', 'POS', ], ], 'FormatToHeaderValueString' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'GeneratedFrom' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'GetAnnotationImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'GetAnnotationImportResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'versionName', 'roleArn', 'status', 'statusMessage', 'creationTime', 'updateTime', 'completionTime', 'items', 'runLeftNormalization', 'formatOptions', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'destinationName' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMsg', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'items' => [ 'shape' => 'AnnotationImportItemDetails', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'formatOptions' => [ 'shape' => 'FormatOptions', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'GetAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], ], ], 'GetAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'description', 'sseConfig', 'creationTime', 'updateTime', 'tags', 'statusMessage', 'storeSizeBytes', 'numVersions', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'tags' => [ 'shape' => 'TagMap', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], 'numVersions' => [ 'shape' => 'Integer', ], ], ], 'GetAnnotationStoreVersionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versionName', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'versionName' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'versionName', ], ], ], 'GetAnnotationStoreVersionResponse' => [ 'type' => 'structure', 'required' => [ 'storeId', 'id', 'status', 'versionArn', 'name', 'versionName', 'description', 'creationTime', 'updateTime', 'tags', 'statusMessage', 'versionSizeBytes', ], 'members' => [ 'storeId' => [ 'shape' => 'ResourceId', ], 'id' => [ 'shape' => 'ResourceId', ], 'status' => [ 'shape' => 'VersionStatus', ], 'versionArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'tags' => [ 'shape' => 'TagMap', ], 'versionOptions' => [ 'shape' => 'VersionOptions', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'versionSizeBytes' => [ 'shape' => 'Long', ], ], ], 'GetReadSetActivationJobRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'GetReadSetActivationJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sources' => [ 'shape' => 'ActivateReadSetSourceList', ], ], ], 'GetReadSetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'id', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'id' => [ 'shape' => 'ExportJobId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetReadSetExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'destination', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ExportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'readSets' => [ 'shape' => 'ExportReadSetDetailList', ], ], ], 'GetReadSetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'GetReadSetImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'roleArn', 'status', 'creationTime', 'sources', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sources' => [ 'shape' => 'ImportReadSetSourceList', ], ], ], 'GetReadSetMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'GetReadSetMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'sequenceStoreId', 'status', 'fileType', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'arn' => [ 'shape' => 'ReadSetArn', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'status' => [ 'shape' => 'ReadSetStatus', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'fileType' => [ 'shape' => 'FileType', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sequenceInformation' => [ 'shape' => 'SequenceInformation', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'files' => [ 'shape' => 'ReadSetFiles', ], 'statusMessage' => [ 'shape' => 'ReadSetStatusMessage', ], 'creationType' => [ 'shape' => 'CreationType', ], 'etag' => [ 'shape' => 'ETag', ], ], ], 'GetReadSetRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'partNumber', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'file' => [ 'shape' => 'ReadSetFile', 'location' => 'querystring', 'locationName' => 'file', ], 'partNumber' => [ 'shape' => 'GetReadSetRequestPartNumberInteger', 'location' => 'querystring', 'locationName' => 'partNumber', ], ], ], 'GetReadSetRequestPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'GetReadSetResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'ReadSetStreamingBlob', ], ], 'payload' => 'payload', ], 'GetReferenceImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], ], ], 'GetReferenceImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'roleArn', 'status', 'creationTime', 'sources', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sources' => [ 'shape' => 'ImportReferenceSourceList', ], ], ], 'GetReferenceMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], ], ], 'GetReferenceMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'referenceStoreId', 'md5', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', ], 'arn' => [ 'shape' => 'ReferenceArn', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'md5' => [ 'shape' => 'Md5', ], 'status' => [ 'shape' => 'ReferenceStatus', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'updateTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'files' => [ 'shape' => 'ReferenceFiles', ], ], ], 'GetReferenceRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'partNumber', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'range' => [ 'shape' => 'Range', 'location' => 'header', 'locationName' => 'Range', ], 'partNumber' => [ 'shape' => 'GetReferenceRequestPartNumberInteger', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'file' => [ 'shape' => 'ReferenceFile', 'location' => 'querystring', 'locationName' => 'file', ], ], ], 'GetReferenceRequestPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'GetReferenceResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'ReferenceStreamingBlob', ], ], 'payload' => 'payload', ], 'GetReferenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetReferenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', ], 'arn' => [ 'shape' => 'ReferenceStoreArn', ], 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'GetRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunGroupId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetRunGroupResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunGroupArn', ], 'id' => [ 'shape' => 'RunGroupId', ], 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'GetRunGroupResponseMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'GetRunGroupResponseMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'GetRunGroupResponseMaxDurationInteger', ], 'creationTime' => [ 'shape' => 'RunGroupTimestamp', ], 'tags' => [ 'shape' => 'TagMap', ], 'maxGpus' => [ 'shape' => 'GetRunGroupResponseMaxGpusInteger', ], ], ], 'GetRunGroupResponseMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunGroupResponseMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunGroupResponseMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunGroupResponseMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], 'export' => [ 'shape' => 'RunExportList', 'location' => 'querystring', 'locationName' => 'export', ], ], ], 'GetRunResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunArn', ], 'id' => [ 'shape' => 'RunId', ], 'status' => [ 'shape' => 'RunStatus', ], 'workflowId' => [ 'shape' => 'WorkflowId', ], 'workflowType' => [ 'shape' => 'WorkflowType', ], 'runId' => [ 'shape' => 'RunId', ], 'roleArn' => [ 'shape' => 'RunRoleArn', ], 'name' => [ 'shape' => 'RunName', ], 'runGroupId' => [ 'shape' => 'RunGroupId', ], 'priority' => [ 'shape' => 'GetRunResponsePriorityInteger', ], 'definition' => [ 'shape' => 'WorkflowDefinition', ], 'digest' => [ 'shape' => 'WorkflowDigest', ], 'parameters' => [ 'shape' => 'RunParameters', ], 'storageCapacity' => [ 'shape' => 'GetRunResponseStorageCapacityInteger', ], 'outputUri' => [ 'shape' => 'RunOutputUri', ], 'logLevel' => [ 'shape' => 'RunLogLevel', ], 'resourceDigests' => [ 'shape' => 'RunResourceDigests', ], 'startedBy' => [ 'shape' => 'RunStartedBy', ], 'creationTime' => [ 'shape' => 'RunTimestamp', ], 'startTime' => [ 'shape' => 'RunTimestamp', ], 'stopTime' => [ 'shape' => 'RunTimestamp', ], 'statusMessage' => [ 'shape' => 'RunStatusMessage', ], 'tags' => [ 'shape' => 'TagMap', ], 'accelerators' => [ 'shape' => 'Accelerators', ], 'retentionMode' => [ 'shape' => 'RunRetentionMode', ], 'failureReason' => [ 'shape' => 'RunFailureReason', ], 'logLocation' => [ 'shape' => 'RunLogLocation', ], 'uuid' => [ 'shape' => 'RunUuid', ], 'runOutputUri' => [ 'shape' => 'RunOutputUri', ], ], ], 'GetRunResponsePriorityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'GetRunResponseStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'GetRunTaskRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'taskId', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], 'taskId' => [ 'shape' => 'TaskId', 'location' => 'uri', 'locationName' => 'taskId', ], ], ], 'GetRunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'taskId' => [ 'shape' => 'TaskId', ], 'status' => [ 'shape' => 'TaskStatus', ], 'name' => [ 'shape' => 'TaskName', ], 'cpus' => [ 'shape' => 'GetRunTaskResponseCpusInteger', ], 'memory' => [ 'shape' => 'GetRunTaskResponseMemoryInteger', ], 'creationTime' => [ 'shape' => 'TaskTimestamp', ], 'startTime' => [ 'shape' => 'TaskTimestamp', ], 'stopTime' => [ 'shape' => 'TaskTimestamp', ], 'statusMessage' => [ 'shape' => 'TaskStatusMessage', ], 'logStream' => [ 'shape' => 'TaskLogStream', ], 'gpus' => [ 'shape' => 'GetRunTaskResponseGpusInteger', ], 'instanceType' => [ 'shape' => 'TaskInstanceType', ], 'failureReason' => [ 'shape' => 'TaskFailureReason', ], ], ], 'GetRunTaskResponseCpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'GetRunTaskResponseGpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'GetRunTaskResponseMemoryInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'GetSequenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetSequenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', ], 'arn' => [ 'shape' => 'SequenceStoreArn', ], 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 's3Access' => [ 'shape' => 'SequenceStoreS3Access', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'GetShareRequest' => [ 'type' => 'structure', 'required' => [ 'shareId', ], 'members' => [ 'shareId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'shareId', ], ], ], 'GetShareResponse' => [ 'type' => 'structure', 'members' => [ 'share' => [ 'shape' => 'ShareDetails', ], ], ], 'GetVariantImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'GetVariantImportResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'roleArn', 'status', 'statusMessage', 'creationTime', 'updateTime', 'items', 'runLeftNormalization', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'destinationName' => [ 'shape' => 'StoreName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMsg', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'items' => [ 'shape' => 'VariantImportItemDetails', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'GetVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], ], ], 'GetVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'description', 'sseConfig', 'creationTime', 'updateTime', 'tags', 'statusMessage', 'storeSizeBytes', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'tags' => [ 'shape' => 'TagMap', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], ], ], 'GetWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'WorkflowId', 'location' => 'uri', 'locationName' => 'id', ], 'type' => [ 'shape' => 'WorkflowType', 'location' => 'querystring', 'locationName' => 'type', ], 'export' => [ 'shape' => 'WorkflowExportList', 'location' => 'querystring', 'locationName' => 'export', ], ], ], 'GetWorkflowResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'WorkflowArn', ], 'id' => [ 'shape' => 'WorkflowId', ], 'status' => [ 'shape' => 'WorkflowStatus', ], 'type' => [ 'shape' => 'WorkflowType', ], 'name' => [ 'shape' => 'WorkflowName', ], 'description' => [ 'shape' => 'WorkflowDescription', ], 'engine' => [ 'shape' => 'WorkflowEngine', ], 'definition' => [ 'shape' => 'WorkflowDefinition', ], 'main' => [ 'shape' => 'WorkflowMain', ], 'digest' => [ 'shape' => 'WorkflowDigest', ], 'parameterTemplate' => [ 'shape' => 'WorkflowParameterTemplate', ], 'storageCapacity' => [ 'shape' => 'GetWorkflowResponseStorageCapacityInteger', ], 'creationTime' => [ 'shape' => 'WorkflowTimestamp', ], 'statusMessage' => [ 'shape' => 'WorkflowStatusMessage', ], 'tags' => [ 'shape' => 'TagMap', ], 'metadata' => [ 'shape' => 'WorkflowMetadata', ], 'accelerators' => [ 'shape' => 'Accelerators', ], ], ], 'GetWorkflowResponseStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'Header' => [ 'type' => 'boolean', ], 'ImportJobId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ImportReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReadSetJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReadSetJobList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReadSetJobItem', ], ], 'ImportReadSetSourceItem' => [ 'type' => 'structure', 'required' => [ 'sourceFiles', 'sourceFileType', 'status', 'subjectId', 'sampleId', ], 'members' => [ 'sourceFiles' => [ 'shape' => 'SourceFiles', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'status' => [ 'shape' => 'ReadSetImportJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ImportReadSetSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReadSetSourceItem', ], ], 'ImportReferenceFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReferenceJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReferenceJobList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReferenceJobItem', ], ], 'ImportReferenceSourceItem' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'sourceFile' => [ 'shape' => 'S3Uri', ], 'status' => [ 'shape' => 'ReferenceImportJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ImportReferenceSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReferenceSourceItem', ], ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'JobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLED', 'COMPLETED', 'FAILED', 'COMPLETED_WITH_FAILURES', ], ], 'JobStatusMessage' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'JobStatusMsg' => [ 'type' => 'string', ], 'LineSep' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'ListAnnotationImportJobsFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'JobStatus', ], 'storeName' => [ 'shape' => 'String', ], ], ], 'ListAnnotationImportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListAnnotationImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ids' => [ 'shape' => 'ListAnnotationImportJobsRequestIdsList', ], 'nextToken' => [ 'shape' => 'ListAnnotationImportJobsRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListAnnotationImportJobsFilter', ], ], ], 'ListAnnotationImportJobsRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListAnnotationImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListAnnotationImportJobsRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListAnnotationImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'annotationImportJobs' => [ 'shape' => 'AnnotationImportJobItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAnnotationStoreVersionsFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'VersionStatus', ], ], ], 'ListAnnotationStoreVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'maxResults' => [ 'shape' => 'ListAnnotationStoreVersionsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'ListAnnotationStoreVersionsRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListAnnotationStoreVersionsFilter', ], ], ], 'ListAnnotationStoreVersionsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListAnnotationStoreVersionsRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListAnnotationStoreVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'annotationStoreVersions' => [ 'shape' => 'AnnotationStoreVersionItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAnnotationStoresFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'ListAnnotationStoresRequest' => [ 'type' => 'structure', 'members' => [ 'ids' => [ 'shape' => 'ListAnnotationStoresRequestIdsList', ], 'maxResults' => [ 'shape' => 'ListAnnotationStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'ListAnnotationStoresRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListAnnotationStoresFilter', ], ], ], 'ListAnnotationStoresRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListAnnotationStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListAnnotationStoresRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListAnnotationStoresResponse' => [ 'type' => 'structure', 'members' => [ 'annotationStores' => [ 'shape' => 'AnnotationStoreItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListMultipartReadSetUploadsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListMultipartReadSetUploadsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListMultipartReadSetUploadsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListMultipartReadSetUploadsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'uploads' => [ 'shape' => 'MultipartReadSetUploadList', ], ], ], 'ListReadSetActivationJobsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReadSetActivationJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ActivateReadSetFilter', ], ], ], 'ListReadSetActivationJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetActivationJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'activationJobs' => [ 'shape' => 'ActivateReadSetJobList', ], ], ], 'ListReadSetExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReadSetExportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ExportReadSetFilter', ], ], ], 'ListReadSetExportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'exportJobs' => [ 'shape' => 'ExportReadSetJobDetailList', ], ], ], 'ListReadSetImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'maxResults' => [ 'shape' => 'ListReadSetImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'filter' => [ 'shape' => 'ImportReadSetFilter', ], ], ], 'ListReadSetImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'importJobs' => [ 'shape' => 'ImportReadSetJobList', ], ], ], 'ListReadSetUploadPartsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'partSource', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', ], 'maxResults' => [ 'shape' => 'ListReadSetUploadPartsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReadSetUploadPartListFilter', ], ], ], 'ListReadSetUploadPartsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetUploadPartsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'parts' => [ 'shape' => 'ReadSetUploadPartList', ], ], ], 'ListReadSetsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReadSetsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReadSetFilter', ], ], ], 'ListReadSetsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetsResponse' => [ 'type' => 'structure', 'required' => [ 'readSets', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'readSets' => [ 'shape' => 'ReadSetList', ], ], ], 'ListReferenceImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'referenceStoreId', ], 'members' => [ 'maxResults' => [ 'shape' => 'ListReferenceImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'filter' => [ 'shape' => 'ImportReferenceFilter', ], ], ], 'ListReferenceImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReferenceImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'importJobs' => [ 'shape' => 'ImportReferenceJobList', ], ], ], 'ListReferenceStoresRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListReferenceStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReferenceStoreFilter', ], ], ], 'ListReferenceStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReferenceStoresResponse' => [ 'type' => 'structure', 'required' => [ 'referenceStores', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'referenceStores' => [ 'shape' => 'ReferenceStoreDetailList', ], ], ], 'ListReferencesRequest' => [ 'type' => 'structure', 'required' => [ 'referenceStoreId', ], 'members' => [ 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReferencesRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReferenceFilter', ], ], ], 'ListReferencesRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReferencesResponse' => [ 'type' => 'structure', 'required' => [ 'references', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'references' => [ 'shape' => 'ReferenceList', ], ], ], 'ListRunGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RunGroupName', 'location' => 'querystring', 'locationName' => 'name', ], 'startingToken' => [ 'shape' => 'RunGroupListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListRunGroupsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRunGroupsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListRunGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'RunGroupList', ], 'nextToken' => [ 'shape' => 'RunGroupListToken', ], ], ], 'ListRunTasksRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], 'status' => [ 'shape' => 'TaskStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'startingToken' => [ 'shape' => 'TaskListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListRunTasksRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRunTasksRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListRunTasksResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'TaskList', ], 'nextToken' => [ 'shape' => 'TaskListToken', ], ], ], 'ListRunsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RunName', 'location' => 'querystring', 'locationName' => 'name', ], 'runGroupId' => [ 'shape' => 'RunGroupId', 'location' => 'querystring', 'locationName' => 'runGroupId', ], 'startingToken' => [ 'shape' => 'RunListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListRunsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'status' => [ 'shape' => 'RunStatus', 'location' => 'querystring', 'locationName' => 'status', ], ], ], 'ListRunsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListRunsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'RunList', ], 'nextToken' => [ 'shape' => 'RunListToken', ], ], ], 'ListSequenceStoresRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListSequenceStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'SequenceStoreFilter', ], ], ], 'ListSequenceStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListSequenceStoresResponse' => [ 'type' => 'structure', 'required' => [ 'sequenceStores', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'sequenceStores' => [ 'shape' => 'SequenceStoreDetailList', ], ], ], 'ListSharesRequest' => [ 'type' => 'structure', 'required' => [ 'resourceOwner', ], 'members' => [ 'resourceOwner' => [ 'shape' => 'ResourceOwner', ], 'filter' => [ 'shape' => 'Filter', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'Integer', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSharesResponse' => [ 'type' => 'structure', 'required' => [ 'shares', ], 'members' => [ 'shares' => [ 'shape' => 'ShareDetailsList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TagArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'required' => [ 'tags', ], 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ListVariantImportJobsFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'JobStatus', ], 'storeName' => [ 'shape' => 'String', ], ], ], 'ListVariantImportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListVariantImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ids' => [ 'shape' => 'ListVariantImportJobsRequestIdsList', ], 'nextToken' => [ 'shape' => 'ListVariantImportJobsRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListVariantImportJobsFilter', ], ], ], 'ListVariantImportJobsRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListVariantImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListVariantImportJobsRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListVariantImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'variantImportJobs' => [ 'shape' => 'VariantImportJobItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListVariantStoresFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'ListVariantStoresRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListVariantStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ids' => [ 'shape' => 'ListVariantStoresRequestIdsList', ], 'nextToken' => [ 'shape' => 'ListVariantStoresRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListVariantStoresFilter', ], ], ], 'ListVariantStoresRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListVariantStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListVariantStoresRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListVariantStoresResponse' => [ 'type' => 'structure', 'members' => [ 'variantStores' => [ 'shape' => 'VariantStoreItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListWorkflowsRequest' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'WorkflowType', 'location' => 'querystring', 'locationName' => 'type', ], 'name' => [ 'shape' => 'WorkflowName', 'location' => 'querystring', 'locationName' => 'name', ], 'startingToken' => [ 'shape' => 'WorkflowListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListWorkflowsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListWorkflowsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListWorkflowsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'WorkflowList', ], 'nextToken' => [ 'shape' => 'WorkflowListToken', ], ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'Md5' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{N}]+', ], 'MultipartReadSetUploadList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MultipartReadSetUploadListItem', ], ], 'MultipartReadSetUploadListItem' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'sourceFileType', 'subjectId', 'sampleId', 'generatedFrom', 'referenceArn', 'creationTime', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 6144, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'NotSupportedOperationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 405, 'senderFault' => true, ], 'exception' => true, ], 'PrimitiveBoolean' => [ 'type' => 'boolean', ], 'Quote' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'QuoteAll' => [ 'type' => 'boolean', ], 'Range' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{N}||\\p{P}]+', ], 'RangeNotSatisfiableException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 416, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => false, ], ], 'ReadOptions' => [ 'type' => 'structure', 'members' => [ 'sep' => [ 'shape' => 'Separator', ], 'encoding' => [ 'shape' => 'Encoding', ], 'quote' => [ 'shape' => 'Quote', ], 'quoteAll' => [ 'shape' => 'QuoteAll', ], 'escape' => [ 'shape' => 'EscapeChar', ], 'escapeQuotes' => [ 'shape' => 'EscapeQuotes', ], 'comment' => [ 'shape' => 'CommentChar', ], 'header' => [ 'shape' => 'Header', ], 'lineSep' => [ 'shape' => 'LineSep', ], ], ], 'ReadSetActivationJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReadSetActivationJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReadSetArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'ReadSetBatchError' => [ 'type' => 'structure', 'required' => [ 'id', 'code', 'message', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'code' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], ], 'ReadSetBatchErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetBatchError', ], ], 'ReadSetDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReadSetExportJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReadSetExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReadSetFile' => [ 'type' => 'string', 'enum' => [ 'SOURCE1', 'SOURCE2', 'INDEX', ], ], 'ReadSetFiles' => [ 'type' => 'structure', 'members' => [ 'source1' => [ 'shape' => 'FileInformation', ], 'source2' => [ 'shape' => 'FileInformation', ], 'index' => [ 'shape' => 'FileInformation', ], ], ], 'ReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ReadSetName', ], 'status' => [ 'shape' => 'ReadSetStatus', ], 'referenceArn' => [ 'shape' => 'ReferenceArnFilter', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'creationType' => [ 'shape' => 'CreationType', ], ], ], 'ReadSetId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ReadSetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetId', ], 'max' => 100, 'min' => 1, ], 'ReadSetImportJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReadSetImportJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReadSetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetListItem', ], ], 'ReadSetListItem' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'sequenceStoreId', 'status', 'fileType', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'arn' => [ 'shape' => 'ReadSetArn', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'status' => [ 'shape' => 'ReadSetStatus', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'fileType' => [ 'shape' => 'FileType', ], 'sequenceInformation' => [ 'shape' => 'SequenceInformation', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'statusMessage' => [ 'shape' => 'ReadSetStatusMessage', ], 'creationType' => [ 'shape' => 'CreationType', ], 'etag' => [ 'shape' => 'ETag', ], ], ], 'ReadSetName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReadSetPartSource' => [ 'type' => 'string', 'enum' => [ 'SOURCE1', 'SOURCE2', ], ], 'ReadSetPartStreamingBlob' => [ 'type' => 'blob', 'requiresLength' => true, 'streaming' => true, ], 'ReadSetS3Access' => [ 'type' => 'structure', 'members' => [ 's3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'ReadSetStatus' => [ 'type' => 'string', 'enum' => [ 'ARCHIVED', 'ACTIVATING', 'ACTIVE', 'DELETING', 'DELETED', 'PROCESSING_UPLOAD', 'UPLOAD_FAILED', ], ], 'ReadSetStatusMessage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReadSetStreamingBlob' => [ 'type' => 'blob', 'streaming' => true, ], 'ReadSetUploadPartList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetUploadPartListItem', ], ], 'ReadSetUploadPartListFilter' => [ 'type' => 'structure', 'members' => [ 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReadSetUploadPartListItem' => [ 'type' => 'structure', 'required' => [ 'partNumber', 'partSize', 'partSource', 'checksum', ], 'members' => [ 'partNumber' => [ 'shape' => 'ReadSetUploadPartListItemPartNumberInteger', ], 'partSize' => [ 'shape' => 'ReadSetUploadPartListItemPartSizeLong', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', ], 'checksum' => [ 'shape' => 'String', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'lastUpdatedTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReadSetUploadPartListItemPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'ReadSetUploadPartListItemPartSizeLong' => [ 'type' => 'long', 'box' => true, 'max' => 5368709120, 'min' => 1, ], 'ReferenceArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'ReferenceArnFilter' => [ 'type' => 'string', 'max' => 127, 'min' => 0, 'pattern' => '$|^arn:.+', ], 'ReferenceDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceFile' => [ 'type' => 'string', 'enum' => [ 'SOURCE', 'INDEX', ], ], 'ReferenceFiles' => [ 'type' => 'structure', 'members' => [ 'source' => [ 'shape' => 'FileInformation', ], 'index' => [ 'shape' => 'FileInformation', ], ], ], 'ReferenceFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ReferenceName', ], 'md5' => [ 'shape' => 'Md5', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ReferenceImportJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReferenceImportJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReferenceItem' => [ 'type' => 'structure', 'members' => [ 'referenceArn' => [ 'shape' => 'ReferenceArn', ], ], 'union' => true, ], 'ReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceListItem', ], ], 'ReferenceListItem' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'referenceStoreId', 'md5', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', ], 'arn' => [ 'shape' => 'ReferenceArn', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'md5' => [ 'shape' => 'Md5', ], 'status' => [ 'shape' => 'ReferenceStatus', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'updateTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETING', 'DELETED', ], ], 'ReferenceStoreArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'ReferenceStoreDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceStoreDetail' => [ 'type' => 'structure', 'required' => [ 'arn', 'id', 'creationTime', ], 'members' => [ 'arn' => [ 'shape' => 'ReferenceStoreArn', ], 'id' => [ 'shape' => 'ReferenceStoreId', ], 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceStoreDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceStoreDetail', ], ], 'ReferenceStoreFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ReferenceStoreName', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceStoreId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ReferenceStoreName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceStreamingBlob' => [ 'type' => 'blob', 'streaming' => true, ], 'RequestTimeoutException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 408, 'senderFault' => true, ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', 'pattern' => '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}', ], 'ResourceIdentifier' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourceOwner' => [ 'type' => 'string', 'enum' => [ 'SELF', 'OTHER', ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:.*', ], 'RunArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'RunExport' => [ 'type' => 'string', 'enum' => [ 'DEFINITION', ], 'max' => 64, 'min' => 1, ], 'RunExportList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RunExport', ], 'max' => 32, 'min' => 0, ], 'RunFailureReason' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'RunGroupId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'RunGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RunGroupListItem', ], ], 'RunGroupListItem' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunGroupArn', ], 'id' => [ 'shape' => 'RunGroupId', ], 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'RunGroupListItemMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'RunGroupListItemMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'RunGroupListItemMaxDurationInteger', ], 'creationTime' => [ 'shape' => 'RunGroupTimestamp', ], 'maxGpus' => [ 'shape' => 'RunGroupListItemMaxGpusInteger', ], ], ], 'RunGroupListItemMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListItemMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListItemMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListItemMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupRequestId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'RunId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'RunLeftNormalization' => [ 'type' => 'boolean', ], 'RunList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RunListItem', ], ], 'RunListItem' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunArn', ], 'id' => [ 'shape' => 'RunId', ], 'status' => [ 'shape' => 'RunStatus', ], 'workflowId' => [ 'shape' => 'WorkflowId', ], 'name' => [ 'shape' => 'RunName', ], 'priority' => [ 'shape' => 'RunListItemPriorityInteger', ], 'storageCapacity' => [ 'shape' => 'RunListItemStorageCapacityInteger', ], 'creationTime' => [ 'shape' => 'RunTimestamp', ], 'startTime' => [ 'shape' => 'RunTimestamp', ], 'stopTime' => [ 'shape' => 'RunTimestamp', ], ], ], 'RunListItemPriorityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'RunListItemStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'RunListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunLogLevel' => [ 'type' => 'string', 'enum' => [ 'OFF', 'FATAL', 'ERROR', 'ALL', ], 'max' => 64, 'min' => 1, ], 'RunLogLocation' => [ 'type' => 'structure', 'members' => [ 'engineLogStream' => [ 'shape' => 'EngineLogStream', ], 'runLogStream' => [ 'shape' => 'RunLogStream', ], ], ], 'RunLogStream' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunOutputUri' => [ 'type' => 'string', 'max' => 750, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunParameters' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'RunRequestId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunResourceDigest' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunResourceDigestKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunResourceDigests' => [ 'type' => 'map', 'key' => [ 'shape' => 'RunResourceDigestKey', ], 'value' => [ 'shape' => 'RunResourceDigest', ], ], 'RunRetentionMode' => [ 'type' => 'string', 'enum' => [ 'RETAIN', 'REMOVE', ], 'max' => 64, 'min' => 1, ], 'RunRoleArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'RunStartedBy' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'RunStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STARTING', 'RUNNING', 'STOPPING', 'COMPLETED', 'DELETED', 'CANCELLED', 'FAILED', ], 'max' => 64, 'min' => 1, ], 'RunStatusMessage' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'RunUuid' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'S3AccessPointArn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => 'arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*', ], 'S3Destination' => [ 'type' => 'string', 'pattern' => 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?', ], 'S3Uri' => [ 'type' => 'string', 'pattern' => 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})', ], 'SampleId' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SchemaItem' => [ 'type' => 'map', 'key' => [ 'shape' => 'SchemaItemKeyString', ], 'value' => [ 'shape' => 'SchemaValueType', ], 'max' => 1, 'min' => 1, ], 'SchemaItemKeyString' => [ 'type' => 'string', 'pattern' => '[a-z0-9_]{1,255}', ], 'SchemaValueType' => [ 'type' => 'string', 'enum' => [ 'LONG', 'INT', 'STRING', 'FLOAT', 'DOUBLE', 'BOOLEAN', ], ], 'Separator' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'SequenceInformation' => [ 'type' => 'structure', 'members' => [ 'totalReadCount' => [ 'shape' => 'Long', ], 'totalBaseCount' => [ 'shape' => 'Long', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'alignment' => [ 'shape' => 'String', ], ], ], 'SequenceStoreArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'SequenceStoreDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SequenceStoreDetail' => [ 'type' => 'structure', 'required' => [ 'arn', 'id', 'creationTime', ], 'members' => [ 'arn' => [ 'shape' => 'SequenceStoreArn', ], 'id' => [ 'shape' => 'SequenceStoreId', ], 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'SequenceStoreDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SequenceStoreDetail', ], ], 'SequenceStoreFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SequenceStoreName', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'SequenceStoreId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'SequenceStoreName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SequenceStoreS3Access' => [ 'type' => 'structure', 'members' => [ 's3Uri' => [ 'shape' => 'S3Uri', ], 's3AccessPointArn' => [ 'shape' => 'S3AccessPointArn', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'ShareDetails' => [ 'type' => 'structure', 'members' => [ 'shareId' => [ 'shape' => 'String', ], 'resourceArn' => [ 'shape' => 'String', ], 'principalSubscriber' => [ 'shape' => 'String', ], 'ownerId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'ShareStatus', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'shareName' => [ 'shape' => 'ShareName', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], ], ], 'ShareDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareDetails', ], ], 'ShareName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ShareStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ACTIVATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', ], ], 'SourceFiles' => [ 'type' => 'structure', 'required' => [ 'source1', ], 'members' => [ 'source1' => [ 'shape' => 'S3Uri', ], 'source2' => [ 'shape' => 'S3Uri', ], ], ], 'SseConfig' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'EncryptionType', ], 'keyArn' => [ 'shape' => 'SseConfigKeyArnString', ], ], ], 'SseConfigKeyArnString' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*', ], 'StartAnnotationImportRequest' => [ 'type' => 'structure', 'required' => [ 'destinationName', 'roleArn', 'items', ], 'members' => [ 'destinationName' => [ 'shape' => 'StoreName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'items' => [ 'shape' => 'AnnotationImportItemSources', ], 'versionName' => [ 'shape' => 'VersionName', ], 'formatOptions' => [ 'shape' => 'FormatOptions', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'StartAnnotationImportResponse' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', ], ], ], 'StartReadSetActivationJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'sources', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReadSetActivationJobRequestSourcesList', ], ], ], 'StartReadSetActivationJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StartReadSetActivationJobSourceItem', ], 'max' => 20, 'min' => 1, ], 'StartReadSetActivationJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReadSetActivationJobSourceItem' => [ 'type' => 'structure', 'required' => [ 'readSetId', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], ], ], 'StartReadSetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'destination', 'roleArn', 'sources', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReadSetExportJobRequestSourcesList', ], ], ], 'StartReadSetExportJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportReadSet', ], 'max' => 100, 'min' => 1, ], 'StartReadSetExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'destination', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ExportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReadSetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'roleArn', 'sources', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReadSetImportJobRequestSourcesList', ], ], ], 'StartReadSetImportJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StartReadSetImportJobSourceItem', ], 'max' => 100, 'min' => 1, ], 'StartReadSetImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReadSetImportJobSourceItem' => [ 'type' => 'structure', 'required' => [ 'sourceFiles', 'sourceFileType', 'subjectId', 'sampleId', ], 'members' => [ 'sourceFiles' => [ 'shape' => 'SourceFiles', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'StartReferenceImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'referenceStoreId', 'roleArn', 'sources', ], 'members' => [ 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReferenceImportJobRequestSourcesList', ], ], ], 'StartReferenceImportJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StartReferenceImportJobSourceItem', ], 'max' => 100, 'min' => 1, ], 'StartReferenceImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReferenceImportJobSourceItem' => [ 'type' => 'structure', 'required' => [ 'sourceFile', 'name', ], 'members' => [ 'sourceFile' => [ 'shape' => 'S3Uri', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'StartRunRequest' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'requestId', ], 'members' => [ 'workflowId' => [ 'shape' => 'WorkflowId', ], 'workflowType' => [ 'shape' => 'WorkflowType', ], 'runId' => [ 'shape' => 'RunId', ], 'roleArn' => [ 'shape' => 'RunRoleArn', ], 'name' => [ 'shape' => 'RunName', ], 'runGroupId' => [ 'shape' => 'RunGroupId', ], 'priority' => [ 'shape' => 'StartRunRequestPriorityInteger', ], 'parameters' => [ 'shape' => 'RunParameters', ], 'storageCapacity' => [ 'shape' => 'StartRunRequestStorageCapacityInteger', ], 'outputUri' => [ 'shape' => 'RunOutputUri', ], 'logLevel' => [ 'shape' => 'RunLogLevel', ], 'tags' => [ 'shape' => 'TagMap', ], 'requestId' => [ 'shape' => 'RunRequestId', 'idempotencyToken' => true, ], 'retentionMode' => [ 'shape' => 'RunRetentionMode', ], ], ], 'StartRunRequestPriorityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'StartRunRequestStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'StartRunResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunArn', ], 'id' => [ 'shape' => 'RunId', ], 'status' => [ 'shape' => 'RunStatus', ], 'tags' => [ 'shape' => 'TagMap', ], 'uuid' => [ 'shape' => 'RunUuid', ], 'runOutputUri' => [ 'shape' => 'RunOutputUri', ], ], ], 'StartVariantImportRequest' => [ 'type' => 'structure', 'required' => [ 'destinationName', 'roleArn', 'items', ], 'members' => [ 'destinationName' => [ 'shape' => 'StoreName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'items' => [ 'shape' => 'VariantImportItemSources', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'StartVariantImportResponse' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', ], ], ], 'StatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareStatus', ], ], 'StatusMessage' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'StoreFormat' => [ 'type' => 'string', 'enum' => [ 'GFF', 'TSV', 'VCF', ], ], 'StoreName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '([a-z]){1}([a-z0-9_]){2,254}', ], 'StoreOptions' => [ 'type' => 'structure', 'members' => [ 'tsvStoreOptions' => [ 'shape' => 'TsvStoreOptions', ], ], 'union' => true, ], 'StoreStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'UPDATING', 'DELETING', 'ACTIVE', 'FAILED', ], ], 'String' => [ 'type' => 'string', ], 'SubjectId' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SyntheticTimestamp_date_time' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'TagArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 0, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TagArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagResourceRequestTagsMap', ], ], ], 'TagResourceRequestTagsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 50, 'min' => 0, ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TaskFailureReason' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'TaskInstanceType' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskListItem', ], ], 'TaskListItem' => [ 'type' => 'structure', 'members' => [ 'taskId' => [ 'shape' => 'TaskId', ], 'status' => [ 'shape' => 'TaskStatus', ], 'name' => [ 'shape' => 'TaskName', ], 'cpus' => [ 'shape' => 'TaskListItemCpusInteger', ], 'memory' => [ 'shape' => 'TaskListItemMemoryInteger', ], 'creationTime' => [ 'shape' => 'TaskTimestamp', ], 'startTime' => [ 'shape' => 'TaskTimestamp', ], 'stopTime' => [ 'shape' => 'TaskTimestamp', ], 'gpus' => [ 'shape' => 'TaskListItemGpusInteger', ], 'instanceType' => [ 'shape' => 'TaskInstanceType', ], ], ], 'TaskListItemCpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'TaskListItemGpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'TaskListItemMemoryInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'TaskListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskLogStream' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TaskStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STARTING', 'RUNNING', 'STOPPING', 'COMPLETED', 'CANCELLED', 'FAILED', ], 'max' => 64, 'min' => 1, ], 'TaskStatusMessage' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'TsvOptions' => [ 'type' => 'structure', 'members' => [ 'readOptions' => [ 'shape' => 'ReadOptions', ], ], ], 'TsvStoreOptions' => [ 'type' => 'structure', 'members' => [ 'annotationType' => [ 'shape' => 'AnnotationType', ], 'formatToHeader' => [ 'shape' => 'FormatToHeader', ], 'schema' => [ 'shape' => 'TsvStoreOptionsSchemaList', ], ], ], 'TsvStoreOptionsSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaItem', ], 'max' => 5000, 'min' => 1, ], 'TsvVersionOptions' => [ 'type' => 'structure', 'members' => [ 'annotationType' => [ 'shape' => 'AnnotationType', ], 'formatToHeader' => [ 'shape' => 'FormatToHeader', ], 'schema' => [ 'shape' => 'TsvVersionOptionsSchemaList', ], ], ], 'TsvVersionOptionsSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaItem', ], 'max' => 5000, 'min' => 1, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TagArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdateAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'name', 'description', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], ], ], 'UpdateAnnotationStoreVersionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versionName', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'versionName' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'versionName', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdateAnnotationStoreVersionResponse' => [ 'type' => 'structure', 'required' => [ 'storeId', 'id', 'status', 'name', 'versionName', 'description', 'creationTime', 'updateTime', ], 'members' => [ 'storeId' => [ 'shape' => 'ResourceId', ], 'id' => [ 'shape' => 'ResourceId', ], 'status' => [ 'shape' => 'VersionStatus', ], 'name' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], ], ], 'UpdateRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunGroupId', 'location' => 'uri', 'locationName' => 'id', ], 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'UpdateRunGroupRequestMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'UpdateRunGroupRequestMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'UpdateRunGroupRequestMaxDurationInteger', ], 'maxGpus' => [ 'shape' => 'UpdateRunGroupRequestMaxGpusInteger', ], ], ], 'UpdateRunGroupRequestMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateRunGroupRequestMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateRunGroupRequestMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateRunGroupRequestMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'UpdateVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdateVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'name', 'description', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], ], ], 'UpdateWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'WorkflowId', 'location' => 'uri', 'locationName' => 'id', ], 'name' => [ 'shape' => 'WorkflowName', ], 'description' => [ 'shape' => 'WorkflowDescription', ], ], ], 'UploadId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'UploadReadSetPartRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'partSource', 'partNumber', 'payload', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', 'location' => 'querystring', 'locationName' => 'partSource', ], 'partNumber' => [ 'shape' => 'UploadReadSetPartRequestPartNumberInteger', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'payload' => [ 'shape' => 'ReadSetPartStreamingBlob', ], ], 'payload' => 'payload', ], 'UploadReadSetPartRequestPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'UploadReadSetPartResponse' => [ 'type' => 'structure', 'required' => [ 'checksum', ], 'members' => [ 'checksum' => [ 'shape' => 'String', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'VariantImportItemDetail' => [ 'type' => 'structure', 'required' => [ 'source', 'jobStatus', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], 'jobStatus' => [ 'shape' => 'JobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMsg', ], ], ], 'VariantImportItemDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantImportItemDetail', ], 'min' => 1, ], 'VariantImportItemSource' => [ 'type' => 'structure', 'required' => [ 'source', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], ], ], 'VariantImportItemSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantImportItemSource', ], 'min' => 1, ], 'VariantImportJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'roleArn', 'status', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'destinationName' => [ 'shape' => 'String', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'VariantImportJobItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantImportJobItem', ], ], 'VariantStoreItem' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'description', 'sseConfig', 'creationTime', 'updateTime', 'statusMessage', 'storeSizeBytes', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], ], ], 'VariantStoreItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantStoreItem', ], ], 'VcfOptions' => [ 'type' => 'structure', 'members' => [ 'ignoreQualField' => [ 'shape' => 'Boolean', ], 'ignoreFilterField' => [ 'shape' => 'Boolean', ], ], ], 'VersionDeleteError' => [ 'type' => 'structure', 'required' => [ 'versionName', 'message', ], 'members' => [ 'versionName' => [ 'shape' => 'VersionName', ], 'message' => [ 'shape' => 'String', ], ], ], 'VersionDeleteErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionDeleteError', ], ], 'VersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionName', ], 'max' => 10, 'min' => 1, ], 'VersionName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '([a-z]){1}([a-z0-9_]){2,254}', ], 'VersionOptions' => [ 'type' => 'structure', 'members' => [ 'tsvVersionOptions' => [ 'shape' => 'TsvVersionOptions', ], ], 'union' => true, ], 'VersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'UPDATING', 'DELETING', 'ACTIVE', 'FAILED', ], ], 'WorkflowArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'WorkflowDefinition' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowDigest' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'WorkflowEngine' => [ 'type' => 'string', 'enum' => [ 'WDL', 'NEXTFLOW', 'CWL', ], 'max' => 64, 'min' => 1, ], 'WorkflowExport' => [ 'type' => 'string', 'enum' => [ 'DEFINITION', ], 'max' => 64, 'min' => 1, ], 'WorkflowExportList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkflowExport', ], 'max' => 32, 'min' => 0, ], 'WorkflowId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'WorkflowList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkflowListItem', ], ], 'WorkflowListItem' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'WorkflowArn', ], 'id' => [ 'shape' => 'WorkflowId', ], 'name' => [ 'shape' => 'WorkflowName', ], 'status' => [ 'shape' => 'WorkflowStatus', ], 'type' => [ 'shape' => 'WorkflowType', ], 'digest' => [ 'shape' => 'WorkflowDigest', ], 'creationTime' => [ 'shape' => 'WorkflowTimestamp', ], 'metadata' => [ 'shape' => 'WorkflowMetadata', ], ], ], 'WorkflowListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowMain' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowMetadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'WorkflowMetadataKey', ], 'value' => [ 'shape' => 'WorkflowMetadataValue', ], ], 'WorkflowMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'WorkflowMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'WorkflowName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowParameter' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'WorkflowParameterDescription', ], 'optional' => [ 'shape' => 'Boolean', ], ], ], 'WorkflowParameterDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowParameterName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowParameterTemplate' => [ 'type' => 'map', 'key' => [ 'shape' => 'WorkflowParameterName', ], 'value' => [ 'shape' => 'WorkflowParameter', ], 'max' => 1000, 'min' => 1, ], 'WorkflowRequestId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'UPDATING', 'DELETED', 'FAILED', 'INACTIVE', ], 'max' => 64, 'min' => 1, ], 'WorkflowStatusMessage' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'WorkflowType' => [ 'type' => 'string', 'enum' => [ 'PRIVATE', 'READY2RUN', ], 'max' => 64, 'min' => 1, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2022-11-28', 'endpointPrefix' => 'omics', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon Omics', 'serviceId' => 'Omics', 'signatureVersion' => 'v4', 'signingName' => 'omics', 'uid' => 'omics-2022-11-28', ], 'operations' => [ 'AbortMultipartReadSetUpload' => [ 'name' => 'AbortMultipartReadSetUpload', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/abort', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AbortMultipartReadSetUploadRequest', ], 'output' => [ 'shape' => 'AbortMultipartReadSetUploadResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'AcceptShare' => [ 'name' => 'AcceptShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/share/{shareId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AcceptShareRequest', ], 'output' => [ 'shape' => 'AcceptShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'BatchDeleteReadSet' => [ 'name' => 'BatchDeleteReadSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/readset/batch/delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchDeleteReadSetRequest', ], 'output' => [ 'shape' => 'BatchDeleteReadSetResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'CancelAnnotationImportJob' => [ 'name' => 'CancelAnnotationImportJob', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/import/annotation/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CancelAnnotationImportRequest', ], 'output' => [ 'shape' => 'CancelAnnotationImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'CancelRun' => [ 'name' => 'CancelRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/run/{id}/cancel', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CancelRunRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'CancelVariantImportJob' => [ 'name' => 'CancelVariantImportJob', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/import/variant/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CancelVariantImportRequest', ], 'output' => [ 'shape' => 'CancelVariantImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'CompleteMultipartReadSetUpload' => [ 'name' => 'CompleteMultipartReadSetUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/complete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CompleteMultipartReadSetUploadRequest', ], 'output' => [ 'shape' => 'CompleteMultipartReadSetUploadResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], 'CreateAnnotationStore' => [ 'name' => 'CreateAnnotationStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAnnotationStoreRequest', ], 'output' => [ 'shape' => 'CreateAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateAnnotationStoreVersion' => [ 'name' => 'CreateAnnotationStoreVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/version', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAnnotationStoreVersionRequest', ], 'output' => [ 'shape' => 'CreateAnnotationStoreVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateMultipartReadSetUpload' => [ 'name' => 'CreateMultipartReadSetUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateMultipartReadSetUploadRequest', ], 'output' => [ 'shape' => 'CreateMultipartReadSetUploadResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'CreateReferenceStore' => [ 'name' => 'CreateReferenceStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateReferenceStoreRequest', ], 'output' => [ 'shape' => 'CreateReferenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'CreateRunGroup' => [ 'name' => 'CreateRunGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/runGroup', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateRunGroupRequest', ], 'output' => [ 'shape' => 'CreateRunGroupResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'CreateSequenceStore' => [ 'name' => 'CreateSequenceStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSequenceStoreRequest', ], 'output' => [ 'shape' => 'CreateSequenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'CreateShare' => [ 'name' => 'CreateShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/share', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateShareRequest', ], 'output' => [ 'shape' => 'CreateShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateVariantStore' => [ 'name' => 'CreateVariantStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/variantStore', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateVariantStoreRequest', ], 'output' => [ 'shape' => 'CreateVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'CreateWorkflow' => [ 'name' => 'CreateWorkflow', 'http' => [ 'method' => 'POST', 'requestUri' => '/workflow', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateWorkflowRequest', ], 'output' => [ 'shape' => 'CreateWorkflowResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'DeleteAnnotationStore' => [ 'name' => 'DeleteAnnotationStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/annotationStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAnnotationStoreRequest', ], 'output' => [ 'shape' => 'DeleteAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteAnnotationStoreVersions' => [ 'name' => 'DeleteAnnotationStoreVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/versions/delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteAnnotationStoreVersionsRequest', ], 'output' => [ 'shape' => 'DeleteAnnotationStoreVersionsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteReference' => [ 'name' => 'DeleteReference', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/referencestore/{referenceStoreId}/reference/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteReferenceRequest', ], 'output' => [ 'shape' => 'DeleteReferenceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'DeleteReferenceStore' => [ 'name' => 'DeleteReferenceStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/referencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteReferenceStoreRequest', ], 'output' => [ 'shape' => 'DeleteReferenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'DeleteRun' => [ 'name' => 'DeleteRun', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/run/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteRunRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], 'idempotent' => true, ], 'DeleteRunGroup' => [ 'name' => 'DeleteRunGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/runGroup/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteRunGroupRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], 'idempotent' => true, ], 'DeleteSequenceStore' => [ 'name' => 'DeleteSequenceStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/sequencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteSequenceStoreRequest', ], 'output' => [ 'shape' => 'DeleteSequenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], 'idempotent' => true, ], 'DeleteShare' => [ 'name' => 'DeleteShare', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/share/{shareId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteShareRequest', ], 'output' => [ 'shape' => 'DeleteShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteVariantStore' => [ 'name' => 'DeleteVariantStore', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/variantStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteVariantStoreRequest', ], 'output' => [ 'shape' => 'DeleteVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], 'idempotent' => true, ], 'DeleteWorkflow' => [ 'name' => 'DeleteWorkflow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/workflow/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteWorkflowRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], 'idempotent' => true, ], 'GetAnnotationImportJob' => [ 'name' => 'GetAnnotationImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/import/annotation/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAnnotationImportRequest', ], 'output' => [ 'shape' => 'GetAnnotationImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetAnnotationStore' => [ 'name' => 'GetAnnotationStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/annotationStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAnnotationStoreRequest', ], 'output' => [ 'shape' => 'GetAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetAnnotationStoreVersion' => [ 'name' => 'GetAnnotationStoreVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/annotationStore/{name}/version/{versionName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAnnotationStoreVersionRequest', ], 'output' => [ 'shape' => 'GetAnnotationStoreVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetReadSet' => [ 'name' => 'GetReadSet', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/readset/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetRequest', ], 'output' => [ 'shape' => 'GetReadSetResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'RangeNotSatisfiableException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], 'GetReadSetActivationJob' => [ 'name' => 'GetReadSetActivationJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/activationjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetActivationJobRequest', ], 'output' => [ 'shape' => 'GetReadSetActivationJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReadSetExportJob' => [ 'name' => 'GetReadSetExportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/exportjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetExportJobRequest', ], 'output' => [ 'shape' => 'GetReadSetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReadSetImportJob' => [ 'name' => 'GetReadSetImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/importjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetImportJobRequest', ], 'output' => [ 'shape' => 'GetReadSetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReadSetMetadata' => [ 'name' => 'GetReadSetMetadata', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{sequenceStoreId}/readset/{id}/metadata', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReadSetMetadataRequest', ], 'output' => [ 'shape' => 'GetReadSetMetadataResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReference' => [ 'name' => 'GetReference', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{referenceStoreId}/reference/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceRequest', ], 'output' => [ 'shape' => 'GetReferenceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'RangeNotSatisfiableException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], 'GetReferenceImportJob' => [ 'name' => 'GetReferenceImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{referenceStoreId}/importjob/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceImportJobRequest', ], 'output' => [ 'shape' => 'GetReferenceImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReferenceMetadata' => [ 'name' => 'GetReferenceMetadata', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{referenceStoreId}/reference/{id}/metadata', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceMetadataRequest', ], 'output' => [ 'shape' => 'GetReferenceMetadataResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetReferenceStore' => [ 'name' => 'GetReferenceStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/referencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetReferenceStoreRequest', ], 'output' => [ 'shape' => 'GetReferenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetRun' => [ 'name' => 'GetRun', 'http' => [ 'method' => 'GET', 'requestUri' => '/run/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRunRequest', ], 'output' => [ 'shape' => 'GetRunResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'GetRunGroup' => [ 'name' => 'GetRunGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/runGroup/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRunGroupRequest', ], 'output' => [ 'shape' => 'GetRunGroupResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'GetRunTask' => [ 'name' => 'GetRunTask', 'http' => [ 'method' => 'GET', 'requestUri' => '/run/{id}/task/{taskId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRunTaskRequest', ], 'output' => [ 'shape' => 'GetRunTaskResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'GetSequenceStore' => [ 'name' => 'GetSequenceStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/sequencestore/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSequenceStoreRequest', ], 'output' => [ 'shape' => 'GetSequenceStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'GetShare' => [ 'name' => 'GetShare', 'http' => [ 'method' => 'GET', 'requestUri' => '/share/{shareId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetShareRequest', ], 'output' => [ 'shape' => 'GetShareResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetVariantImportJob' => [ 'name' => 'GetVariantImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/import/variant/{jobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVariantImportRequest', ], 'output' => [ 'shape' => 'GetVariantImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetVariantStore' => [ 'name' => 'GetVariantStore', 'http' => [ 'method' => 'GET', 'requestUri' => '/variantStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetVariantStoreRequest', ], 'output' => [ 'shape' => 'GetVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'GetWorkflow' => [ 'name' => 'GetWorkflow', 'http' => [ 'method' => 'GET', 'requestUri' => '/workflow/{id}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWorkflowRequest', ], 'output' => [ 'shape' => 'GetWorkflowResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListAnnotationImportJobs' => [ 'name' => 'ListAnnotationImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/annotations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAnnotationImportJobsRequest', ], 'output' => [ 'shape' => 'ListAnnotationImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListAnnotationStoreVersions' => [ 'name' => 'ListAnnotationStoreVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAnnotationStoreVersionsRequest', ], 'output' => [ 'shape' => 'ListAnnotationStoreVersionsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListAnnotationStores' => [ 'name' => 'ListAnnotationStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAnnotationStoresRequest', ], 'output' => [ 'shape' => 'ListAnnotationStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListMultipartReadSetUploads' => [ 'name' => 'ListMultipartReadSetUploads', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/uploads', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListMultipartReadSetUploadsRequest', ], 'output' => [ 'shape' => 'ListMultipartReadSetUploadsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetActivationJobs' => [ 'name' => 'ListReadSetActivationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/activationjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetActivationJobsRequest', ], 'output' => [ 'shape' => 'ListReadSetActivationJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetExportJobs' => [ 'name' => 'ListReadSetExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/exportjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetExportJobsRequest', ], 'output' => [ 'shape' => 'ListReadSetExportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetImportJobs' => [ 'name' => 'ListReadSetImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/importjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetImportJobsRequest', ], 'output' => [ 'shape' => 'ListReadSetImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSetUploadParts' => [ 'name' => 'ListReadSetUploadParts', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/parts', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetUploadPartsRequest', ], 'output' => [ 'shape' => 'ListReadSetUploadPartsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReadSets' => [ 'name' => 'ListReadSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/readsets', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReadSetsRequest', ], 'output' => [ 'shape' => 'ListReadSetsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReferenceImportJobs' => [ 'name' => 'ListReferenceImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore/{referenceStoreId}/importjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReferenceImportJobsRequest', ], 'output' => [ 'shape' => 'ListReferenceImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReferenceStores' => [ 'name' => 'ListReferenceStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReferenceStoresRequest', ], 'output' => [ 'shape' => 'ListReferenceStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListReferences' => [ 'name' => 'ListReferences', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore/{referenceStoreId}/references', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReferencesRequest', ], 'output' => [ 'shape' => 'ListReferencesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListRunGroups' => [ 'name' => 'ListRunGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/runGroup', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRunGroupsRequest', ], 'output' => [ 'shape' => 'ListRunGroupsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListRunTasks' => [ 'name' => 'ListRunTasks', 'http' => [ 'method' => 'GET', 'requestUri' => '/run/{id}/task', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRunTasksRequest', ], 'output' => [ 'shape' => 'ListRunTasksResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListRuns' => [ 'name' => 'ListRuns', 'http' => [ 'method' => 'GET', 'requestUri' => '/run', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRunsRequest', ], 'output' => [ 'shape' => 'ListRunsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'ListSequenceStores' => [ 'name' => 'ListSequenceStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSequenceStoresRequest', ], 'output' => [ 'shape' => 'ListSequenceStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'ListShares' => [ 'name' => 'ListShares', 'http' => [ 'method' => 'POST', 'requestUri' => '/shares', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSharesRequest', ], 'output' => [ 'shape' => 'ListSharesResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'tags-', ], ], 'ListVariantImportJobs' => [ 'name' => 'ListVariantImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/variants', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVariantImportJobsRequest', ], 'output' => [ 'shape' => 'ListVariantImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListVariantStores' => [ 'name' => 'ListVariantStores', 'http' => [ 'method' => 'POST', 'requestUri' => '/variantStores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVariantStoresRequest', ], 'output' => [ 'shape' => 'ListVariantStoresResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'ListWorkflows' => [ 'name' => 'ListWorkflows', 'http' => [ 'method' => 'GET', 'requestUri' => '/workflow', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWorkflowsRequest', ], 'output' => [ 'shape' => 'ListWorkflowsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'StartAnnotationImportJob' => [ 'name' => 'StartAnnotationImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/annotation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartAnnotationImportRequest', ], 'output' => [ 'shape' => 'StartAnnotationImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'StartReadSetActivationJob' => [ 'name' => 'StartReadSetActivationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/activationjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReadSetActivationJobRequest', ], 'output' => [ 'shape' => 'StartReadSetActivationJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartReadSetExportJob' => [ 'name' => 'StartReadSetExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/exportjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReadSetExportJobRequest', ], 'output' => [ 'shape' => 'StartReadSetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartReadSetImportJob' => [ 'name' => 'StartReadSetImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/sequencestore/{sequenceStoreId}/importjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReadSetImportJobRequest', ], 'output' => [ 'shape' => 'StartReadSetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartReferenceImportJob' => [ 'name' => 'StartReferenceImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/referencestore/{referenceStoreId}/importjob', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartReferenceImportJobRequest', ], 'output' => [ 'shape' => 'StartReferenceImportJobResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'control-storage-', ], ], 'StartRun' => [ 'name' => 'StartRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/run', 'responseCode' => 201, ], 'input' => [ 'shape' => 'StartRunRequest', ], 'output' => [ 'shape' => 'StartRunResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'StartVariantImportJob' => [ 'name' => 'StartVariantImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/import/variant', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartVariantImportRequest', ], 'output' => [ 'shape' => 'StartVariantImportResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'tags-', ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'tags-', ], 'idempotent' => true, ], 'UpdateAnnotationStore' => [ 'name' => 'UpdateAnnotationStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAnnotationStoreRequest', ], 'output' => [ 'shape' => 'UpdateAnnotationStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'UpdateAnnotationStoreVersion' => [ 'name' => 'UpdateAnnotationStoreVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/annotationStore/{name}/version/{versionName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAnnotationStoreVersionRequest', ], 'output' => [ 'shape' => 'UpdateAnnotationStoreVersionResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'UpdateRunGroup' => [ 'name' => 'UpdateRunGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/runGroup/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateRunGroupRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'UpdateVariantStore' => [ 'name' => 'UpdateVariantStore', 'http' => [ 'method' => 'POST', 'requestUri' => '/variantStore/{name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVariantStoreRequest', ], 'output' => [ 'shape' => 'UpdateVariantStoreResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], 'endpoint' => [ 'hostPrefix' => 'analytics-', ], ], 'UpdateWorkflow' => [ 'name' => 'UpdateWorkflow', 'http' => [ 'method' => 'POST', 'requestUri' => '/workflow/{id}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateWorkflowRequest', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'endpoint' => [ 'hostPrefix' => 'workflows-', ], ], 'UploadReadSetPart' => [ 'name' => 'UploadReadSetPart', 'http' => [ 'method' => 'PUT', 'requestUri' => '/sequencestore/{sequenceStoreId}/upload/{uploadId}/part', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UploadReadSetPartRequest', ], 'output' => [ 'shape' => 'UploadReadSetPartResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'NotSupportedOperationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'RequestTimeoutException', ], ], 'authtype' => 'v4-unsigned-body', 'endpoint' => [ 'hostPrefix' => 'storage-', ], ], ], 'shapes' => [ 'AbortMultipartReadSetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], ], ], 'AbortMultipartReadSetUploadResponse' => [ 'type' => 'structure', 'members' => [], ], 'Accelerators' => [ 'type' => 'string', 'enum' => [ 'GPU', ], 'max' => 64, 'min' => 1, ], 'AcceptShareRequest' => [ 'type' => 'structure', 'required' => [ 'shareId', ], 'members' => [ 'shareId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'shareId', ], ], ], 'AcceptShareResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ShareStatus', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActivateReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ActivateReadSetJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ActivateReadSetJobList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActivateReadSetJobItem', ], ], 'ActivateReadSetSourceItem' => [ 'type' => 'structure', 'required' => [ 'readSetId', 'status', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], 'status' => [ 'shape' => 'ReadSetActivationJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], ], ], 'ActivateReadSetSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActivateReadSetSourceItem', ], ], 'ActivationJobId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'AnnotationFieldMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'AnnotationFieldMapKeyString', ], 'value' => [ 'shape' => 'AnnotationFieldMapValueString', ], ], 'AnnotationFieldMapKeyString' => [ 'type' => 'string', 'max' => 21, 'min' => 1, ], 'AnnotationFieldMapValueString' => [ 'type' => 'string', 'max' => 21, 'min' => 1, ], 'AnnotationImportItemDetail' => [ 'type' => 'structure', 'required' => [ 'source', 'jobStatus', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], 'jobStatus' => [ 'shape' => 'JobStatus', ], ], ], 'AnnotationImportItemDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationImportItemDetail', ], 'max' => 1, 'min' => 1, ], 'AnnotationImportItemSource' => [ 'type' => 'structure', 'required' => [ 'source', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], ], ], 'AnnotationImportItemSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationImportItemSource', ], 'min' => 1, ], 'AnnotationImportJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'versionName', 'roleArn', 'status', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'destinationName' => [ 'shape' => 'String', ], 'versionName' => [ 'shape' => 'VersionName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'AnnotationImportJobItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationImportJobItem', ], ], 'AnnotationStoreItem' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'storeFormat', 'description', 'sseConfig', 'creationTime', 'updateTime', 'statusMessage', 'storeSizeBytes', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], ], ], 'AnnotationStoreItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationStoreItem', ], ], 'AnnotationStoreVersionItem' => [ 'type' => 'structure', 'required' => [ 'storeId', 'id', 'status', 'versionArn', 'name', 'versionName', 'description', 'creationTime', 'updateTime', 'statusMessage', 'versionSizeBytes', ], 'members' => [ 'storeId' => [ 'shape' => 'ResourceId', ], 'id' => [ 'shape' => 'ResourceId', ], 'status' => [ 'shape' => 'VersionStatus', ], 'versionArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'versionSizeBytes' => [ 'shape' => 'Long', ], ], ], 'AnnotationStoreVersionItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnnotationStoreVersionItem', ], ], 'AnnotationType' => [ 'type' => 'string', 'enum' => [ 'GENERIC', 'CHR_POS', 'CHR_POS_REF_ALT', 'CHR_START_END_ONE_BASE', 'CHR_START_END_REF_ALT_ONE_BASE', 'CHR_START_END_ZERO_BASE', 'CHR_START_END_REF_ALT_ZERO_BASE', ], ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 10, 'min' => 1, ], 'BatchDeleteReadSetRequest' => [ 'type' => 'structure', 'required' => [ 'ids', 'sequenceStoreId', ], 'members' => [ 'ids' => [ 'shape' => 'ReadSetIdList', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'BatchDeleteReadSetResponse' => [ 'type' => 'structure', 'members' => [ 'errors' => [ 'shape' => 'ReadSetBatchErrorList', ], ], ], 'Blob' => [ 'type' => 'blob', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'CancelAnnotationImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'CancelAnnotationImportResponse' => [ 'type' => 'structure', 'members' => [], ], 'CancelRunRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'CancelVariantImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'CancelVariantImportResponse' => [ 'type' => 'structure', 'members' => [], ], 'ClientToken' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'CommentChar' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'CompleteMultipartReadSetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'parts', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], 'parts' => [ 'shape' => 'CompleteReadSetUploadPartList', ], ], ], 'CompleteMultipartReadSetUploadResponse' => [ 'type' => 'structure', 'required' => [ 'readSetId', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], ], ], 'CompleteReadSetUploadPartList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompleteReadSetUploadPartListItem', ], ], 'CompleteReadSetUploadPartListItem' => [ 'type' => 'structure', 'required' => [ 'partNumber', 'partSource', 'checksum', ], 'members' => [ 'partNumber' => [ 'shape' => 'CompleteReadSetUploadPartListItemPartNumberInteger', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', ], 'checksum' => [ 'shape' => 'CompleteReadSetUploadPartListItemChecksumString', ], ], ], 'CompleteReadSetUploadPartListItemChecksumString' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'CompleteReadSetUploadPartListItemPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'CompletionTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'CreateAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'storeFormat', ], 'members' => [ 'reference' => [ 'shape' => 'ReferenceItem', ], 'name' => [ 'shape' => 'StoreName', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'TagMap', ], 'versionName' => [ 'shape' => 'VersionName', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], ], ], 'CreateAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'status', 'name', 'versionName', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'versionName' => [ 'shape' => 'VersionName', ], 'creationTime' => [ 'shape' => 'CreationTime', ], ], ], 'CreateAnnotationStoreVersionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versionName', ], 'members' => [ 'name' => [ 'shape' => 'StoreName', 'location' => 'uri', 'locationName' => 'name', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'versionOptions' => [ 'shape' => 'VersionOptions', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateAnnotationStoreVersionResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'versionName', 'storeId', 'name', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'versionName' => [ 'shape' => 'VersionName', ], 'storeId' => [ 'shape' => 'ResourceId', ], 'versionOptions' => [ 'shape' => 'VersionOptions', ], 'name' => [ 'shape' => 'StoreName', ], 'status' => [ 'shape' => 'VersionStatus', ], 'creationTime' => [ 'shape' => 'CreationTime', ], ], ], 'CreateMultipartReadSetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'sourceFileType', 'subjectId', 'sampleId', 'name', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateMultipartReadSetUploadResponse' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'sourceFileType', 'subjectId', 'sampleId', 'referenceArn', 'creationTime', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'CreateReferenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'tags' => [ 'shape' => 'TagMap', ], 'clientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreateReferenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', ], 'arn' => [ 'shape' => 'ReferenceStoreArn', ], 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'CreateRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'requestId', ], 'members' => [ 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'CreateRunGroupRequestMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'CreateRunGroupRequestMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'CreateRunGroupRequestMaxDurationInteger', ], 'tags' => [ 'shape' => 'TagMap', ], 'requestId' => [ 'shape' => 'RunGroupRequestId', 'idempotencyToken' => true, ], 'maxGpus' => [ 'shape' => 'CreateRunGroupRequestMaxGpusInteger', ], ], ], 'CreateRunGroupRequestMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupRequestMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupRequestMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupRequestMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'CreateRunGroupResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunGroupArn', ], 'id' => [ 'shape' => 'RunGroupId', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateSequenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'tags' => [ 'shape' => 'TagMap', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'CreateSequenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', ], 'arn' => [ 'shape' => 'SequenceStoreArn', ], 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'CreateShareRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'principalSubscriber', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'principalSubscriber' => [ 'shape' => 'String', ], 'shareName' => [ 'shape' => 'ShareName', ], ], ], 'CreateShareResponse' => [ 'type' => 'structure', 'members' => [ 'shareId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'ShareStatus', ], 'shareName' => [ 'shape' => 'ShareName', ], ], ], 'CreateVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'reference', ], 'members' => [ 'reference' => [ 'shape' => 'ReferenceItem', ], 'name' => [ 'shape' => 'StoreName', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'TagMap', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], ], ], 'CreateVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'status', 'name', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'creationTime' => [ 'shape' => 'CreationTime', ], ], ], 'CreateWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'requestId', ], 'members' => [ 'name' => [ 'shape' => 'WorkflowName', ], 'description' => [ 'shape' => 'WorkflowDescription', ], 'engine' => [ 'shape' => 'WorkflowEngine', ], 'definitionZip' => [ 'shape' => 'Blob', ], 'definitionUri' => [ 'shape' => 'WorkflowDefinition', ], 'main' => [ 'shape' => 'WorkflowMain', ], 'parameterTemplate' => [ 'shape' => 'WorkflowParameterTemplate', ], 'storageCapacity' => [ 'shape' => 'CreateWorkflowRequestStorageCapacityInteger', ], 'tags' => [ 'shape' => 'TagMap', ], 'requestId' => [ 'shape' => 'WorkflowRequestId', 'idempotencyToken' => true, ], 'accelerators' => [ 'shape' => 'Accelerators', ], ], ], 'CreateWorkflowRequestStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'CreateWorkflowResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'WorkflowArn', ], 'id' => [ 'shape' => 'WorkflowId', ], 'status' => [ 'shape' => 'WorkflowStatus', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'CreationType' => [ 'type' => 'string', 'enum' => [ 'IMPORT', 'UPLOAD', ], ], 'DeleteAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'force' => [ 'shape' => 'PrimitiveBoolean', 'location' => 'querystring', 'locationName' => 'force', ], ], ], 'DeleteAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'DeleteAnnotationStoreVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versions', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'versions' => [ 'shape' => 'VersionList', ], 'force' => [ 'shape' => 'PrimitiveBoolean', 'location' => 'querystring', 'locationName' => 'force', ], ], ], 'DeleteAnnotationStoreVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'errors' => [ 'shape' => 'VersionDeleteErrorList', ], ], ], 'DeleteReferenceRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], ], ], 'DeleteReferenceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteReferenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteReferenceStoreResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunGroupId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteRunRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteSequenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'DeleteSequenceStoreResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteShareRequest' => [ 'type' => 'structure', 'required' => [ 'shareId', ], 'members' => [ 'shareId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'shareId', ], ], ], 'DeleteShareResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ShareStatus', ], ], ], 'DeleteVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'force' => [ 'shape' => 'PrimitiveBoolean', 'location' => 'querystring', 'locationName' => 'force', ], ], ], 'DeleteVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'DeleteWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'WorkflowId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'ETag' => [ 'type' => 'structure', 'members' => [ 'algorithm' => [ 'shape' => 'ETagAlgorithm', ], 'source1' => [ 'shape' => 'String', ], 'source2' => [ 'shape' => 'String', ], ], ], 'ETagAlgorithm' => [ 'type' => 'string', 'enum' => [ 'FASTQ_MD5up', 'BAM_MD5up', 'CRAM_MD5up', 'FASTQ_SHA256up', 'BAM_SHA256up', 'CRAM_SHA256up', 'FASTQ_SHA512up', 'BAM_SHA512up', 'CRAM_SHA512up', ], ], 'ETagAlgorithmFamily' => [ 'type' => 'string', 'enum' => [ 'MD5up', 'SHA256up', 'SHA512up', ], ], 'Encoding' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'EncryptionType' => [ 'type' => 'string', 'enum' => [ 'KMS', ], ], 'EngineLogStream' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'EscapeChar' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'EscapeQuotes' => [ 'type' => 'boolean', ], 'ExportJobId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ExportReadSet' => [ 'type' => 'structure', 'required' => [ 'readSetId', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], ], ], 'ExportReadSetDetail' => [ 'type' => 'structure', 'required' => [ 'id', 'status', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'status' => [ 'shape' => 'ReadSetExportJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], ], ], 'ExportReadSetDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportReadSetDetail', ], ], 'ExportReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ExportReadSetJobDetail' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'destination', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ExportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ExportReadSetJobDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportReadSetJobDetail', ], ], 'FileInformation' => [ 'type' => 'structure', 'members' => [ 'totalParts' => [ 'shape' => 'FileInformationTotalPartsInteger', ], 'partSize' => [ 'shape' => 'FileInformationPartSizeLong', ], 'contentLength' => [ 'shape' => 'FileInformationContentLengthLong', ], 's3Access' => [ 'shape' => 'ReadSetS3Access', ], ], ], 'FileInformationContentLengthLong' => [ 'type' => 'long', 'box' => true, 'max' => 5497558138880, 'min' => 1, ], 'FileInformationPartSizeLong' => [ 'type' => 'long', 'box' => true, 'max' => 5368709120, 'min' => 1, ], 'FileInformationTotalPartsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'FileType' => [ 'type' => 'string', 'enum' => [ 'FASTQ', 'BAM', 'CRAM', 'UBAM', ], ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'resourceArns' => [ 'shape' => 'ArnList', ], 'status' => [ 'shape' => 'StatusList', ], 'type' => [ 'shape' => 'TypeList', ], ], ], 'FormatOptions' => [ 'type' => 'structure', 'members' => [ 'tsvOptions' => [ 'shape' => 'TsvOptions', ], 'vcfOptions' => [ 'shape' => 'VcfOptions', ], ], 'union' => true, ], 'FormatToHeader' => [ 'type' => 'map', 'key' => [ 'shape' => 'FormatToHeaderKey', ], 'value' => [ 'shape' => 'FormatToHeaderValueString', ], ], 'FormatToHeaderKey' => [ 'type' => 'string', 'enum' => [ 'CHR', 'START', 'END', 'REF', 'ALT', 'POS', ], ], 'FormatToHeaderValueString' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'GeneratedFrom' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'GetAnnotationImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'GetAnnotationImportResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'versionName', 'roleArn', 'status', 'statusMessage', 'creationTime', 'updateTime', 'completionTime', 'items', 'runLeftNormalization', 'formatOptions', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'destinationName' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMsg', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'items' => [ 'shape' => 'AnnotationImportItemDetails', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'formatOptions' => [ 'shape' => 'FormatOptions', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'GetAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], ], ], 'GetAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'description', 'sseConfig', 'creationTime', 'updateTime', 'tags', 'statusMessage', 'storeSizeBytes', 'numVersions', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'tags' => [ 'shape' => 'TagMap', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], 'numVersions' => [ 'shape' => 'Integer', ], ], ], 'GetAnnotationStoreVersionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versionName', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'versionName' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'versionName', ], ], ], 'GetAnnotationStoreVersionResponse' => [ 'type' => 'structure', 'required' => [ 'storeId', 'id', 'status', 'versionArn', 'name', 'versionName', 'description', 'creationTime', 'updateTime', 'tags', 'statusMessage', 'versionSizeBytes', ], 'members' => [ 'storeId' => [ 'shape' => 'ResourceId', ], 'id' => [ 'shape' => 'ResourceId', ], 'status' => [ 'shape' => 'VersionStatus', ], 'versionArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'tags' => [ 'shape' => 'TagMap', ], 'versionOptions' => [ 'shape' => 'VersionOptions', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'versionSizeBytes' => [ 'shape' => 'Long', ], ], ], 'GetReadSetActivationJobRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'GetReadSetActivationJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sources' => [ 'shape' => 'ActivateReadSetSourceList', ], ], ], 'GetReadSetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'id', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'id' => [ 'shape' => 'ExportJobId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetReadSetExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'destination', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ExportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'readSets' => [ 'shape' => 'ExportReadSetDetailList', ], ], ], 'GetReadSetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'GetReadSetImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'roleArn', 'status', 'creationTime', 'sources', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sources' => [ 'shape' => 'ImportReadSetSourceList', ], ], ], 'GetReadSetMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], ], ], 'GetReadSetMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'sequenceStoreId', 'status', 'fileType', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'arn' => [ 'shape' => 'ReadSetArn', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'status' => [ 'shape' => 'ReadSetStatus', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'fileType' => [ 'shape' => 'FileType', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sequenceInformation' => [ 'shape' => 'SequenceInformation', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'files' => [ 'shape' => 'ReadSetFiles', ], 'statusMessage' => [ 'shape' => 'ReadSetStatusMessage', ], 'creationType' => [ 'shape' => 'CreationType', ], 'etag' => [ 'shape' => 'ETag', ], ], ], 'GetReadSetRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'partNumber', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', 'location' => 'uri', 'locationName' => 'id', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'file' => [ 'shape' => 'ReadSetFile', 'location' => 'querystring', 'locationName' => 'file', ], 'partNumber' => [ 'shape' => 'GetReadSetRequestPartNumberInteger', 'location' => 'querystring', 'locationName' => 'partNumber', ], ], ], 'GetReadSetRequestPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'GetReadSetResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'ReadSetStreamingBlob', ], ], 'payload' => 'payload', ], 'GetReferenceImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], ], ], 'GetReferenceImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'roleArn', 'status', 'creationTime', 'sources', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sources' => [ 'shape' => 'ImportReferenceSourceList', ], ], ], 'GetReferenceMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], ], ], 'GetReferenceMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'referenceStoreId', 'md5', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', ], 'arn' => [ 'shape' => 'ReferenceArn', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'md5' => [ 'shape' => 'Md5', ], 'status' => [ 'shape' => 'ReferenceStatus', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'updateTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'files' => [ 'shape' => 'ReferenceFiles', ], ], ], 'GetReferenceRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'partNumber', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', 'location' => 'uri', 'locationName' => 'id', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'range' => [ 'shape' => 'Range', 'location' => 'header', 'locationName' => 'Range', ], 'partNumber' => [ 'shape' => 'GetReferenceRequestPartNumberInteger', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'file' => [ 'shape' => 'ReferenceFile', 'location' => 'querystring', 'locationName' => 'file', ], ], ], 'GetReferenceRequestPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'GetReferenceResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'ReferenceStreamingBlob', ], ], 'payload' => 'payload', ], 'GetReferenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetReferenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceStoreId', ], 'arn' => [ 'shape' => 'ReferenceStoreArn', ], 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'GetRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunGroupId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetRunGroupResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunGroupArn', ], 'id' => [ 'shape' => 'RunGroupId', ], 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'GetRunGroupResponseMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'GetRunGroupResponseMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'GetRunGroupResponseMaxDurationInteger', ], 'creationTime' => [ 'shape' => 'RunGroupTimestamp', ], 'tags' => [ 'shape' => 'TagMap', ], 'maxGpus' => [ 'shape' => 'GetRunGroupResponseMaxGpusInteger', ], ], ], 'GetRunGroupResponseMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunGroupResponseMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunGroupResponseMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunGroupResponseMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'GetRunRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], 'export' => [ 'shape' => 'RunExportList', 'location' => 'querystring', 'locationName' => 'export', ], ], ], 'GetRunResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunArn', ], 'id' => [ 'shape' => 'RunId', ], 'status' => [ 'shape' => 'RunStatus', ], 'workflowId' => [ 'shape' => 'WorkflowId', ], 'workflowType' => [ 'shape' => 'WorkflowType', ], 'runId' => [ 'shape' => 'RunId', ], 'roleArn' => [ 'shape' => 'RunRoleArn', ], 'name' => [ 'shape' => 'RunName', ], 'runGroupId' => [ 'shape' => 'RunGroupId', ], 'priority' => [ 'shape' => 'GetRunResponsePriorityInteger', ], 'definition' => [ 'shape' => 'WorkflowDefinition', ], 'digest' => [ 'shape' => 'WorkflowDigest', ], 'parameters' => [ 'shape' => 'RunParameters', ], 'storageCapacity' => [ 'shape' => 'GetRunResponseStorageCapacityInteger', ], 'outputUri' => [ 'shape' => 'RunOutputUri', ], 'logLevel' => [ 'shape' => 'RunLogLevel', ], 'resourceDigests' => [ 'shape' => 'RunResourceDigests', ], 'startedBy' => [ 'shape' => 'RunStartedBy', ], 'creationTime' => [ 'shape' => 'RunTimestamp', ], 'startTime' => [ 'shape' => 'RunTimestamp', ], 'stopTime' => [ 'shape' => 'RunTimestamp', ], 'statusMessage' => [ 'shape' => 'RunStatusMessage', ], 'tags' => [ 'shape' => 'TagMap', ], 'accelerators' => [ 'shape' => 'Accelerators', ], 'retentionMode' => [ 'shape' => 'RunRetentionMode', ], 'failureReason' => [ 'shape' => 'RunFailureReason', ], 'logLocation' => [ 'shape' => 'RunLogLocation', ], 'uuid' => [ 'shape' => 'RunUuid', ], 'runOutputUri' => [ 'shape' => 'RunOutputUri', ], 'storageType' => [ 'shape' => 'StorageType', ], 'workflowOwnerId' => [ 'shape' => 'WorkflowOwnerId', ], ], ], 'GetRunResponsePriorityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'GetRunResponseStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'GetRunTaskRequest' => [ 'type' => 'structure', 'required' => [ 'id', 'taskId', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], 'taskId' => [ 'shape' => 'TaskId', 'location' => 'uri', 'locationName' => 'taskId', ], ], ], 'GetRunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'taskId' => [ 'shape' => 'TaskId', ], 'status' => [ 'shape' => 'TaskStatus', ], 'name' => [ 'shape' => 'TaskName', ], 'cpus' => [ 'shape' => 'GetRunTaskResponseCpusInteger', ], 'memory' => [ 'shape' => 'GetRunTaskResponseMemoryInteger', ], 'creationTime' => [ 'shape' => 'TaskTimestamp', ], 'startTime' => [ 'shape' => 'TaskTimestamp', ], 'stopTime' => [ 'shape' => 'TaskTimestamp', ], 'statusMessage' => [ 'shape' => 'TaskStatusMessage', ], 'logStream' => [ 'shape' => 'TaskLogStream', ], 'gpus' => [ 'shape' => 'GetRunTaskResponseGpusInteger', ], 'instanceType' => [ 'shape' => 'TaskInstanceType', ], 'failureReason' => [ 'shape' => 'TaskFailureReason', ], ], ], 'GetRunTaskResponseCpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'GetRunTaskResponseGpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'GetRunTaskResponseMemoryInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'GetSequenceStoreRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'id', ], ], ], 'GetSequenceStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'SequenceStoreId', ], 'arn' => [ 'shape' => 'SequenceStoreArn', ], 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 's3Access' => [ 'shape' => 'SequenceStoreS3Access', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'GetShareRequest' => [ 'type' => 'structure', 'required' => [ 'shareId', ], 'members' => [ 'shareId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'shareId', ], ], ], 'GetShareResponse' => [ 'type' => 'structure', 'members' => [ 'share' => [ 'shape' => 'ShareDetails', ], ], ], 'GetVariantImportRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'GetVariantImportResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'roleArn', 'status', 'statusMessage', 'creationTime', 'updateTime', 'items', 'runLeftNormalization', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'destinationName' => [ 'shape' => 'StoreName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMsg', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'items' => [ 'shape' => 'VariantImportItemDetails', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'GetVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], ], ], 'GetVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'description', 'sseConfig', 'creationTime', 'updateTime', 'tags', 'statusMessage', 'storeSizeBytes', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'tags' => [ 'shape' => 'TagMap', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], ], ], 'GetWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'WorkflowId', 'location' => 'uri', 'locationName' => 'id', ], 'type' => [ 'shape' => 'WorkflowType', 'location' => 'querystring', 'locationName' => 'type', ], 'export' => [ 'shape' => 'WorkflowExportList', 'location' => 'querystring', 'locationName' => 'export', ], 'workflowOwnerId' => [ 'shape' => 'WorkflowOwnerId', 'location' => 'querystring', 'locationName' => 'workflowOwnerId', ], ], ], 'GetWorkflowResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'WorkflowArn', ], 'id' => [ 'shape' => 'WorkflowId', ], 'status' => [ 'shape' => 'WorkflowStatus', ], 'type' => [ 'shape' => 'WorkflowType', ], 'name' => [ 'shape' => 'WorkflowName', ], 'description' => [ 'shape' => 'WorkflowDescription', ], 'engine' => [ 'shape' => 'WorkflowEngine', ], 'definition' => [ 'shape' => 'WorkflowDefinition', ], 'main' => [ 'shape' => 'WorkflowMain', ], 'digest' => [ 'shape' => 'WorkflowDigest', ], 'parameterTemplate' => [ 'shape' => 'WorkflowParameterTemplate', ], 'storageCapacity' => [ 'shape' => 'GetWorkflowResponseStorageCapacityInteger', ], 'creationTime' => [ 'shape' => 'WorkflowTimestamp', ], 'statusMessage' => [ 'shape' => 'WorkflowStatusMessage', ], 'tags' => [ 'shape' => 'TagMap', ], 'metadata' => [ 'shape' => 'WorkflowMetadata', ], 'accelerators' => [ 'shape' => 'Accelerators', ], ], ], 'GetWorkflowResponseStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'Header' => [ 'type' => 'boolean', ], 'ImportJobId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ImportReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReadSetJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReadSetJobList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReadSetJobItem', ], ], 'ImportReadSetSourceItem' => [ 'type' => 'structure', 'required' => [ 'sourceFiles', 'sourceFileType', 'status', 'subjectId', 'sampleId', ], 'members' => [ 'sourceFiles' => [ 'shape' => 'SourceFiles', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'status' => [ 'shape' => 'ReadSetImportJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ImportReadSetSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReadSetSourceItem', ], ], 'ImportReferenceFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReferenceJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'completionTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ImportReferenceJobList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReferenceJobItem', ], ], 'ImportReferenceSourceItem' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'sourceFile' => [ 'shape' => 'S3Uri', ], 'status' => [ 'shape' => 'ReferenceImportJobItemStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMessage', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ImportReferenceSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportReferenceSourceItem', ], ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'JobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLED', 'COMPLETED', 'FAILED', 'COMPLETED_WITH_FAILURES', ], ], 'JobStatusMessage' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'JobStatusMsg' => [ 'type' => 'string', ], 'LineSep' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'ListAnnotationImportJobsFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'JobStatus', ], 'storeName' => [ 'shape' => 'String', ], ], ], 'ListAnnotationImportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListAnnotationImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ids' => [ 'shape' => 'ListAnnotationImportJobsRequestIdsList', ], 'nextToken' => [ 'shape' => 'ListAnnotationImportJobsRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListAnnotationImportJobsFilter', ], ], ], 'ListAnnotationImportJobsRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListAnnotationImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListAnnotationImportJobsRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListAnnotationImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'annotationImportJobs' => [ 'shape' => 'AnnotationImportJobItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAnnotationStoreVersionsFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'VersionStatus', ], ], ], 'ListAnnotationStoreVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'maxResults' => [ 'shape' => 'ListAnnotationStoreVersionsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'ListAnnotationStoreVersionsRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListAnnotationStoreVersionsFilter', ], ], ], 'ListAnnotationStoreVersionsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListAnnotationStoreVersionsRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListAnnotationStoreVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'annotationStoreVersions' => [ 'shape' => 'AnnotationStoreVersionItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAnnotationStoresFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'ListAnnotationStoresRequest' => [ 'type' => 'structure', 'members' => [ 'ids' => [ 'shape' => 'ListAnnotationStoresRequestIdsList', ], 'maxResults' => [ 'shape' => 'ListAnnotationStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'ListAnnotationStoresRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListAnnotationStoresFilter', ], ], ], 'ListAnnotationStoresRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListAnnotationStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListAnnotationStoresRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListAnnotationStoresResponse' => [ 'type' => 'structure', 'members' => [ 'annotationStores' => [ 'shape' => 'AnnotationStoreItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListMultipartReadSetUploadsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListMultipartReadSetUploadsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListMultipartReadSetUploadsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListMultipartReadSetUploadsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'uploads' => [ 'shape' => 'MultipartReadSetUploadList', ], ], ], 'ListReadSetActivationJobsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReadSetActivationJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ActivateReadSetFilter', ], ], ], 'ListReadSetActivationJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetActivationJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'activationJobs' => [ 'shape' => 'ActivateReadSetJobList', ], ], ], 'ListReadSetExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReadSetExportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ExportReadSetFilter', ], ], ], 'ListReadSetExportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'exportJobs' => [ 'shape' => 'ExportReadSetJobDetailList', ], ], ], 'ListReadSetImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'maxResults' => [ 'shape' => 'ListReadSetImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'filter' => [ 'shape' => 'ImportReadSetFilter', ], ], ], 'ListReadSetImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'importJobs' => [ 'shape' => 'ImportReadSetJobList', ], ], ], 'ListReadSetUploadPartsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'partSource', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', ], 'maxResults' => [ 'shape' => 'ListReadSetUploadPartsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReadSetUploadPartListFilter', ], ], ], 'ListReadSetUploadPartsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetUploadPartsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'parts' => [ 'shape' => 'ReadSetUploadPartList', ], ], ], 'ListReadSetsRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReadSetsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReadSetFilter', ], ], ], 'ListReadSetsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReadSetsResponse' => [ 'type' => 'structure', 'required' => [ 'readSets', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'readSets' => [ 'shape' => 'ReadSetList', ], ], ], 'ListReferenceImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'referenceStoreId', ], 'members' => [ 'maxResults' => [ 'shape' => 'ListReferenceImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'filter' => [ 'shape' => 'ImportReferenceFilter', ], ], ], 'ListReferenceImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReferenceImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'importJobs' => [ 'shape' => 'ImportReferenceJobList', ], ], ], 'ListReferenceStoresRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListReferenceStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReferenceStoreFilter', ], ], ], 'ListReferenceStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReferenceStoresResponse' => [ 'type' => 'structure', 'required' => [ 'referenceStores', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'referenceStores' => [ 'shape' => 'ReferenceStoreDetailList', ], ], ], 'ListReferencesRequest' => [ 'type' => 'structure', 'required' => [ 'referenceStoreId', ], 'members' => [ 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'maxResults' => [ 'shape' => 'ListReferencesRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ReferenceFilter', ], ], ], 'ListReferencesRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListReferencesResponse' => [ 'type' => 'structure', 'required' => [ 'references', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'references' => [ 'shape' => 'ReferenceList', ], ], ], 'ListRunGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RunGroupName', 'location' => 'querystring', 'locationName' => 'name', ], 'startingToken' => [ 'shape' => 'RunGroupListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListRunGroupsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRunGroupsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListRunGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'RunGroupList', ], 'nextToken' => [ 'shape' => 'RunGroupListToken', ], ], ], 'ListRunTasksRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunId', 'location' => 'uri', 'locationName' => 'id', ], 'status' => [ 'shape' => 'TaskStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'startingToken' => [ 'shape' => 'TaskListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListRunTasksRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRunTasksRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListRunTasksResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'TaskList', ], 'nextToken' => [ 'shape' => 'TaskListToken', ], ], ], 'ListRunsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RunName', 'location' => 'querystring', 'locationName' => 'name', ], 'runGroupId' => [ 'shape' => 'RunGroupId', 'location' => 'querystring', 'locationName' => 'runGroupId', ], 'startingToken' => [ 'shape' => 'RunListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListRunsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'status' => [ 'shape' => 'RunStatus', 'location' => 'querystring', 'locationName' => 'status', ], ], ], 'ListRunsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListRunsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'RunList', ], 'nextToken' => [ 'shape' => 'RunListToken', ], ], ], 'ListSequenceStoresRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListSequenceStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'SequenceStoreFilter', ], ], ], 'ListSequenceStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListSequenceStoresResponse' => [ 'type' => 'structure', 'required' => [ 'sequenceStores', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'sequenceStores' => [ 'shape' => 'SequenceStoreDetailList', ], ], ], 'ListSharesRequest' => [ 'type' => 'structure', 'required' => [ 'resourceOwner', ], 'members' => [ 'resourceOwner' => [ 'shape' => 'ResourceOwner', ], 'filter' => [ 'shape' => 'Filter', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'Integer', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSharesResponse' => [ 'type' => 'structure', 'required' => [ 'shares', ], 'members' => [ 'shares' => [ 'shape' => 'ShareDetailsList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TagArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'required' => [ 'tags', ], 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ListVariantImportJobsFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'JobStatus', ], 'storeName' => [ 'shape' => 'String', ], ], ], 'ListVariantImportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListVariantImportJobsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ids' => [ 'shape' => 'ListVariantImportJobsRequestIdsList', ], 'nextToken' => [ 'shape' => 'ListVariantImportJobsRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListVariantImportJobsFilter', ], ], ], 'ListVariantImportJobsRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListVariantImportJobsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListVariantImportJobsRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListVariantImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'variantImportJobs' => [ 'shape' => 'VariantImportJobItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListVariantStoresFilter' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'StoreStatus', ], ], ], 'ListVariantStoresRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListVariantStoresRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ids' => [ 'shape' => 'ListVariantStoresRequestIdsList', ], 'nextToken' => [ 'shape' => 'ListVariantStoresRequestNextTokenString', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'filter' => [ 'shape' => 'ListVariantStoresFilter', ], ], ], 'ListVariantStoresRequestIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], 'max' => 20, 'min' => 1, ], 'ListVariantStoresRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListVariantStoresRequestNextTokenString' => [ 'type' => 'string', 'max' => 10000, 'min' => 1, ], 'ListVariantStoresResponse' => [ 'type' => 'structure', 'members' => [ 'variantStores' => [ 'shape' => 'VariantStoreItems', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListWorkflowsRequest' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'WorkflowType', 'location' => 'querystring', 'locationName' => 'type', ], 'name' => [ 'shape' => 'WorkflowName', 'location' => 'querystring', 'locationName' => 'name', ], 'startingToken' => [ 'shape' => 'WorkflowListToken', 'location' => 'querystring', 'locationName' => 'startingToken', ], 'maxResults' => [ 'shape' => 'ListWorkflowsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListWorkflowsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListWorkflowsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'WorkflowList', ], 'nextToken' => [ 'shape' => 'WorkflowListToken', ], ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'Md5' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{N}]+', ], 'MultipartReadSetUploadList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MultipartReadSetUploadListItem', ], ], 'MultipartReadSetUploadListItem' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'sourceFileType', 'subjectId', 'sampleId', 'generatedFrom', 'referenceArn', 'creationTime', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 6144, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'NotSupportedOperationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 405, 'senderFault' => true, ], 'exception' => true, ], 'PrimitiveBoolean' => [ 'type' => 'boolean', ], 'Quote' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'QuoteAll' => [ 'type' => 'boolean', ], 'Range' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{N}||\\p{P}]+', ], 'RangeNotSatisfiableException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 416, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => false, ], ], 'ReadOptions' => [ 'type' => 'structure', 'members' => [ 'sep' => [ 'shape' => 'Separator', ], 'encoding' => [ 'shape' => 'Encoding', ], 'quote' => [ 'shape' => 'Quote', ], 'quoteAll' => [ 'shape' => 'QuoteAll', ], 'escape' => [ 'shape' => 'EscapeChar', ], 'escapeQuotes' => [ 'shape' => 'EscapeQuotes', ], 'comment' => [ 'shape' => 'CommentChar', ], 'header' => [ 'shape' => 'Header', ], 'lineSep' => [ 'shape' => 'LineSep', ], ], ], 'ReadSetActivationJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReadSetActivationJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReadSetArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'ReadSetBatchError' => [ 'type' => 'structure', 'required' => [ 'id', 'code', 'message', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'code' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], ], 'ReadSetBatchErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetBatchError', ], ], 'ReadSetDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReadSetExportJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReadSetExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReadSetFile' => [ 'type' => 'string', 'enum' => [ 'SOURCE1', 'SOURCE2', 'INDEX', ], ], 'ReadSetFiles' => [ 'type' => 'structure', 'members' => [ 'source1' => [ 'shape' => 'FileInformation', ], 'source2' => [ 'shape' => 'FileInformation', ], 'index' => [ 'shape' => 'FileInformation', ], ], ], 'ReadSetFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ReadSetName', ], 'status' => [ 'shape' => 'ReadSetStatus', ], 'referenceArn' => [ 'shape' => 'ReferenceArnFilter', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'creationType' => [ 'shape' => 'CreationType', ], ], ], 'ReadSetId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ReadSetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetId', ], 'max' => 100, 'min' => 1, ], 'ReadSetImportJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReadSetImportJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReadSetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetListItem', ], ], 'ReadSetListItem' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'sequenceStoreId', 'status', 'fileType', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ReadSetId', ], 'arn' => [ 'shape' => 'ReadSetArn', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'status' => [ 'shape' => 'ReadSetStatus', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'fileType' => [ 'shape' => 'FileType', ], 'sequenceInformation' => [ 'shape' => 'SequenceInformation', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'statusMessage' => [ 'shape' => 'ReadSetStatusMessage', ], 'creationType' => [ 'shape' => 'CreationType', ], 'etag' => [ 'shape' => 'ETag', ], ], ], 'ReadSetName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReadSetPartSource' => [ 'type' => 'string', 'enum' => [ 'SOURCE1', 'SOURCE2', ], ], 'ReadSetPartStreamingBlob' => [ 'type' => 'blob', 'requiresLength' => true, 'streaming' => true, ], 'ReadSetS3Access' => [ 'type' => 'structure', 'members' => [ 's3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'ReadSetStatus' => [ 'type' => 'string', 'enum' => [ 'ARCHIVED', 'ACTIVATING', 'ACTIVE', 'DELETING', 'DELETED', 'PROCESSING_UPLOAD', 'UPLOAD_FAILED', ], ], 'ReadSetStatusMessage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReadSetStreamingBlob' => [ 'type' => 'blob', 'streaming' => true, ], 'ReadSetUploadPartList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadSetUploadPartListItem', ], ], 'ReadSetUploadPartListFilter' => [ 'type' => 'structure', 'members' => [ 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReadSetUploadPartListItem' => [ 'type' => 'structure', 'required' => [ 'partNumber', 'partSize', 'partSource', 'checksum', ], 'members' => [ 'partNumber' => [ 'shape' => 'ReadSetUploadPartListItemPartNumberInteger', ], 'partSize' => [ 'shape' => 'ReadSetUploadPartListItemPartSizeLong', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', ], 'checksum' => [ 'shape' => 'String', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'lastUpdatedTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReadSetUploadPartListItemPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'ReadSetUploadPartListItemPartSizeLong' => [ 'type' => 'long', 'box' => true, 'max' => 5368709120, 'min' => 1, ], 'ReferenceArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'ReferenceArnFilter' => [ 'type' => 'string', 'max' => 127, 'min' => 0, 'pattern' => '$|^arn:.+', ], 'ReferenceDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceFile' => [ 'type' => 'string', 'enum' => [ 'SOURCE', 'INDEX', ], ], 'ReferenceFiles' => [ 'type' => 'structure', 'members' => [ 'source' => [ 'shape' => 'FileInformation', ], 'index' => [ 'shape' => 'FileInformation', ], ], ], 'ReferenceFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ReferenceName', ], 'md5' => [ 'shape' => 'Md5', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ReferenceImportJobItemStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'FINISHED', 'FAILED', ], ], 'ReferenceImportJobStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'IN_PROGRESS', 'CANCELLING', 'CANCELLED', 'FAILED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', ], ], 'ReferenceItem' => [ 'type' => 'structure', 'members' => [ 'referenceArn' => [ 'shape' => 'ReferenceArn', ], ], 'union' => true, ], 'ReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceListItem', ], ], 'ReferenceListItem' => [ 'type' => 'structure', 'required' => [ 'id', 'arn', 'referenceStoreId', 'md5', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ReferenceId', ], 'arn' => [ 'shape' => 'ReferenceArn', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'md5' => [ 'shape' => 'Md5', ], 'status' => [ 'shape' => 'ReferenceStatus', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'updateTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETING', 'DELETED', ], ], 'ReferenceStoreArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'ReferenceStoreDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceStoreDetail' => [ 'type' => 'structure', 'required' => [ 'arn', 'id', 'creationTime', ], 'members' => [ 'arn' => [ 'shape' => 'ReferenceStoreArn', ], 'id' => [ 'shape' => 'ReferenceStoreId', ], 'name' => [ 'shape' => 'ReferenceStoreName', ], 'description' => [ 'shape' => 'ReferenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceStoreDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceStoreDetail', ], ], 'ReferenceStoreFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ReferenceStoreName', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'ReferenceStoreId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'ReferenceStoreName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'ReferenceStreamingBlob' => [ 'type' => 'blob', 'streaming' => true, ], 'RequestTimeoutException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 408, 'senderFault' => true, ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', 'pattern' => '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}', ], 'ResourceIdentifier' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourceOwner' => [ 'type' => 'string', 'enum' => [ 'SELF', 'OTHER', ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:.*', ], 'RunArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'RunExport' => [ 'type' => 'string', 'enum' => [ 'DEFINITION', ], 'max' => 64, 'min' => 1, ], 'RunExportList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RunExport', ], 'max' => 32, 'min' => 0, ], 'RunFailureReason' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'RunGroupId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'RunGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RunGroupListItem', ], ], 'RunGroupListItem' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunGroupArn', ], 'id' => [ 'shape' => 'RunGroupId', ], 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'RunGroupListItemMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'RunGroupListItemMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'RunGroupListItemMaxDurationInteger', ], 'creationTime' => [ 'shape' => 'RunGroupTimestamp', ], 'maxGpus' => [ 'shape' => 'RunGroupListItemMaxGpusInteger', ], ], ], 'RunGroupListItemMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListItemMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListItemMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListItemMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RunGroupListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupRequestId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunGroupTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'RunId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'RunLeftNormalization' => [ 'type' => 'boolean', ], 'RunList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RunListItem', ], ], 'RunListItem' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunArn', ], 'id' => [ 'shape' => 'RunId', ], 'status' => [ 'shape' => 'RunStatus', ], 'workflowId' => [ 'shape' => 'WorkflowId', ], 'name' => [ 'shape' => 'RunName', ], 'priority' => [ 'shape' => 'RunListItemPriorityInteger', ], 'storageCapacity' => [ 'shape' => 'RunListItemStorageCapacityInteger', ], 'creationTime' => [ 'shape' => 'RunTimestamp', ], 'startTime' => [ 'shape' => 'RunTimestamp', ], 'stopTime' => [ 'shape' => 'RunTimestamp', ], 'storageType' => [ 'shape' => 'StorageType', ], ], ], 'RunListItemPriorityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'RunListItemStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'RunListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunLogLevel' => [ 'type' => 'string', 'enum' => [ 'OFF', 'FATAL', 'ERROR', 'ALL', ], 'max' => 64, 'min' => 1, ], 'RunLogLocation' => [ 'type' => 'structure', 'members' => [ 'engineLogStream' => [ 'shape' => 'EngineLogStream', ], 'runLogStream' => [ 'shape' => 'RunLogStream', ], ], ], 'RunLogStream' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunOutputUri' => [ 'type' => 'string', 'max' => 750, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunParameters' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'RunRequestId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunResourceDigest' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunResourceDigestKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunResourceDigests' => [ 'type' => 'map', 'key' => [ 'shape' => 'RunResourceDigestKey', ], 'value' => [ 'shape' => 'RunResourceDigest', ], ], 'RunRetentionMode' => [ 'type' => 'string', 'enum' => [ 'RETAIN', 'REMOVE', ], 'max' => 64, 'min' => 1, ], 'RunRoleArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'RunStartedBy' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'RunStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STARTING', 'RUNNING', 'STOPPING', 'COMPLETED', 'DELETED', 'CANCELLED', 'FAILED', ], 'max' => 64, 'min' => 1, ], 'RunStatusMessage' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'RunTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'RunUuid' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'S3AccessPointArn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => 'arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*', ], 'S3Destination' => [ 'type' => 'string', 'pattern' => 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?', ], 'S3Uri' => [ 'type' => 'string', 'pattern' => 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})', ], 'SampleId' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SchemaItem' => [ 'type' => 'map', 'key' => [ 'shape' => 'SchemaItemKeyString', ], 'value' => [ 'shape' => 'SchemaValueType', ], 'max' => 1, 'min' => 1, ], 'SchemaItemKeyString' => [ 'type' => 'string', 'pattern' => '[a-z0-9_]{1,255}', ], 'SchemaValueType' => [ 'type' => 'string', 'enum' => [ 'LONG', 'INT', 'STRING', 'FLOAT', 'DOUBLE', 'BOOLEAN', ], ], 'Separator' => [ 'type' => 'string', 'max' => 20, 'min' => 1, ], 'SequenceInformation' => [ 'type' => 'structure', 'members' => [ 'totalReadCount' => [ 'shape' => 'Long', ], 'totalBaseCount' => [ 'shape' => 'Long', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'alignment' => [ 'shape' => 'String', ], ], ], 'SequenceStoreArn' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => 'arn:.+', ], 'SequenceStoreDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SequenceStoreDetail' => [ 'type' => 'structure', 'required' => [ 'arn', 'id', 'creationTime', ], 'members' => [ 'arn' => [ 'shape' => 'SequenceStoreArn', ], 'id' => [ 'shape' => 'SequenceStoreId', ], 'name' => [ 'shape' => 'SequenceStoreName', ], 'description' => [ 'shape' => 'SequenceStoreDescription', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'fallbackLocation' => [ 'shape' => 'S3Destination', ], 'eTagAlgorithmFamily' => [ 'shape' => 'ETagAlgorithmFamily', ], ], ], 'SequenceStoreDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SequenceStoreDetail', ], ], 'SequenceStoreFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SequenceStoreName', ], 'createdAfter' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'createdBefore' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'SequenceStoreId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'SequenceStoreName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SequenceStoreS3Access' => [ 'type' => 'structure', 'members' => [ 's3Uri' => [ 'shape' => 'S3Uri', ], 's3AccessPointArn' => [ 'shape' => 'S3AccessPointArn', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'ShareDetails' => [ 'type' => 'structure', 'members' => [ 'shareId' => [ 'shape' => 'String', ], 'resourceArn' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'principalSubscriber' => [ 'shape' => 'String', ], 'ownerId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'ShareStatus', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'shareName' => [ 'shape' => 'ShareName', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], ], ], 'ShareDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareDetails', ], ], 'ShareName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ShareResourceType' => [ 'type' => 'string', 'enum' => [ 'VARIANT_STORE', 'ANNOTATION_STORE', 'WORKFLOW', ], ], 'ShareStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ACTIVATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', ], ], 'SourceFiles' => [ 'type' => 'structure', 'required' => [ 'source1', ], 'members' => [ 'source1' => [ 'shape' => 'S3Uri', ], 'source2' => [ 'shape' => 'S3Uri', ], ], ], 'SseConfig' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'EncryptionType', ], 'keyArn' => [ 'shape' => 'SseConfigKeyArnString', ], ], ], 'SseConfigKeyArnString' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*', ], 'StartAnnotationImportRequest' => [ 'type' => 'structure', 'required' => [ 'destinationName', 'roleArn', 'items', ], 'members' => [ 'destinationName' => [ 'shape' => 'StoreName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'items' => [ 'shape' => 'AnnotationImportItemSources', ], 'versionName' => [ 'shape' => 'VersionName', ], 'formatOptions' => [ 'shape' => 'FormatOptions', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'StartAnnotationImportResponse' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', ], ], ], 'StartReadSetActivationJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'sources', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReadSetActivationJobRequestSourcesList', ], ], ], 'StartReadSetActivationJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StartReadSetActivationJobSourceItem', ], 'max' => 20, 'min' => 1, ], 'StartReadSetActivationJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ActivationJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'status' => [ 'shape' => 'ReadSetActivationJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReadSetActivationJobSourceItem' => [ 'type' => 'structure', 'required' => [ 'readSetId', ], 'members' => [ 'readSetId' => [ 'shape' => 'ReadSetId', ], ], ], 'StartReadSetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'destination', 'roleArn', 'sources', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReadSetExportJobRequestSourcesList', ], ], ], 'StartReadSetExportJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportReadSet', ], 'max' => 100, 'min' => 1, ], 'StartReadSetExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'destination', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ExportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'destination' => [ 'shape' => 'S3Destination', ], 'status' => [ 'shape' => 'ReadSetExportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReadSetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'roleArn', 'sources', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReadSetImportJobRequestSourcesList', ], ], ], 'StartReadSetImportJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StartReadSetImportJobSourceItem', ], 'max' => 100, 'min' => 1, ], 'StartReadSetImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'sequenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReadSetImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReadSetImportJobSourceItem' => [ 'type' => 'structure', 'required' => [ 'sourceFiles', 'sourceFileType', 'subjectId', 'sampleId', ], 'members' => [ 'sourceFiles' => [ 'shape' => 'SourceFiles', ], 'sourceFileType' => [ 'shape' => 'FileType', ], 'subjectId' => [ 'shape' => 'SubjectId', ], 'sampleId' => [ 'shape' => 'SampleId', ], 'generatedFrom' => [ 'shape' => 'GeneratedFrom', ], 'referenceArn' => [ 'shape' => 'ReferenceArn', ], 'name' => [ 'shape' => 'ReadSetName', ], 'description' => [ 'shape' => 'ReadSetDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'StartReferenceImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'referenceStoreId', 'roleArn', 'sources', ], 'members' => [ 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', 'location' => 'uri', 'locationName' => 'referenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'sources' => [ 'shape' => 'StartReferenceImportJobRequestSourcesList', ], ], ], 'StartReferenceImportJobRequestSourcesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StartReferenceImportJobSourceItem', ], 'max' => 100, 'min' => 1, ], 'StartReferenceImportJobResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'referenceStoreId', 'roleArn', 'status', 'creationTime', ], 'members' => [ 'id' => [ 'shape' => 'ImportJobId', ], 'referenceStoreId' => [ 'shape' => 'ReferenceStoreId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ReferenceImportJobStatus', ], 'creationTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], ], ], 'StartReferenceImportJobSourceItem' => [ 'type' => 'structure', 'required' => [ 'sourceFile', 'name', ], 'members' => [ 'sourceFile' => [ 'shape' => 'S3Uri', ], 'name' => [ 'shape' => 'ReferenceName', ], 'description' => [ 'shape' => 'ReferenceDescription', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'StartRunRequest' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'requestId', ], 'members' => [ 'workflowId' => [ 'shape' => 'WorkflowId', ], 'workflowType' => [ 'shape' => 'WorkflowType', ], 'runId' => [ 'shape' => 'RunId', ], 'roleArn' => [ 'shape' => 'RunRoleArn', ], 'name' => [ 'shape' => 'RunName', ], 'runGroupId' => [ 'shape' => 'RunGroupId', ], 'priority' => [ 'shape' => 'StartRunRequestPriorityInteger', ], 'parameters' => [ 'shape' => 'RunParameters', ], 'storageCapacity' => [ 'shape' => 'StartRunRequestStorageCapacityInteger', ], 'outputUri' => [ 'shape' => 'RunOutputUri', ], 'logLevel' => [ 'shape' => 'RunLogLevel', ], 'tags' => [ 'shape' => 'TagMap', ], 'requestId' => [ 'shape' => 'RunRequestId', 'idempotencyToken' => true, ], 'retentionMode' => [ 'shape' => 'RunRetentionMode', ], 'storageType' => [ 'shape' => 'StorageType', ], 'workflowOwnerId' => [ 'shape' => 'WorkflowOwnerId', ], ], ], 'StartRunRequestPriorityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'StartRunRequestStorageCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 0, ], 'StartRunResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'RunArn', ], 'id' => [ 'shape' => 'RunId', ], 'status' => [ 'shape' => 'RunStatus', ], 'tags' => [ 'shape' => 'TagMap', ], 'uuid' => [ 'shape' => 'RunUuid', ], 'runOutputUri' => [ 'shape' => 'RunOutputUri', ], ], ], 'StartVariantImportRequest' => [ 'type' => 'structure', 'required' => [ 'destinationName', 'roleArn', 'items', ], 'members' => [ 'destinationName' => [ 'shape' => 'StoreName', ], 'roleArn' => [ 'shape' => 'Arn', ], 'items' => [ 'shape' => 'VariantImportItemSources', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'StartVariantImportResponse' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'ResourceId', ], ], ], 'StatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareStatus', ], 'max' => 10, 'min' => 1, ], 'StatusMessage' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'STATIC', 'DYNAMIC', ], 'max' => 64, 'min' => 1, ], 'StoreFormat' => [ 'type' => 'string', 'enum' => [ 'GFF', 'TSV', 'VCF', ], ], 'StoreName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '([a-z]){1}([a-z0-9_]){2,254}', ], 'StoreOptions' => [ 'type' => 'structure', 'members' => [ 'tsvStoreOptions' => [ 'shape' => 'TsvStoreOptions', ], ], 'union' => true, ], 'StoreStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'UPDATING', 'DELETING', 'ACTIVE', 'FAILED', ], ], 'String' => [ 'type' => 'string', ], 'SubjectId' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'SyntheticTimestamp_date_time' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'TagArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 0, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TagArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagResourceRequestTagsMap', ], ], ], 'TagResourceRequestTagsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 50, 'min' => 0, ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TaskFailureReason' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'TaskInstanceType' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskListItem', ], ], 'TaskListItem' => [ 'type' => 'structure', 'members' => [ 'taskId' => [ 'shape' => 'TaskId', ], 'status' => [ 'shape' => 'TaskStatus', ], 'name' => [ 'shape' => 'TaskName', ], 'cpus' => [ 'shape' => 'TaskListItemCpusInteger', ], 'memory' => [ 'shape' => 'TaskListItemMemoryInteger', ], 'creationTime' => [ 'shape' => 'TaskTimestamp', ], 'startTime' => [ 'shape' => 'TaskTimestamp', ], 'stopTime' => [ 'shape' => 'TaskTimestamp', ], 'gpus' => [ 'shape' => 'TaskListItemGpusInteger', ], 'instanceType' => [ 'shape' => 'TaskInstanceType', ], ], ], 'TaskListItemCpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'TaskListItemGpusInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'TaskListItemMemoryInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'TaskListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskLogStream' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TaskStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STARTING', 'RUNNING', 'STOPPING', 'COMPLETED', 'CANCELLED', 'FAILED', ], 'max' => 64, 'min' => 1, ], 'TaskStatusMessage' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'TaskTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'TsvOptions' => [ 'type' => 'structure', 'members' => [ 'readOptions' => [ 'shape' => 'ReadOptions', ], ], ], 'TsvStoreOptions' => [ 'type' => 'structure', 'members' => [ 'annotationType' => [ 'shape' => 'AnnotationType', ], 'formatToHeader' => [ 'shape' => 'FormatToHeader', ], 'schema' => [ 'shape' => 'TsvStoreOptionsSchemaList', ], ], ], 'TsvStoreOptionsSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaItem', ], 'max' => 5000, 'min' => 1, ], 'TsvVersionOptions' => [ 'type' => 'structure', 'members' => [ 'annotationType' => [ 'shape' => 'AnnotationType', ], 'formatToHeader' => [ 'shape' => 'FormatToHeader', ], 'schema' => [ 'shape' => 'TsvVersionOptionsSchemaList', ], ], ], 'TsvVersionOptionsSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SchemaItem', ], 'max' => 5000, 'min' => 1, ], 'TypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareResourceType', ], 'max' => 10, 'min' => 1, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TagArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAnnotationStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdateAnnotationStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'name', 'description', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'storeOptions' => [ 'shape' => 'StoreOptions', ], 'storeFormat' => [ 'shape' => 'StoreFormat', ], ], ], 'UpdateAnnotationStoreVersionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'versionName', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'versionName' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'versionName', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdateAnnotationStoreVersionResponse' => [ 'type' => 'structure', 'required' => [ 'storeId', 'id', 'status', 'name', 'versionName', 'description', 'creationTime', 'updateTime', ], 'members' => [ 'storeId' => [ 'shape' => 'ResourceId', ], 'id' => [ 'shape' => 'ResourceId', ], 'status' => [ 'shape' => 'VersionStatus', ], 'name' => [ 'shape' => 'StoreName', ], 'versionName' => [ 'shape' => 'VersionName', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], ], ], 'UpdateRunGroupRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'RunGroupId', 'location' => 'uri', 'locationName' => 'id', ], 'name' => [ 'shape' => 'RunGroupName', ], 'maxCpus' => [ 'shape' => 'UpdateRunGroupRequestMaxCpusInteger', ], 'maxRuns' => [ 'shape' => 'UpdateRunGroupRequestMaxRunsInteger', ], 'maxDuration' => [ 'shape' => 'UpdateRunGroupRequestMaxDurationInteger', ], 'maxGpus' => [ 'shape' => 'UpdateRunGroupRequestMaxGpusInteger', ], ], ], 'UpdateRunGroupRequestMaxCpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateRunGroupRequestMaxDurationInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateRunGroupRequestMaxGpusInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateRunGroupRequestMaxRunsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100000, 'min' => 1, ], 'UpdateTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'UpdateVariantStoreRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'name', ], 'description' => [ 'shape' => 'Description', ], ], ], 'UpdateVariantStoreResponse' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'name', 'description', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], ], ], 'UpdateWorkflowRequest' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'WorkflowId', 'location' => 'uri', 'locationName' => 'id', ], 'name' => [ 'shape' => 'WorkflowName', ], 'description' => [ 'shape' => 'WorkflowDescription', ], ], ], 'UploadId' => [ 'type' => 'string', 'max' => 36, 'min' => 10, 'pattern' => '[0-9]+', ], 'UploadReadSetPartRequest' => [ 'type' => 'structure', 'required' => [ 'sequenceStoreId', 'uploadId', 'partSource', 'partNumber', 'payload', ], 'members' => [ 'sequenceStoreId' => [ 'shape' => 'SequenceStoreId', 'location' => 'uri', 'locationName' => 'sequenceStoreId', ], 'uploadId' => [ 'shape' => 'UploadId', 'location' => 'uri', 'locationName' => 'uploadId', ], 'partSource' => [ 'shape' => 'ReadSetPartSource', 'location' => 'querystring', 'locationName' => 'partSource', ], 'partNumber' => [ 'shape' => 'UploadReadSetPartRequestPartNumberInteger', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'payload' => [ 'shape' => 'ReadSetPartStreamingBlob', ], ], 'payload' => 'payload', ], 'UploadReadSetPartRequestPartNumberInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'UploadReadSetPartResponse' => [ 'type' => 'structure', 'required' => [ 'checksum', ], 'members' => [ 'checksum' => [ 'shape' => 'String', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'VariantImportItemDetail' => [ 'type' => 'structure', 'required' => [ 'source', 'jobStatus', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], 'jobStatus' => [ 'shape' => 'JobStatus', ], 'statusMessage' => [ 'shape' => 'JobStatusMsg', ], ], ], 'VariantImportItemDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantImportItemDetail', ], 'min' => 1, ], 'VariantImportItemSource' => [ 'type' => 'structure', 'required' => [ 'source', ], 'members' => [ 'source' => [ 'shape' => 'S3Uri', ], ], ], 'VariantImportItemSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantImportItemSource', ], 'min' => 1, ], 'VariantImportJobItem' => [ 'type' => 'structure', 'required' => [ 'id', 'destinationName', 'roleArn', 'status', 'creationTime', 'updateTime', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'destinationName' => [ 'shape' => 'String', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'JobStatus', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'completionTime' => [ 'shape' => 'CompletionTime', ], 'runLeftNormalization' => [ 'shape' => 'RunLeftNormalization', ], 'annotationFields' => [ 'shape' => 'AnnotationFieldMap', ], ], ], 'VariantImportJobItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantImportJobItem', ], ], 'VariantStoreItem' => [ 'type' => 'structure', 'required' => [ 'id', 'reference', 'status', 'storeArn', 'name', 'description', 'sseConfig', 'creationTime', 'updateTime', 'statusMessage', 'storeSizeBytes', ], 'members' => [ 'id' => [ 'shape' => 'ResourceId', ], 'reference' => [ 'shape' => 'ReferenceItem', ], 'status' => [ 'shape' => 'StoreStatus', ], 'storeArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'Description', ], 'sseConfig' => [ 'shape' => 'SseConfig', ], 'creationTime' => [ 'shape' => 'CreationTime', ], 'updateTime' => [ 'shape' => 'UpdateTime', ], 'statusMessage' => [ 'shape' => 'StatusMessage', ], 'storeSizeBytes' => [ 'shape' => 'Long', ], ], ], 'VariantStoreItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantStoreItem', ], ], 'VcfOptions' => [ 'type' => 'structure', 'members' => [ 'ignoreQualField' => [ 'shape' => 'Boolean', ], 'ignoreFilterField' => [ 'shape' => 'Boolean', ], ], ], 'VersionDeleteError' => [ 'type' => 'structure', 'required' => [ 'versionName', 'message', ], 'members' => [ 'versionName' => [ 'shape' => 'VersionName', ], 'message' => [ 'shape' => 'String', ], ], ], 'VersionDeleteErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionDeleteError', ], ], 'VersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionName', ], 'max' => 10, 'min' => 1, ], 'VersionName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '([a-z]){1}([a-z0-9_]){2,254}', ], 'VersionOptions' => [ 'type' => 'structure', 'members' => [ 'tsvVersionOptions' => [ 'shape' => 'TsvVersionOptions', ], ], 'union' => true, ], 'VersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'UPDATING', 'DELETING', 'ACTIVE', 'FAILED', ], ], 'WorkflowArn' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => 'arn:.+', ], 'WorkflowDefinition' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowDigest' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'WorkflowEngine' => [ 'type' => 'string', 'enum' => [ 'WDL', 'NEXTFLOW', 'CWL', ], 'max' => 64, 'min' => 1, ], 'WorkflowExport' => [ 'type' => 'string', 'enum' => [ 'DEFINITION', ], 'max' => 64, 'min' => 1, ], 'WorkflowExportList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkflowExport', ], 'max' => 32, 'min' => 0, ], 'WorkflowId' => [ 'type' => 'string', 'max' => 18, 'min' => 1, 'pattern' => '[0-9]+', ], 'WorkflowList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkflowListItem', ], ], 'WorkflowListItem' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'WorkflowArn', ], 'id' => [ 'shape' => 'WorkflowId', ], 'name' => [ 'shape' => 'WorkflowName', ], 'status' => [ 'shape' => 'WorkflowStatus', ], 'type' => [ 'shape' => 'WorkflowType', ], 'digest' => [ 'shape' => 'WorkflowDigest', ], 'creationTime' => [ 'shape' => 'WorkflowTimestamp', ], 'metadata' => [ 'shape' => 'WorkflowMetadata', ], ], ], 'WorkflowListToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowMain' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowMetadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'WorkflowMetadataKey', ], 'value' => [ 'shape' => 'WorkflowMetadataValue', ], ], 'WorkflowMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'WorkflowMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'WorkflowName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowOwnerId' => [ 'type' => 'string', 'pattern' => '[0-9]{12}', ], 'WorkflowParameter' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'WorkflowParameterDescription', ], 'optional' => [ 'shape' => 'Boolean', ], ], ], 'WorkflowParameterDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowParameterName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowParameterTemplate' => [ 'type' => 'map', 'key' => [ 'shape' => 'WorkflowParameterName', ], 'value' => [ 'shape' => 'WorkflowParameter', ], 'max' => 1000, 'min' => 1, ], 'WorkflowRequestId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'UPDATING', 'DELETED', 'FAILED', 'INACTIVE', ], 'max' => 64, 'min' => 1, ], 'WorkflowStatusMessage' => [ 'type' => 'string', 'pattern' => '[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+', ], 'WorkflowTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'WorkflowType' => [ 'type' => 'string', 'enum' => [ 'PRIVATE', 'READY2RUN', ], 'max' => 64, 'min' => 1, ], ],]; diff --git a/src/data/omics/2022-11-28/docs-2.json b/src/data/omics/2022-11-28/docs-2.json index 885ce45af1..9ea7efb15c 100644 --- a/src/data/omics/2022-11-28/docs-2.json +++ b/src/data/omics/2022-11-28/docs-2.json @@ -3,7 +3,7 @@ "service": "

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

", "operations": { "AbortMultipartReadSetUpload": "

Stops a multipart upload.

", - "AcceptShare": "

Accepts a share for an analytics store.

", + "AcceptShare": "

Accept a resource share request.

", "BatchDeleteReadSet": "

Deletes one or more read sets.

", "CancelAnnotationImportJob": "

Cancels an annotation import job.

", "CancelRun": "

Cancels a run.

", @@ -15,7 +15,7 @@ "CreateReferenceStore": "

Creates a reference store.

", "CreateRunGroup": "

Creates a run group.

", "CreateSequenceStore": "

Creates a sequence store.

", - "CreateShare": "

Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.

", + "CreateShare": "

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

", "CreateVariantStore": "

Creates a variant store.

", "CreateWorkflow": "

Creates a workflow.

", "DeleteAnnotationStore": "

Deletes an annotation store.

", @@ -25,7 +25,7 @@ "DeleteRun": "

Deletes a workflow run.

", "DeleteRunGroup": "

Deletes a workflow run group.

", "DeleteSequenceStore": "

Deletes a sequence store.

", - "DeleteShare": "

Deletes a share of an analytics store.

", + "DeleteShare": "

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

", "DeleteVariantStore": "

Deletes a variant store.

", "DeleteWorkflow": "

Deletes a workflow.

", "GetAnnotationImportJob": "

Gets information about an annotation import job.

", @@ -40,14 +40,14 @@ "GetReferenceImportJob": "

Gets information about a reference import job.

", "GetReferenceMetadata": "

Gets information about a genome reference's metadata.

", "GetReferenceStore": "

Gets information about a reference store.

", - "GetRun": "

Gets information about a workflow run.

", + "GetRun": "

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

", "GetRunGroup": "

Gets information about a workflow run group.

", "GetRunTask": "

Gets information about a workflow run task.

", "GetSequenceStore": "

Gets information about a sequence store.

", - "GetShare": "

Retrieves the metadata for a share.

", + "GetShare": "

Retrieves the metadata for the specified resource share.

", "GetVariantImportJob": "

Gets information about a variant import job.

", "GetVariantStore": "

Gets information about a variant store.

", - "GetWorkflow": "

Gets information about a workflow.

", + "GetWorkflow": "

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

", "ListAnnotationImportJobs": "

Retrieves a list of annotation import jobs.

", "ListAnnotationStoreVersions": "

Lists the versions of an annotation store.

", "ListAnnotationStores": "

Retrieves a list of annotation stores.

", @@ -64,7 +64,7 @@ "ListRunTasks": "

Retrieves a list of tasks for a run.

", "ListRuns": "

Retrieves a list of runs.

", "ListSequenceStores": "

Retrieves a list of sequence stores.

", - "ListShares": "

Lists all shares associated with an account.

", + "ListShares": "

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

", "ListTagsForResource": "

Retrieves a list of tags for a resource.

", "ListVariantImportJobs": "

Retrieves a list of variant import jobs.

", "ListVariantStores": "

Retrieves a list of variant stores.

", @@ -74,7 +74,7 @@ "StartReadSetExportJob": "

Exports a read set to Amazon S3.

", "StartReadSetImportJob": "

Starts a read set import job.

", "StartReferenceImportJob": "

Starts a reference import job.

", - "StartRun": "

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

", + "StartRun": "

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.

StartRun will not support re-run for a workflow that is shared with you.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.

", "StartVariantImportJob": "

Starts a variant import job.

", "TagResource": "

Tags a resource.

", "UntagResource": "

Removes tags from a resource.

", @@ -268,7 +268,7 @@ "ArnList": { "base": null, "refs": { - "Filter$resourceArns": "

The Amazon Resource Number (Arn) for an analytics store.

" + "Filter$resourceArns": "

Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.

" } }, "BatchDeleteReadSetRequest": { @@ -498,7 +498,7 @@ "CreateWorkflowRequestStorageCapacityInteger": { "base": null, "refs": { - "CreateWorkflowRequest$storageCapacity": "

A storage capacity for the workflow in gibibytes.

" + "CreateWorkflowRequest$storageCapacity": "

The storage capacity for the workflow in gibibytes.

" } }, "CreateWorkflowResponse": { @@ -520,7 +520,7 @@ "GetAnnotationStoreVersionResponse$creationTime": "

The time stamp for when an annotation store version was created.

", "GetVariantImportResponse$creationTime": "

When the job was created.

", "GetVariantStoreResponse$creationTime": "

When the store was created.

", - "ShareDetails$creationTime": "

The timestamp for when the share was created.

", + "ShareDetails$creationTime": "

The timestamp of when the resource share was created.

", "UpdateAnnotationStoreResponse$creationTime": "

When the store was created.

", "UpdateAnnotationStoreVersionResponse$creationTime": "

The time stamp for when an annotation store version was created.

", "UpdateVariantStoreResponse$creationTime": "

When the store was created.

", @@ -779,9 +779,9 @@ } }, "Filter": { - "base": "

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

", + "base": "

Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.

", "refs": { - "ListSharesRequest$filter": "

Attributes used to filter for a specific subset of shares.

" + "ListSharesRequest$filter": "

Attributes that you use to filter for a specific subset of resource shares.

" } }, "FormatOptions": { @@ -1007,7 +1007,7 @@ "GetRunResponseStorageCapacityInteger": { "base": null, "refs": { - "GetRunResponse$storageCapacity": "

The run's storage capacity in gigabytes.

" + "GetRunResponse$storageCapacity": "

The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

" } }, "GetRunTaskRequest": { @@ -1091,7 +1091,7 @@ "GetWorkflowResponseStorageCapacityInteger": { "base": null, "refs": { - "GetWorkflowResponse$storageCapacity": "

The workflow's storage capacity in gigabytes.

" + "GetWorkflowResponse$storageCapacity": "

The workflow's storage capacity in gibibytes.

" } }, "Header": { @@ -1177,7 +1177,7 @@ "base": null, "refs": { "GetAnnotationStoreResponse$numVersions": "

An integer indicating how many versions of an annotation store exist.

", - "ListSharesRequest$maxResults": "

The maximum number of shares to return in one page of results.

" + "ListSharesRequest$maxResults": "

The maximum number of shares to return in one page of results.

" } }, "InternalServerException": { @@ -1260,7 +1260,7 @@ } }, "ListAnnotationStoreVersionsFilter": { - "base": "

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

", + "base": "

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

", "refs": { "ListAnnotationStoreVersionsRequest$filter": "

A filter to apply to the list of annotation store versions.

" } @@ -2187,7 +2187,7 @@ "ResourceOwner": { "base": null, "refs": { - "ListSharesRequest$resourceOwner": "

The account that owns the analytics store shared.

" + "ListSharesRequest$resourceOwner": "

The account that owns the resource shares.

" } }, "RoleArn": { @@ -2365,7 +2365,7 @@ "RunListItemStorageCapacityInteger": { "base": null, "refs": { - "RunListItem$storageCapacity": "

The run's storage capacity.

" + "RunListItem$storageCapacity": "

The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

" } }, "RunListToken": { @@ -2674,33 +2674,39 @@ } }, "ShareDetails": { - "base": "

The details of a share.

", + "base": "

The details of a resource share.

", "refs": { - "GetShareResponse$share": "

An analytic store share details object. contains status, resourceArn, ownerId, etc.

", + "GetShareResponse$share": "

A resource share details object. The object includes the status, the resourceArn, and ownerId.

", "ShareDetailsList$member": null } }, "ShareDetailsList": { "base": null, "refs": { - "ListSharesResponse$shares": "

The shares available and their meta details.

" + "ListSharesResponse$shares": "

The shares available and their metadata details.

" } }, "ShareName": { "base": null, "refs": { - "CreateShareRequest$shareName": "

A name given to the share.

", - "CreateShareResponse$shareName": "

A name given to the share.

", - "ShareDetails$shareName": "

The name of the share.

" + "CreateShareRequest$shareName": "

A name that the owner defines for the share.

", + "CreateShareResponse$shareName": "

The name of the share.

", + "ShareDetails$shareName": "

The name of the resource share.

" + } + }, + "ShareResourceType": { + "base": null, + "refs": { + "TypeList$member": null } }, "ShareStatus": { "base": null, "refs": { - "AcceptShareResponse$status": "

The status of an analytics store share.

", - "CreateShareResponse$status": "

The status of a share.

", - "DeleteShareResponse$status": "

The status of the share being deleted.

", - "ShareDetails$status": "

The status of a share.

", + "AcceptShareResponse$status": "

The status of the resource share.

", + "CreateShareResponse$status": "

The status of the share.

", + "DeleteShareResponse$status": "

The status of the share being deleted.

", + "ShareDetails$status": "

The status of the share.

", "StatusList$member": null } }, @@ -2842,7 +2848,7 @@ "StartRunRequestStorageCapacityInteger": { "base": null, "refs": { - "StartRunRequest$storageCapacity": "

A storage capacity for the run in gibibytes.

" + "StartRunRequest$storageCapacity": "

A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

" } }, "StartRunResponse": { @@ -2863,7 +2869,7 @@ "StatusList": { "base": null, "refs": { - "Filter$status": "

The status of an annotation store version.

" + "Filter$status": "

Filter based on the resource status. You can specify up to 10 values.

" } }, "StatusMessage": { @@ -2874,10 +2880,18 @@ "GetAnnotationStoreResponse$statusMessage": "

A status message.

", "GetAnnotationStoreVersionResponse$statusMessage": "

The status of an annotation store version.

", "GetVariantStoreResponse$statusMessage": "

The store's status message.

", - "ShareDetails$statusMessage": "

The status message for a share. It provides more details on the status of the share.

", + "ShareDetails$statusMessage": "

The status message for a resource share. It provides additional details about the share status.

", "VariantStoreItem$statusMessage": "

The store's status message.

" } }, + "StorageType": { + "base": null, + "refs": { + "GetRunResponse$storageType": "

The run's storage type.

", + "RunListItem$storageType": "

The run's storage type.

", + "StartRunRequest$storageType": "

The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

" + } + }, "StoreFormat": { "base": null, "refs": { @@ -2933,7 +2947,7 @@ "String": { "base": null, "refs": { - "AcceptShareRequest$shareId": "

The ID for a share offer for analytics store data.

", + "AcceptShareRequest$shareId": "

The ID of the resource share.

", "AccessDeniedException$message": null, "AnnotationImportJobItem$id": "

The job's ID.

", "AnnotationImportJobItem$destinationName": "

The job's destination annotation store.

", @@ -2941,13 +2955,13 @@ "ArnList$member": null, "ConflictException$message": null, "CreateAnnotationStoreResponse$name": "

The store's name.

", - "CreateShareRequest$resourceArn": "

The resource ARN for the analytics store to be shared.

", - "CreateShareRequest$principalSubscriber": "

The principal subscriber is the account being given access to the analytics store data through the share offer.

", - "CreateShareResponse$shareId": "

An ID generated for the share.

", + "CreateShareRequest$resourceArn": "

The ARN of the resource to be shared.

", + "CreateShareRequest$principalSubscriber": "

The principal subscriber is the account being offered shared access to the resource.

", + "CreateShareResponse$shareId": "

The ID that HealthOmics generates for the share.

", "CreateVariantStoreResponse$name": "

The store's name.

", "DeleteAnnotationStoreRequest$name": "

The store's name.

", "DeleteAnnotationStoreVersionsRequest$name": "

The name of the annotation store from which versions are being deleted.

", - "DeleteShareRequest$shareId": "

The ID for the share request to be deleted.

", + "DeleteShareRequest$shareId": "

The ID for the resource share to be deleted.

", "DeleteVariantStoreRequest$name": "

The store's name.

", "ETag$source1": "

The ETag hash calculated on Source1 of the read set.

", "ETag$source2": "

The ETag hash calculated on Source2 of the read set.

", @@ -2955,7 +2969,7 @@ "GetAnnotationStoreResponse$name": "

The store's name.

", "GetAnnotationStoreVersionRequest$name": "

The name given to an annotation store version to distinguish it from others.

", "GetAnnotationStoreVersionRequest$versionName": "

The name given to an annotation store version to distinguish it from others.

", - "GetShareRequest$shareId": "

The generated ID for a share.

", + "GetShareRequest$shareId": "

The ID of the share.

", "GetVariantStoreRequest$name": "

The store's name.

", "GetVariantStoreResponse$name": "

The store's name.

", "InternalServerException$message": null, @@ -2964,7 +2978,7 @@ "ListAnnotationStoreVersionsRequest$name": "

The name of an annotation store.

", "ListAnnotationStoreVersionsResponse$nextToken": "

Specifies the pagination token from a previous request to retrieve the next page of results.

", "ListAnnotationStoresResponse$nextToken": "

A pagination token that's included if more results are available.

", - "ListSharesRequest$nextToken": "

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

", + "ListSharesRequest$nextToken": "

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

", "ListSharesResponse$nextToken": "

Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

", "ListVariantImportJobsFilter$storeName": "

A store name to filter on.

", "ListVariantImportJobsResponse$nextToken": "

A pagination token that's included if more results are available.

", @@ -2978,10 +2992,11 @@ "ResourceNotFoundException$message": null, "SequenceInformation$alignment": "

The sequence's alignment setting.

", "ServiceQuotaExceededException$message": null, - "ShareDetails$shareId": "

The ID for a share offer for an analytics store .

", - "ShareDetails$resourceArn": "

The resource Arn of the analytics store being shared.

", - "ShareDetails$principalSubscriber": "

The principal subscriber is the account the analytics store data is being shared with.

", - "ShareDetails$ownerId": "

The account ID for the data owner. The owner creates the share offer.

", + "ShareDetails$shareId": "

The ID of the resource share.

", + "ShareDetails$resourceArn": "

The Arn of the shared resource.

", + "ShareDetails$resourceId": "

The ID of the shared resource.

", + "ShareDetails$principalSubscriber": "

The principal subscriber is the account that is sharing the resource.

", + "ShareDetails$ownerId": "

The account ID for the data owner. The owner creates the resource share.

", "ThrottlingException$message": null, "UpdateAnnotationStoreRequest$name": "

A name for the store.

", "UpdateAnnotationStoreResponse$name": "

The store's name.

", @@ -3275,6 +3290,12 @@ "TsvVersionOptions$schema": "

The TSV schema for an annotation store version.

" } }, + "TypeList": { + "base": null, + "refs": { + "Filter$type": "

The type of resources to be filtered. You can specify one or more of the resource types.

" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -3345,7 +3366,7 @@ "GetAnnotationStoreVersionResponse$updateTime": "

The time stamp for when an annotation store version was updated.

", "GetVariantImportResponse$updateTime": "

When the job was updated.

", "GetVariantStoreResponse$updateTime": "

When the store was updated.

", - "ShareDetails$updateTime": "

The timestamp of the share update.

", + "ShareDetails$updateTime": "

The timestamp of the resource share update.

", "UpdateAnnotationStoreResponse$updateTime": "

When the store was updated.

", "UpdateAnnotationStoreVersionResponse$updateTime": "

The time stamp for when an annotation store version was updated.

", "UpdateVariantStoreResponse$updateTime": "

When the store was updated.

", @@ -3503,7 +3524,7 @@ "AnnotationStoreVersionItem$status": "

The status of an annotation store version.

", "CreateAnnotationStoreVersionResponse$status": "

The status of a annotation store version.

", "GetAnnotationStoreVersionResponse$status": "

The status of an annotation store version.

", - "ListAnnotationStoreVersionsFilter$status": "

The status of an annotation store version.

", + "ListAnnotationStoreVersionsFilter$status": "

The status of an annotation store version.

", "UpdateAnnotationStoreVersionResponse$status": "

The status of an annotation store version.

" } }, @@ -3575,7 +3596,7 @@ "WorkflowList": { "base": null, "refs": { - "ListWorkflowsResponse$items": "

The workflows' items.

" + "ListWorkflowsResponse$items": "

A list of workflow items.

" } }, "WorkflowListItem": { @@ -3622,11 +3643,19 @@ "refs": { "CreateWorkflowRequest$name": "

A name for the workflow.

", "GetWorkflowResponse$name": "

The workflow's name.

", - "ListWorkflowsRequest$name": "

The workflows' name.

", + "ListWorkflowsRequest$name": "

Filter the list by workflow name.

", "UpdateWorkflowRequest$name": "

A name for the workflow.

", "WorkflowListItem$name": "

The workflow's name.

" } }, + "WorkflowOwnerId": { + "base": null, + "refs": { + "GetRunResponse$workflowOwnerId": "

The ID of the workflow owner.

", + "GetWorkflowRequest$workflowOwnerId": "

The ID of the workflow owner.

", + "StartRunRequest$workflowOwnerId": "

The ID of the workflow owner.

" + } + }, "WorkflowParameter": { "base": "

A workflow parameter.

", "refs": { @@ -3685,7 +3714,7 @@ "GetRunResponse$workflowType": "

The run's workflow type.

", "GetWorkflowRequest$type": "

The workflow's type.

", "GetWorkflowResponse$type": "

The workflow's type.

", - "ListWorkflowsRequest$type": "

The workflows' type.

", + "ListWorkflowsRequest$type": "

Filter the list by workflow type.

", "StartRunRequest$workflowType": "

The run's workflow type.

", "WorkflowListItem$type": "

The workflow's type.

" } diff --git a/src/data/omics/2022-11-28/docs-2.json.php b/src/data/omics/2022-11-28/docs-2.json.php index 4bca4ba80a..91e4d7156b 100644 --- a/src/data/omics/2022-11-28/docs-2.json.php +++ b/src/data/omics/2022-11-28/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

', 'operations' => [ 'AbortMultipartReadSetUpload' => '

Stops a multipart upload.

', 'AcceptShare' => '

Accepts a share for an analytics store.

', 'BatchDeleteReadSet' => '

Deletes one or more read sets.

', 'CancelAnnotationImportJob' => '

Cancels an annotation import job.

', 'CancelRun' => '

Cancels a run.

', 'CancelVariantImportJob' => '

Cancels a variant import job.

', 'CompleteMultipartReadSetUpload' => '

Concludes a multipart upload once you have uploaded all the components.

', 'CreateAnnotationStore' => '

Creates an annotation store.

', 'CreateAnnotationStoreVersion' => '

Creates a new version of an annotation store.

', 'CreateMultipartReadSetUpload' => '

Begins a multipart read set upload.

', 'CreateReferenceStore' => '

Creates a reference store.

', 'CreateRunGroup' => '

Creates a run group.

', 'CreateSequenceStore' => '

Creates a sequence store.

', 'CreateShare' => '

Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.

', 'CreateVariantStore' => '

Creates a variant store.

', 'CreateWorkflow' => '

Creates a workflow.

', 'DeleteAnnotationStore' => '

Deletes an annotation store.

', 'DeleteAnnotationStoreVersions' => '

Deletes one or multiple versions of an annotation store.

', 'DeleteReference' => '

Deletes a genome reference.

', 'DeleteReferenceStore' => '

Deletes a genome reference store.

', 'DeleteRun' => '

Deletes a workflow run.

', 'DeleteRunGroup' => '

Deletes a workflow run group.

', 'DeleteSequenceStore' => '

Deletes a sequence store.

', 'DeleteShare' => '

Deletes a share of an analytics store.

', 'DeleteVariantStore' => '

Deletes a variant store.

', 'DeleteWorkflow' => '

Deletes a workflow.

', 'GetAnnotationImportJob' => '

Gets information about an annotation import job.

', 'GetAnnotationStore' => '

Gets information about an annotation store.

', 'GetAnnotationStoreVersion' => '

Retrieves the metadata for an annotation store version.

', 'GetReadSet' => '

Gets a file from a read set.

', 'GetReadSetActivationJob' => '

Gets information about a read set activation job.

', 'GetReadSetExportJob' => '

Gets information about a read set export job.

', 'GetReadSetImportJob' => '

Gets information about a read set import job.

', 'GetReadSetMetadata' => '

Gets details about a read set.

', 'GetReference' => '

Gets a reference file.

', 'GetReferenceImportJob' => '

Gets information about a reference import job.

', 'GetReferenceMetadata' => '

Gets information about a genome reference\'s metadata.

', 'GetReferenceStore' => '

Gets information about a reference store.

', 'GetRun' => '

Gets information about a workflow run.

', 'GetRunGroup' => '

Gets information about a workflow run group.

', 'GetRunTask' => '

Gets information about a workflow run task.

', 'GetSequenceStore' => '

Gets information about a sequence store.

', 'GetShare' => '

Retrieves the metadata for a share.

', 'GetVariantImportJob' => '

Gets information about a variant import job.

', 'GetVariantStore' => '

Gets information about a variant store.

', 'GetWorkflow' => '

Gets information about a workflow.

', 'ListAnnotationImportJobs' => '

Retrieves a list of annotation import jobs.

', 'ListAnnotationStoreVersions' => '

Lists the versions of an annotation store.

', 'ListAnnotationStores' => '

Retrieves a list of annotation stores.

', 'ListMultipartReadSetUploads' => '

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

', 'ListReadSetActivationJobs' => '

Retrieves a list of read set activation jobs.

', 'ListReadSetExportJobs' => '

Retrieves a list of read set export jobs.

', 'ListReadSetImportJobs' => '

Retrieves a list of read set import jobs.

', 'ListReadSetUploadParts' => '

This operation will list all parts in a requested multipart upload for a sequence store.

', 'ListReadSets' => '

Retrieves a list of read sets.

', 'ListReferenceImportJobs' => '

Retrieves a list of reference import jobs.

', 'ListReferenceStores' => '

Retrieves a list of reference stores.

', 'ListReferences' => '

Retrieves a list of references.

', 'ListRunGroups' => '

Retrieves a list of run groups.

', 'ListRunTasks' => '

Retrieves a list of tasks for a run.

', 'ListRuns' => '

Retrieves a list of runs.

', 'ListSequenceStores' => '

Retrieves a list of sequence stores.

', 'ListShares' => '

Lists all shares associated with an account.

', 'ListTagsForResource' => '

Retrieves a list of tags for a resource.

', 'ListVariantImportJobs' => '

Retrieves a list of variant import jobs.

', 'ListVariantStores' => '

Retrieves a list of variant stores.

', 'ListWorkflows' => '

Retrieves a list of workflows.

', 'StartAnnotationImportJob' => '

Starts an annotation import job.

', 'StartReadSetActivationJob' => '

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

', 'StartReadSetExportJob' => '

Exports a read set to Amazon S3.

', 'StartReadSetImportJob' => '

Starts a read set import job.

', 'StartReferenceImportJob' => '

Starts a reference import job.

', 'StartRun' => '

Starts a workflow run. To duplicate a run, specify the run\'s ID and a role ARN. The remaining parameters are copied from the previous run.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

', 'StartVariantImportJob' => '

Starts a variant import job.

', 'TagResource' => '

Tags a resource.

', 'UntagResource' => '

Removes tags from a resource.

', 'UpdateAnnotationStore' => '

Updates an annotation store.

', 'UpdateAnnotationStoreVersion' => '

Updates the description of an annotation store version.

', 'UpdateRunGroup' => '

Updates a run group.

', 'UpdateVariantStore' => '

Updates a variant store.

', 'UpdateWorkflow' => '

Updates a workflow.

', 'UploadReadSetPart' => '

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.

', ], 'shapes' => [ 'AbortMultipartReadSetUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'AbortMultipartReadSetUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'Accelerators' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$accelerators' => '

The computational accelerator specified to run the workflow.

', 'GetRunResponse$accelerators' => '

The computational accelerator used to run the workflow.

', 'GetWorkflowResponse$accelerators' => '

The computational accelerator specified to run the workflow.

', ], ], 'AcceptShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => '

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'ActivateReadSetFilter' => [ 'base' => '

A read set activation job filter.

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

A filter to apply to the list.

', ], ], 'ActivateReadSetJobItem' => [ 'base' => '

A read set activation job.

', 'refs' => [ 'ActivateReadSetJobList$member' => NULL, ], ], 'ActivateReadSetJobList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetActivationJobsResponse$activationJobs' => '

A list of jobs.

', ], ], 'ActivateReadSetSourceItem' => [ 'base' => '

A source for a read set activation job.

', 'refs' => [ 'ActivateReadSetSourceList$member' => NULL, ], ], 'ActivateReadSetSourceList' => [ 'base' => NULL, 'refs' => [ 'GetReadSetActivationJobResponse$sources' => '

The job\'s source files.

', ], ], 'ActivationJobId' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetJobItem$id' => '

The job\'s ID.

', 'GetReadSetActivationJobRequest$id' => '

The job\'s ID.

', 'GetReadSetActivationJobResponse$id' => '

The job\'s ID.

', 'StartReadSetActivationJobResponse$id' => '

The job\'s ID.

', ], ], 'AnnotationFieldMap' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'GetAnnotationImportResponse$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'GetVariantImportResponse$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'StartAnnotationImportRequest$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'StartVariantImportRequest$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'VariantImportJobItem$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', ], ], 'AnnotationFieldMapKeyString' => [ 'base' => NULL, 'refs' => [ 'AnnotationFieldMap$key' => NULL, ], ], 'AnnotationFieldMapValueString' => [ 'base' => NULL, 'refs' => [ 'AnnotationFieldMap$value' => NULL, ], ], 'AnnotationImportItemDetail' => [ 'base' => '

Details about an imported annotation item.

', 'refs' => [ 'AnnotationImportItemDetails$member' => NULL, ], ], 'AnnotationImportItemDetails' => [ 'base' => NULL, 'refs' => [ 'GetAnnotationImportResponse$items' => '

The job\'s imported items.

', ], ], 'AnnotationImportItemSource' => [ 'base' => '

A source for an annotation import job.

', 'refs' => [ 'AnnotationImportItemSources$member' => NULL, ], ], 'AnnotationImportItemSources' => [ 'base' => NULL, 'refs' => [ 'StartAnnotationImportRequest$items' => '

Items to import.

', ], ], 'AnnotationImportJobItem' => [ 'base' => '

An annotation import job.

', 'refs' => [ 'AnnotationImportJobItems$member' => NULL, ], ], 'AnnotationImportJobItems' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsResponse$annotationImportJobs' => '

A list of jobs.

', ], ], 'AnnotationStoreItem' => [ 'base' => '

An annotation store.

', 'refs' => [ 'AnnotationStoreItems$member' => NULL, ], ], 'AnnotationStoreItems' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresResponse$annotationStores' => '

A list of stores.

', ], ], 'AnnotationStoreVersionItem' => [ 'base' => '

Annotation store versions.

', 'refs' => [ 'AnnotationStoreVersionItems$member' => NULL, ], ], 'AnnotationStoreVersionItems' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoreVersionsResponse$annotationStoreVersions' => '

Lists all versions of an annotation store.

', ], ], 'AnnotationType' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptions$annotationType' => '

The store\'s annotation type.

', 'TsvVersionOptions$annotationType' => '

The store version\'s annotation type.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$roleArn' => '

The job\'s service role ARN.

', 'AnnotationStoreItem$storeArn' => '

The store\'s ARN.

', 'AnnotationStoreVersionItem$versionArn' => '

The Arn for an annotation store version.

', 'GetAnnotationImportResponse$roleArn' => '

The job\'s service role ARN.

', 'GetAnnotationStoreResponse$storeArn' => '

The store\'s ARN.

', 'GetAnnotationStoreVersionResponse$versionArn' => '

The Arn for the annotation store.

', 'GetVariantImportResponse$roleArn' => '

The job\'s service role ARN.

', 'GetVariantStoreResponse$storeArn' => '

The store\'s ARN.

', 'StartAnnotationImportRequest$roleArn' => '

A service role for the job.

', 'StartVariantImportRequest$roleArn' => '

A service role for the job.

', 'VariantImportJobItem$roleArn' => '

The job\'s service role ARN.

', 'VariantStoreItem$storeArn' => '

The store\'s ARN.

', ], ], 'ArnList' => [ 'base' => NULL, 'refs' => [ 'Filter$resourceArns' => '

The Amazon Resource Number (Arn) for an analytics store.

', ], ], 'BatchDeleteReadSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteReadSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$definitionZip' => '

A ZIP archive for the workflow.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'VcfOptions$ignoreQualField' => '

The file\'s ignore qual field setting.

', 'VcfOptions$ignoreFilterField' => '

The file\'s ignore filter field setting.

', 'WorkflowParameter$optional' => '

Whether the parameter is optional.

', ], ], 'CancelAnnotationImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelAnnotationImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelVariantImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelVariantImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$clientToken' => '

An idempotency token that can be used to avoid triggering multiple multipart uploads.

', 'CreateReferenceStoreRequest$clientToken' => '

To ensure that requests don\'t run multiple times, specify a unique token for each request.

', 'CreateSequenceStoreRequest$clientToken' => '

To ensure that requests don\'t run multiple times, specify a unique token for each request.

', 'StartReadSetActivationJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', 'StartReadSetExportJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', 'StartReadSetImportJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', 'StartReferenceImportJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', ], ], 'CommentChar' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$comment' => '

The file\'s comment character.

', ], ], 'CompleteMultipartReadSetUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CompleteMultipartReadSetUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'CompleteReadSetUploadPartList' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartReadSetUploadRequest$parts' => '

The individual uploads or parts of a multipart upload.

', ], ], 'CompleteReadSetUploadPartListItem' => [ 'base' => '

Part of the response to the CompleteReadSetUpload API, including metadata.

', 'refs' => [ 'CompleteReadSetUploadPartList$member' => NULL, ], ], 'CompleteReadSetUploadPartListItemChecksumString' => [ 'base' => NULL, 'refs' => [ 'CompleteReadSetUploadPartListItem$checksum' => '

A unique identifier used to confirm that parts are being added to the correct upload.

', ], ], 'CompleteReadSetUploadPartListItemPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'CompleteReadSetUploadPartListItem$partNumber' => '

A number identifying the part in a read set upload.

', ], ], 'CompletionTime' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$completionTime' => '

When the job completed.

', 'GetAnnotationImportResponse$completionTime' => '

When the job completed.

', 'GetVariantImportResponse$completionTime' => '

When the job completed.

', 'VariantImportJobItem$completionTime' => '

When the job completed.

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

The request cannot be applied to the target resource in its current state.

', 'refs' => [], ], 'CreateAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnnotationStoreVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnnotationStoreVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartReadSetUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartReadSetUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateReferenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateReferenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRunGroupRequestMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxCpus' => '

The maximum number of CPUs to use in the group.

', ], ], 'CreateRunGroupRequestMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxDuration' => '

A maximum run time for the group in minutes.

', ], ], 'CreateRunGroupRequestMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'CreateRunGroupRequestMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxRuns' => '

The maximum number of concurrent runs for the group.

', ], ], 'CreateRunGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSequenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSequenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequestStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$storageCapacity' => '

A storage capacity for the workflow in gibibytes.

', ], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$creationTime' => '

When the job was created.

', 'AnnotationStoreItem$creationTime' => '

The store\'s creation time.

', 'AnnotationStoreVersionItem$creationTime' => '

The time stamp for when an annotation store version was created.

', 'CreateAnnotationStoreResponse$creationTime' => '

When the store was created.

', 'CreateAnnotationStoreVersionResponse$creationTime' => '

The time stamp for the creation of an annotation store version.

', 'CreateVariantStoreResponse$creationTime' => '

When the store was created.

', 'GetAnnotationImportResponse$creationTime' => '

When the job was created.

', 'GetAnnotationStoreResponse$creationTime' => '

When the store was created.

', 'GetAnnotationStoreVersionResponse$creationTime' => '

The time stamp for when an annotation store version was created.

', 'GetVariantImportResponse$creationTime' => '

When the job was created.

', 'GetVariantStoreResponse$creationTime' => '

When the store was created.

', 'ShareDetails$creationTime' => '

The timestamp for when the share was created.

', 'UpdateAnnotationStoreResponse$creationTime' => '

When the store was created.

', 'UpdateAnnotationStoreVersionResponse$creationTime' => '

The time stamp for when an annotation store version was created.

', 'UpdateVariantStoreResponse$creationTime' => '

When the store was created.

', 'VariantImportJobItem$creationTime' => '

When the job was created.

', 'VariantStoreItem$creationTime' => '

When the store was created.

', ], ], 'CreationType' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$creationType' => '

The creation type of the read set.

', 'ReadSetFilter$creationType' => '

The creation type of the read set.

', 'ReadSetListItem$creationType' => '

The creation type of the read set.

', ], ], 'DeleteAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnnotationStoreVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnnotationStoreVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSequenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSequenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$description' => '

The store\'s description.

', 'AnnotationStoreVersionItem$description' => '

The description of an annotation store version.

', 'CreateAnnotationStoreRequest$description' => '

A description for the store.

', 'CreateAnnotationStoreVersionRequest$description' => '

The description of an annotation store version.

', 'CreateVariantStoreRequest$description' => '

A description for the store.

', 'GetAnnotationStoreResponse$description' => '

The store\'s description.

', 'GetAnnotationStoreVersionResponse$description' => '

The description for an annotation store version.

', 'GetVariantStoreResponse$description' => '

The store\'s description.

', 'UpdateAnnotationStoreRequest$description' => '

A description for the store.

', 'UpdateAnnotationStoreResponse$description' => '

The store\'s description.

', 'UpdateAnnotationStoreVersionRequest$description' => '

The description of an annotation store.

', 'UpdateAnnotationStoreVersionResponse$description' => '

The description of an annotation store version.

', 'UpdateVariantStoreRequest$description' => '

A description for the store.

', 'UpdateVariantStoreResponse$description' => '

The store\'s description.

', 'VariantStoreItem$description' => '

The store\'s description.

', ], ], 'ETag' => [ 'base' => '

The entity tag (ETag) is a hash of the object representing its semantic content.

', 'refs' => [ 'GetReadSetMetadataResponse$etag' => '

The entity tag (ETag) is a hash of the object meant to represent its semantic content.

', 'ReadSetListItem$etag' => '

The entity tag (ETag) is a hash of the object representing its semantic content.

', ], ], 'ETagAlgorithm' => [ 'base' => NULL, 'refs' => [ 'ETag$algorithm' => '

The algorithm used to calculate the read set’s ETag(s).

', ], ], 'ETagAlgorithmFamily' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$eTagAlgorithmFamily' => '

The ETag algorithm family to use for ingested read sets.

', 'CreateSequenceStoreResponse$eTagAlgorithmFamily' => '

The algorithm family of the ETag.

', 'GetSequenceStoreResponse$eTagAlgorithmFamily' => '

The algorithm family of the ETag.

', 'SequenceStoreDetail$eTagAlgorithmFamily' => '

The algorithm family of the ETag.

', ], ], 'Encoding' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$encoding' => '

The file\'s encoding.

', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'SseConfig$type' => '

The encryption type.

', ], ], 'EngineLogStream' => [ 'base' => NULL, 'refs' => [ 'RunLogLocation$engineLogStream' => '

The log stream ARN for the engine log.

', ], ], 'EscapeChar' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$escape' => '

A character for escaping quotes in the file.

', ], ], 'EscapeQuotes' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$escapeQuotes' => '

Whether quotes need to be escaped in the file.

', ], ], 'ExportJobId' => [ 'base' => NULL, 'refs' => [ 'ExportReadSetJobDetail$id' => '

The job\'s ID.

', 'GetReadSetExportJobRequest$id' => '

The job\'s ID.

', 'GetReadSetExportJobResponse$id' => '

The job\'s ID.

', 'StartReadSetExportJobResponse$id' => '

The job\'s ID.

', ], ], 'ExportReadSet' => [ 'base' => '

A read set.

', 'refs' => [ 'StartReadSetExportJobRequestSourcesList$member' => NULL, ], ], 'ExportReadSetDetail' => [ 'base' => '

Details about a read set.

', 'refs' => [ 'ExportReadSetDetailList$member' => NULL, ], ], 'ExportReadSetDetailList' => [ 'base' => NULL, 'refs' => [ 'GetReadSetExportJobResponse$readSets' => '

The job\'s read sets.

', ], ], 'ExportReadSetFilter' => [ 'base' => '

An read set export job filter.

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

A filter to apply to the list.

', ], ], 'ExportReadSetJobDetail' => [ 'base' => '

Details about a read set export job.

', 'refs' => [ 'ExportReadSetJobDetailList$member' => NULL, ], ], 'ExportReadSetJobDetailList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetExportJobsResponse$exportJobs' => '

A list of jobs.

', ], ], 'FileInformation' => [ 'base' => '

Details about a file.

', 'refs' => [ 'ReadSetFiles$source1' => '

The location of the first file in Amazon S3.

', 'ReadSetFiles$source2' => '

The location of the second file in Amazon S3.

', 'ReadSetFiles$index' => '

The files\' index.

', 'ReferenceFiles$source' => '

The source file\'s location in Amazon S3.

', 'ReferenceFiles$index' => '

The files\' index.

', ], ], 'FileInformationContentLengthLong' => [ 'base' => NULL, 'refs' => [ 'FileInformation$contentLength' => '

The file\'s content length.

', ], ], 'FileInformationPartSizeLong' => [ 'base' => NULL, 'refs' => [ 'FileInformation$partSize' => '

The file\'s part size.

', ], ], 'FileInformationTotalPartsInteger' => [ 'base' => NULL, 'refs' => [ 'FileInformation$totalParts' => '

The file\'s total parts.

', ], ], 'FileType' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$sourceFileType' => '

The type of file being uploaded.

', 'CreateMultipartReadSetUploadResponse$sourceFileType' => '

The file type of the read set source.

', 'GetReadSetMetadataResponse$fileType' => '

The read set\'s file type.

', 'ImportReadSetSourceItem$sourceFileType' => '

The source\'s file type.

', 'MultipartReadSetUploadListItem$sourceFileType' => '

The type of file the read set originated from.

', 'ReadSetListItem$fileType' => '

The read set\'s file type.

', 'StartReadSetImportJobSourceItem$sourceFileType' => '

The source\'s file type.

', ], ], 'Filter' => [ 'base' => '

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

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

Attributes used to filter for a specific subset of shares.

', ], ], 'FormatOptions' => [ 'base' => '

Formatting options for a file.

', 'refs' => [ 'GetAnnotationImportResponse$formatOptions' => NULL, 'StartAnnotationImportRequest$formatOptions' => '

Formatting options for the annotation file.

', ], ], 'FormatToHeader' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptions$formatToHeader' => '

The store\'s header key to column name mapping.

', 'TsvVersionOptions$formatToHeader' => '

The annotation store version\'s header key to column name mapping.

', ], ], 'FormatToHeaderKey' => [ 'base' => NULL, 'refs' => [ 'FormatToHeader$key' => NULL, ], ], 'FormatToHeaderValueString' => [ 'base' => NULL, 'refs' => [ 'FormatToHeader$value' => NULL, ], ], 'GeneratedFrom' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$generatedFrom' => '

Where the source originated.

', 'CreateMultipartReadSetUploadResponse$generatedFrom' => '

The source of the read set.

', 'ImportReadSetSourceItem$generatedFrom' => '

Where the source originated.

', 'MultipartReadSetUploadListItem$generatedFrom' => '

The source of an uploaded part.

', 'ReadSetFilter$generatedFrom' => '

Where the source originated.

', 'SequenceInformation$generatedFrom' => '

Where the sequence originated.

', 'StartReadSetImportJobSourceItem$generatedFrom' => '

Where the source originated.

', ], ], 'GetAnnotationImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetActivationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetActivationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetRequestPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'GetReadSetRequest$partNumber' => '

The part number to retrieve.

', ], ], 'GetReadSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceRequestPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'GetReferenceRequest$partNumber' => '

The part number to retrieve.

', ], ], 'GetReferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRunGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunGroupResponseMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxCpus' => '

The group\'s maximum number of CPUs to use.

', ], ], 'GetRunGroupResponseMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxDuration' => '

The group\'s maximum run time in minutes.

', ], ], 'GetRunGroupResponseMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'GetRunGroupResponseMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxRuns' => '

The maximum number of concurrent runs for the group.

', ], ], 'GetRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunResponsePriorityInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$priority' => '

The run\'s priority.

', ], ], 'GetRunResponseStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$storageCapacity' => '

The run\'s storage capacity in gigabytes.

', ], ], 'GetRunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunTaskResponseCpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$cpus' => '

The task\'s CPU usage.

', ], ], 'GetRunTaskResponseGpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$gpus' => '

The number of Graphics Processing Units (GPU) specified in the task.

', ], ], 'GetRunTaskResponseMemoryInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$memory' => '

The task\'s memory use in gigabytes.

', ], ], 'GetSequenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSequenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponseStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$storageCapacity' => '

The workflow\'s storage capacity in gigabytes.

', ], ], 'Header' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$header' => '

Whether the file has a header row.

', ], ], 'ImportJobId' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobRequest$id' => '

The job\'s ID.

', 'GetReadSetImportJobResponse$id' => '

The job\'s ID.

', 'GetReferenceImportJobRequest$id' => '

The job\'s ID.

', 'GetReferenceImportJobResponse$id' => '

The job\'s ID.

', 'ImportReadSetJobItem$id' => '

The job\'s ID.

', 'ImportReferenceJobItem$id' => '

The job\'s ID.

', 'StartReadSetImportJobResponse$id' => '

The job\'s ID.

', 'StartReferenceImportJobResponse$id' => '

The job\'s ID.

', ], ], 'ImportReadSetFilter' => [ 'base' => '

A filter for import read set jobs.

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

A filter to apply to the list.

', ], ], 'ImportReadSetJobItem' => [ 'base' => '

An import read set job.

', 'refs' => [ 'ImportReadSetJobList$member' => NULL, ], ], 'ImportReadSetJobList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetImportJobsResponse$importJobs' => '

A list of jobs.

', ], ], 'ImportReadSetSourceItem' => [ 'base' => '

A source for an import read set job.

', 'refs' => [ 'ImportReadSetSourceList$member' => NULL, ], ], 'ImportReadSetSourceList' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobResponse$sources' => '

The job\'s source files.

', ], ], 'ImportReferenceFilter' => [ 'base' => '

A filter for import references.

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

A filter to apply to the list.

', ], ], 'ImportReferenceJobItem' => [ 'base' => '

An import reference job.

', 'refs' => [ 'ImportReferenceJobList$member' => NULL, ], ], 'ImportReferenceJobList' => [ 'base' => NULL, 'refs' => [ 'ListReferenceImportJobsResponse$importJobs' => '

A lis of jobs.

', ], ], 'ImportReferenceSourceItem' => [ 'base' => '

An genome reference source.

', 'refs' => [ 'ImportReferenceSourceList$member' => NULL, ], ], 'ImportReferenceSourceList' => [ 'base' => NULL, 'refs' => [ 'GetReferenceImportJobResponse$sources' => '

The job\'s source files.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'GetAnnotationStoreResponse$numVersions' => '

An integer indicating how many versions of an annotation store exist.

', 'ListSharesRequest$maxResults' => '

The maximum number of shares to return in one page of results.

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

An unexpected error occurred. Try the request again.

', 'refs' => [], ], 'JobStatus' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportItemDetail$jobStatus' => '

The item\'s job status.

', 'AnnotationImportJobItem$status' => '

The job\'s status.

', 'GetAnnotationImportResponse$status' => '

The job\'s status.

', 'GetVariantImportResponse$status' => '

The job\'s status.

', 'ListAnnotationImportJobsFilter$status' => '

A status to filter on.

', 'ListVariantImportJobsFilter$status' => '

A status to filter on.

', 'VariantImportItemDetail$jobStatus' => '

The item\'s job status.

', 'VariantImportJobItem$status' => '

The job\'s status.

', ], ], 'JobStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetSourceItem$statusMessage' => '

The source\'s status message.

', 'ExportReadSetDetail$statusMessage' => '

The set\'s status message.

', 'GetReadSetActivationJobResponse$statusMessage' => '

The job\'s status message.

', 'GetReadSetExportJobResponse$statusMessage' => '

The job\'s status message.

', 'GetReadSetImportJobResponse$statusMessage' => '

The job\'s status message.

', 'GetReferenceImportJobResponse$statusMessage' => '

The job\'s status message.

', 'ImportReadSetSourceItem$statusMessage' => '

The source\'s status message.

', 'ImportReferenceSourceItem$statusMessage' => '

The source\'s status message.

', ], ], 'JobStatusMsg' => [ 'base' => NULL, 'refs' => [ 'GetAnnotationImportResponse$statusMessage' => '

The job\'s status message.

', 'GetVariantImportResponse$statusMessage' => '

The job\'s status message.

', 'VariantImportItemDetail$statusMessage' => '

A message that provides additional context about a job

', ], ], 'LineSep' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$lineSep' => '

A line separator for the file.

', ], ], 'ListAnnotationImportJobsFilter' => [ 'base' => '

A filter for annotation import jobs.

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

A filter to apply to the list.

', ], ], 'ListAnnotationImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationImportJobsRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequest$ids' => '

IDs of annotation import jobs to retrieve.

', ], ], 'ListAnnotationImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListAnnotationImportJobsRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequest$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListAnnotationImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoreVersionsFilter' => [ 'base' => '

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

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

A filter to apply to the list of annotation store versions.

', ], ], 'ListAnnotationStoreVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoreVersionsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoreVersionsRequest$maxResults' => '

The maximum number of annotation store versions to return in one page of results.

', ], ], 'ListAnnotationStoreVersionsRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoreVersionsRequest$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListAnnotationStoreVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoresFilter' => [ 'base' => '

A filter for annotation stores.

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

A filter to apply to the list.

', ], ], 'ListAnnotationStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoresRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresRequest$ids' => '

IDs of stores to list.

', ], ], 'ListAnnotationStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListAnnotationStoresRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListAnnotationStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartReadSetUploadsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartReadSetUploadsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListMultipartReadSetUploadsRequest$maxResults' => '

The maximum number of multipart uploads returned in a page.

', ], ], 'ListMultipartReadSetUploadsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetActivationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetActivationJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetActivationJobsRequest$maxResults' => '

The maximum number of read set activation jobs to return in one page of results.

', ], ], 'ListReadSetActivationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetExportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetExportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListReadSetExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetImportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListReadSetImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetUploadPartsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetUploadPartsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetUploadPartsRequest$maxResults' => '

The maximum number of read set upload parts returned in a page.

', ], ], 'ListReadSetUploadPartsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetsRequest$maxResults' => '

The maximum number of read sets to return in one page of results.

', ], ], 'ListReadSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReferenceImportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListReferenceImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReferenceStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListReferenceStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReferencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReferencesRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReferencesRequest$maxResults' => '

The maximum number of references to return in one page of results.

', ], ], 'ListReferencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRunGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRunGroupsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListRunGroupsRequest$maxResults' => '

The maximum number of run groups to return in one page of results.

', ], ], 'ListRunGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRunTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRunTasksRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListRunTasksRequest$maxResults' => '

The maximum number of run tasks to return in one page of results.

', ], ], 'ListRunTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRunsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListRunsRequest$maxResults' => '

The maximum number of runs to return in one page of results.

', ], ], 'ListRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSequenceStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSequenceStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListSequenceStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListSequenceStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSharesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSharesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantImportJobsFilter' => [ 'base' => '

A filter for variant import jobs.

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

A filter to apply to the list.

', ], ], 'ListVariantImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantImportJobsRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsRequest$ids' => '

A list of job IDs.

', ], ], 'ListVariantImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsRequest$maxResults' => '

The maximum number of import jobs to return in one page of results.

', ], ], 'ListVariantImportJobsRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListVariantImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantStoresFilter' => [ 'base' => '

A filter for variant stores.

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

A filter to apply to the list.

', ], ], 'ListVariantStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantStoresRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresRequest$ids' => '

A list of store IDs.

', ], ], 'ListVariantStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListVariantStoresRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListVariantStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsRequest$maxResults' => '

The maximum number of workflows to return in one page of results.

', ], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$storeSizeBytes' => '

The store\'s size in bytes.

', 'AnnotationStoreVersionItem$versionSizeBytes' => '

The size of an annotation store version in Bytes.

', 'GetAnnotationStoreResponse$storeSizeBytes' => '

The store\'s size in bytes.

', 'GetAnnotationStoreVersionResponse$versionSizeBytes' => '

The size of the annotation store version in Bytes.

', 'GetVariantStoreResponse$storeSizeBytes' => '

The store\'s size in bytes.

', 'SequenceInformation$totalReadCount' => '

The sequence\'s total read count.

', 'SequenceInformation$totalBaseCount' => '

The sequence\'s total base count.

', 'VariantStoreItem$storeSizeBytes' => '

The store\'s size in bytes.

', ], ], 'Md5' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$md5' => '

The reference\'s MD5 checksum.

', 'ReferenceFilter$md5' => '

An MD5 checksum to filter on.

', 'ReferenceListItem$md5' => '

The reference\'s MD5 checksum.

', ], ], 'MultipartReadSetUploadList' => [ 'base' => NULL, 'refs' => [ 'ListMultipartReadSetUploadsResponse$uploads' => '

An array of multipart uploads.

', ], ], 'MultipartReadSetUploadListItem' => [ 'base' => '

Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.

', 'refs' => [ 'MultipartReadSetUploadList$member' => NULL, ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListMultipartReadSetUploadsRequest$nextToken' => '

Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

', 'ListMultipartReadSetUploadsResponse$nextToken' => '

Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

', 'ListReadSetActivationJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetActivationJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReadSetExportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetExportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReadSetImportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetImportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReadSetUploadPartsRequest$nextToken' => '

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

', 'ListReadSetUploadPartsResponse$nextToken' => '

Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

', 'ListReadSetsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReferenceImportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReferenceImportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReferenceStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReferenceStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReferencesRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReferencesResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListSequenceStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListSequenceStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'NotSupportedOperationException' => [ 'base' => '

The operation is not supported by Amazon Omics, or the API does not exist.

', 'refs' => [], ], 'PrimitiveBoolean' => [ 'base' => NULL, 'refs' => [ 'DeleteAnnotationStoreRequest$force' => '

Whether to force deletion.

', 'DeleteAnnotationStoreVersionsRequest$force' => '

Forces the deletion of an annotation store version when imports are in-progress..

', 'DeleteVariantStoreRequest$force' => '

Whether to force deletion.

', ], ], 'Quote' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$quote' => '

The file\'s quote character.

', ], ], 'QuoteAll' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$quoteAll' => '

Whether all values need to be quoted, or just those that contain quotes.

', ], ], 'Range' => [ 'base' => NULL, 'refs' => [ 'GetReferenceRequest$range' => '

The range to retrieve.

', ], ], 'RangeNotSatisfiableException' => [ 'base' => '

The ranges specified in the request are not valid.

', 'refs' => [], ], 'ReadOptions' => [ 'base' => '

Read options for an annotation import job.

', 'refs' => [ 'TsvOptions$readOptions' => '

The file\'s read options.

', ], ], 'ReadSetActivationJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetSourceItem$status' => '

The source\'s status.

', ], ], 'ReadSetActivationJobStatus' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetFilter$status' => '

The filter\'s status.

', 'ActivateReadSetJobItem$status' => '

The job\'s status.

', 'GetReadSetActivationJobResponse$status' => '

The job\'s status.

', 'StartReadSetActivationJobResponse$status' => '

The job\'s status.

', ], ], 'ReadSetArn' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$arn' => '

The read set\'s ARN.

', 'ReadSetListItem$arn' => '

The read set\'s ARN.

', ], ], 'ReadSetBatchError' => [ 'base' => '

An error from a batch read set operation.

', 'refs' => [ 'ReadSetBatchErrorList$member' => NULL, ], ], 'ReadSetBatchErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteReadSetResponse$errors' => '

Errors returned by individual delete operations.

', ], ], 'ReadSetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$description' => '

The description of the read set.

', 'CreateMultipartReadSetUploadResponse$description' => '

The description of the read set.

', 'GetReadSetMetadataResponse$description' => '

The read set\'s description.

', 'ImportReadSetSourceItem$description' => '

The source\'s description.

', 'MultipartReadSetUploadListItem$description' => '

The description of a read set.

', 'ReadSetListItem$description' => '

The read set\'s description.

', 'StartReadSetImportJobSourceItem$description' => '

The source\'s description.

', ], ], 'ReadSetExportJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ExportReadSetDetail$status' => '

The set\'s status.

', ], ], 'ReadSetExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'ExportReadSetFilter$status' => '

A status to filter on.

', 'ExportReadSetJobDetail$status' => '

The job\'s status.

', 'GetReadSetExportJobResponse$status' => '

The job\'s status.

', 'StartReadSetExportJobResponse$status' => '

The job\'s status.

', ], ], 'ReadSetFile' => [ 'base' => NULL, 'refs' => [ 'GetReadSetRequest$file' => '

The file to retrieve.

', ], ], 'ReadSetFiles' => [ 'base' => '

Files in a read set.

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

The read set\'s files.

', ], ], 'ReadSetFilter' => [ 'base' => '

A filter for read sets.

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

A filter to apply to the list.

', ], ], 'ReadSetId' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetSourceItem$readSetId' => '

The source\'s read set ID.

', 'CompleteMultipartReadSetUploadResponse$readSetId' => '

The read set ID created for an uploaded read set.

', 'ExportReadSet$readSetId' => '

The set\'s ID.

', 'ExportReadSetDetail$id' => '

The set\'s ID.

', 'GetReadSetMetadataRequest$id' => '

The read set\'s ID.

', 'GetReadSetMetadataResponse$id' => '

The read set\'s ID.

', 'GetReadSetRequest$id' => '

The read set\'s ID.

', 'ReadSetBatchError$id' => '

The error\'s ID.

', 'ReadSetIdList$member' => NULL, 'ReadSetListItem$id' => '

The read set\'s ID.

', 'StartReadSetActivationJobSourceItem$readSetId' => '

The source\'s read set ID.

', ], ], 'ReadSetIdList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteReadSetRequest$ids' => '

The read sets\' IDs.

', ], ], 'ReadSetImportJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ImportReadSetSourceItem$status' => '

The source\'s status.

', ], ], 'ReadSetImportJobStatus' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobResponse$status' => '

The job\'s status.

', 'ImportReadSetFilter$status' => '

A status to filter on.

', 'ImportReadSetJobItem$status' => '

The job\'s status.

', 'StartReadSetImportJobResponse$status' => '

The job\'s status.

', ], ], 'ReadSetList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetsResponse$readSets' => '

A list of read sets.

', ], ], 'ReadSetListItem' => [ 'base' => '

A read set.

', 'refs' => [ 'ReadSetList$member' => NULL, ], ], 'ReadSetName' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$name' => '

The name of the read set.

', 'CreateMultipartReadSetUploadResponse$name' => '

The name of the read set.

', 'GetReadSetMetadataResponse$name' => '

The read set\'s name.

', 'ImportReadSetSourceItem$name' => '

The source\'s name.

', 'MultipartReadSetUploadListItem$name' => '

The name of a read set.

', 'ReadSetFilter$name' => '

A name to filter on.

', 'ReadSetListItem$name' => '

The read set\'s name.

', 'StartReadSetImportJobSourceItem$name' => '

The source\'s name.

', ], ], 'ReadSetPartSource' => [ 'base' => NULL, 'refs' => [ 'CompleteReadSetUploadPartListItem$partSource' => '

The source file of the part being uploaded.

', 'ListReadSetUploadPartsRequest$partSource' => '

The source file for the upload part.

', 'ReadSetUploadPartListItem$partSource' => '

The origin of the part being direct uploaded.

', 'UploadReadSetPartRequest$partSource' => '

The source file for an upload part.

', ], ], 'ReadSetPartStreamingBlob' => [ 'base' => NULL, 'refs' => [ 'UploadReadSetPartRequest$payload' => '

The read set data to upload for a part.

', ], ], 'ReadSetS3Access' => [ 'base' => '

The S3 URI for each read set file.

', 'refs' => [ 'FileInformation$s3Access' => '

The S3 URI metadata of a sequence store.

', ], ], 'ReadSetStatus' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$status' => '

The read set\'s status.

', 'ReadSetFilter$status' => '

A status to filter on.

', 'ReadSetListItem$status' => '

The read set\'s status.

', ], ], 'ReadSetStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$statusMessage' => '

The status message for a read set. It provides more detail as to why the read set has a status.

', 'ReadSetListItem$statusMessage' => '

The status for a read set. It provides more detail as to why the read set has a status.

', ], ], 'ReadSetStreamingBlob' => [ 'base' => NULL, 'refs' => [ 'GetReadSetResponse$payload' => '

The read set file payload.

', ], ], 'ReadSetUploadPartList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetUploadPartsResponse$parts' => '

An array of upload parts.

', ], ], 'ReadSetUploadPartListFilter' => [ 'base' => '

Filter settings that select for read set upload parts of interest.

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

Attributes used to filter for a specific subset of read set part uploads.

', ], ], 'ReadSetUploadPartListItem' => [ 'base' => '

The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.

', 'refs' => [ 'ReadSetUploadPartList$member' => NULL, ], ], 'ReadSetUploadPartListItemPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'ReadSetUploadPartListItem$partNumber' => '

The number identifying the part in an upload.

', ], ], 'ReadSetUploadPartListItemPartSizeLong' => [ 'base' => NULL, 'refs' => [ 'ReadSetUploadPartListItem$partSize' => '

The size of the the part in an upload.

', ], ], 'ReferenceArn' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$referenceArn' => '

The ARN of the reference.

', 'CreateMultipartReadSetUploadResponse$referenceArn' => '

The read set source\'s reference ARN.

', 'GetReadSetMetadataResponse$referenceArn' => '

The read set\'s genome reference ARN.

', 'GetReferenceMetadataResponse$arn' => '

The reference\'s ARN.

', 'ImportReadSetSourceItem$referenceArn' => '

The source\'s genome reference ARN.

', 'MultipartReadSetUploadListItem$referenceArn' => '

The source\'s reference ARN.

', 'ReadSetListItem$referenceArn' => '

The read set\'s genome reference ARN.

', 'ReferenceItem$referenceArn' => '

The reference\'s ARN.

', 'ReferenceListItem$arn' => '

The reference\'s ARN.

', 'StartReadSetImportJobSourceItem$referenceArn' => '

The source\'s reference ARN.

', ], ], 'ReferenceArnFilter' => [ 'base' => NULL, 'refs' => [ 'ReadSetFilter$referenceArn' => '

A genome reference ARN to filter on.

', ], ], 'ReferenceDescription' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$description' => '

The reference\'s description.

', 'ImportReferenceSourceItem$description' => '

The source\'s description.

', 'ReferenceListItem$description' => '

The reference\'s description.

', 'StartReferenceImportJobSourceItem$description' => '

The source\'s description.

', ], ], 'ReferenceFile' => [ 'base' => NULL, 'refs' => [ 'GetReferenceRequest$file' => '

The file to retrieve.

', ], ], 'ReferenceFiles' => [ 'base' => '

A set of genome reference files.

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

The reference\'s files.

', ], ], 'ReferenceFilter' => [ 'base' => '

A filter for references.

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

A filter to apply to the list.

', ], ], 'ReferenceId' => [ 'base' => NULL, 'refs' => [ 'DeleteReferenceRequest$id' => '

The reference\'s ID.

', 'GetReferenceMetadataRequest$id' => '

The reference\'s ID.

', 'GetReferenceMetadataResponse$id' => '

The reference\'s ID.

', 'GetReferenceRequest$id' => '

The reference\'s ID.

', 'ReferenceListItem$id' => '

The reference\'s ID.

', ], ], 'ReferenceImportJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ImportReferenceSourceItem$status' => '

The source\'s status.

', ], ], 'ReferenceImportJobStatus' => [ 'base' => NULL, 'refs' => [ 'GetReferenceImportJobResponse$status' => '

The job\'s status.

', 'ImportReferenceFilter$status' => '

A status to filter on.

', 'ImportReferenceJobItem$status' => '

The job\'s status.

', 'StartReferenceImportJobResponse$status' => '

The job\'s status.

', ], ], 'ReferenceItem' => [ 'base' => '

A genome reference.

', 'refs' => [ 'AnnotationStoreItem$reference' => '

The store\'s genome reference.

', 'CreateAnnotationStoreRequest$reference' => '

The genome reference for the store\'s annotations.

', 'CreateAnnotationStoreResponse$reference' => '

The store\'s genome reference. Required for all stores except TSV format with generic annotations.

', 'CreateVariantStoreRequest$reference' => '

The genome reference for the store\'s variants.

', 'CreateVariantStoreResponse$reference' => '

The store\'s genome reference.

', 'GetAnnotationStoreResponse$reference' => '

The store\'s genome reference.

', 'GetVariantStoreResponse$reference' => '

The store\'s genome reference.

', 'UpdateAnnotationStoreResponse$reference' => '

The store\'s genome reference.

', 'UpdateVariantStoreResponse$reference' => '

The store\'s genome reference.

', 'VariantStoreItem$reference' => '

The store\'s genome reference.

', ], ], 'ReferenceList' => [ 'base' => NULL, 'refs' => [ 'ListReferencesResponse$references' => '

A list of references.

', ], ], 'ReferenceListItem' => [ 'base' => '

A genome reference.

', 'refs' => [ 'ReferenceList$member' => NULL, ], ], 'ReferenceName' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$name' => '

The reference\'s name.

', 'ImportReferenceSourceItem$name' => '

The source\'s name.

', 'ReferenceFilter$name' => '

A name to filter on.

', 'ReferenceListItem$name' => '

The reference\'s name.

', 'StartReferenceImportJobSourceItem$name' => '

The source\'s name.

', ], ], 'ReferenceStatus' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$status' => '

The reference\'s status.

', 'ReferenceListItem$status' => '

The reference\'s status.

', ], ], 'ReferenceStoreArn' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreResponse$arn' => '

The store\'s ARN.

', 'GetReferenceStoreResponse$arn' => '

The store\'s ARN.

', 'ReferenceStoreDetail$arn' => '

The store\'s ARN.

', ], ], 'ReferenceStoreDescription' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreRequest$description' => '

A description for the store.

', 'CreateReferenceStoreResponse$description' => '

The store\'s description.

', 'GetReferenceStoreResponse$description' => '

The store\'s description.

', 'ReferenceStoreDetail$description' => '

The store\'s description.

', ], ], 'ReferenceStoreDetail' => [ 'base' => '

Details about a reference store.

', 'refs' => [ 'ReferenceStoreDetailList$member' => NULL, ], ], 'ReferenceStoreDetailList' => [ 'base' => NULL, 'refs' => [ 'ListReferenceStoresResponse$referenceStores' => '

A list of reference stores.

', ], ], 'ReferenceStoreFilter' => [ 'base' => '

A filter for reference stores.

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

A filter to apply to the list.

', ], ], 'ReferenceStoreId' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreResponse$id' => '

The store\'s ID.

', 'DeleteReferenceRequest$referenceStoreId' => '

The reference\'s store ID.

', 'DeleteReferenceStoreRequest$id' => '

The store\'s ID.

', 'GetReferenceImportJobRequest$referenceStoreId' => '

The job\'s reference store ID.

', 'GetReferenceImportJobResponse$referenceStoreId' => '

The job\'s reference store ID.

', 'GetReferenceMetadataRequest$referenceStoreId' => '

The reference\'s reference store ID.

', 'GetReferenceMetadataResponse$referenceStoreId' => '

The reference\'s reference store ID.

', 'GetReferenceRequest$referenceStoreId' => '

The reference\'s store ID.

', 'GetReferenceStoreRequest$id' => '

The store\'s ID.

', 'GetReferenceStoreResponse$id' => '

The store\'s ID.

', 'ImportReferenceJobItem$referenceStoreId' => '

The job\'s reference store ID.

', 'ListReferenceImportJobsRequest$referenceStoreId' => '

The job\'s reference store ID.

', 'ListReferencesRequest$referenceStoreId' => '

The references\' reference store ID.

', 'ReferenceListItem$referenceStoreId' => '

The reference\'s store ID.

', 'ReferenceStoreDetail$id' => '

The store\'s ID.

', 'StartReferenceImportJobRequest$referenceStoreId' => '

The job\'s reference store ID.

', 'StartReferenceImportJobResponse$referenceStoreId' => '

The job\'s reference store ID.

', ], ], 'ReferenceStoreName' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreRequest$name' => '

A name for the store.

', 'CreateReferenceStoreResponse$name' => '

The store\'s name.

', 'GetReferenceStoreResponse$name' => '

The store\'s name.

', 'ReferenceStoreDetail$name' => '

The store\'s name.

', 'ReferenceStoreFilter$name' => '

The name to filter on.

', ], ], 'ReferenceStreamingBlob' => [ 'base' => NULL, 'refs' => [ 'GetReferenceResponse$payload' => '

The reference file payload.

', ], ], 'RequestTimeoutException' => [ 'base' => '

The request timed out.

', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$id' => '

The store\'s ID.

', 'AnnotationStoreVersionItem$storeId' => '

The store ID for an annotation store version.

', 'AnnotationStoreVersionItem$id' => '

The annotation store version ID.

', 'CancelAnnotationImportRequest$jobId' => '

The job\'s ID.

', 'CancelVariantImportRequest$jobId' => '

The job\'s ID.

', 'CreateAnnotationStoreResponse$id' => '

The store\'s ID.

', 'CreateAnnotationStoreVersionResponse$id' => '

A generated ID for the annotation store

', 'CreateAnnotationStoreVersionResponse$storeId' => '

The ID for the annotation store from which new versions are being created.

', 'CreateVariantStoreResponse$id' => '

The store\'s ID.

', 'GetAnnotationImportRequest$jobId' => '

The job\'s ID.

', 'GetAnnotationImportResponse$id' => '

The job\'s ID.

', 'GetAnnotationStoreResponse$id' => '

The store\'s ID.

', 'GetAnnotationStoreVersionResponse$storeId' => '

The store ID for annotation store version.

', 'GetAnnotationStoreVersionResponse$id' => '

The annotation store version ID.

', 'GetVariantImportRequest$jobId' => '

The job\'s ID.

', 'GetVariantImportResponse$id' => '

The job\'s ID.

', 'GetVariantStoreResponse$id' => '

The store\'s ID.

', 'StartAnnotationImportResponse$jobId' => '

The job\'s ID.

', 'StartVariantImportResponse$jobId' => '

The job\'s ID.

', 'UpdateAnnotationStoreResponse$id' => '

The store\'s ID.

', 'UpdateAnnotationStoreVersionResponse$storeId' => '

The annotation store ID.

', 'UpdateAnnotationStoreVersionResponse$id' => '

The annotation store version ID.

', 'UpdateVariantStoreResponse$id' => '

The store\'s ID.

', 'VariantStoreItem$id' => '

The store\'s ID.

', ], ], 'ResourceIdentifier' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequestIdsList$member' => NULL, 'ListAnnotationStoresRequestIdsList$member' => NULL, 'ListVariantImportJobsRequestIdsList$member' => NULL, 'ListVariantStoresRequestIdsList$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => '

The target resource was not found in the current Region.

', 'refs' => [], ], 'ResourceOwner' => [ 'base' => NULL, 'refs' => [ 'ListSharesRequest$resourceOwner' => '

The account that owns the analytics store shared.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobResponse$roleArn' => '

The job\'s service role ARN.

', 'GetReferenceImportJobResponse$roleArn' => '

The job\'s service role ARN.

', 'ImportReadSetJobItem$roleArn' => '

The job\'s service role ARN.

', 'ImportReferenceJobItem$roleArn' => '

The job\'s service role ARN.

', 'StartReadSetExportJobRequest$roleArn' => '

A service role for the job.

', 'StartReadSetImportJobRequest$roleArn' => '

A service role for the job.

', 'StartReadSetImportJobResponse$roleArn' => '

The job\'s service role ARN.

', 'StartReferenceImportJobRequest$roleArn' => '

A service role for the job.

', 'StartReferenceImportJobResponse$roleArn' => '

The job\'s service role ARN.

', ], ], 'RunArn' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$arn' => '

The run\'s ARN.

', 'RunListItem$arn' => '

The run\'s ARN.

', 'StartRunResponse$arn' => '

The run\'s ARN.

', ], ], 'RunExport' => [ 'base' => NULL, 'refs' => [ 'RunExportList$member' => NULL, ], ], 'RunExportList' => [ 'base' => NULL, 'refs' => [ 'GetRunRequest$export' => '

The run\'s export format.

', ], ], 'RunFailureReason' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$failureReason' => '

The reason a run has failed.

', ], ], 'RunGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupResponse$arn' => '

The group\'s ARN.

', 'GetRunGroupResponse$arn' => '

The group\'s ARN.

', 'RunGroupListItem$arn' => '

The group\'s ARN.

', ], ], 'RunGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupResponse$id' => '

The group\'s ID.

', 'DeleteRunGroupRequest$id' => '

The run group\'s ID.

', 'GetRunGroupRequest$id' => '

The group\'s ID.

', 'GetRunGroupResponse$id' => '

The group\'s ID.

', 'GetRunResponse$runGroupId' => '

The run\'s group ID.

', 'ListRunsRequest$runGroupId' => '

Filter the list by run group ID.

', 'RunGroupListItem$id' => '

The group\'s ID.

', 'StartRunRequest$runGroupId' => '

The run\'s group ID.

', 'UpdateRunGroupRequest$id' => '

The group\'s ID.

', ], ], 'RunGroupList' => [ 'base' => NULL, 'refs' => [ 'ListRunGroupsResponse$items' => '

A list of groups.

', ], ], 'RunGroupListItem' => [ 'base' => '

A run group.

', 'refs' => [ 'RunGroupList$member' => NULL, ], ], 'RunGroupListItemMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxCpus' => '

The group\'s maximum CPU count setting.

', ], ], 'RunGroupListItemMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxDuration' => '

The group\'s maximum duration setting in minutes.

', ], ], 'RunGroupListItemMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'RunGroupListItemMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxRuns' => '

The group\'s maximum concurrent run setting.

', ], ], 'RunGroupListToken' => [ 'base' => NULL, 'refs' => [ 'ListRunGroupsRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRunGroupsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'RunGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$name' => '

A name for the group.

', 'GetRunGroupResponse$name' => '

The group\'s name.

', 'ListRunGroupsRequest$name' => '

The run groups\' name.

', 'RunGroupListItem$name' => '

The group\'s name.

', 'UpdateRunGroupRequest$name' => '

A name for the group.

', ], ], 'RunGroupRequestId' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$requestId' => '

To ensure that requests don\'t run multiple times, specify a unique ID for each request.

', ], ], 'RunGroupTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$creationTime' => '

When the group was created.

', 'RunGroupListItem$creationTime' => '

When the group was created.

', ], ], 'RunId' => [ 'base' => NULL, 'refs' => [ 'CancelRunRequest$id' => '

The run\'s ID.

', 'DeleteRunRequest$id' => '

The run\'s ID.

', 'GetRunRequest$id' => '

The run\'s ID.

', 'GetRunResponse$id' => '

The run\'s ID.

', 'GetRunResponse$runId' => '

The run\'s ID.

', 'GetRunTaskRequest$id' => '

The workflow run ID.

', 'ListRunTasksRequest$id' => '

The run\'s ID.

', 'RunListItem$id' => '

The run\'s ID.

', 'StartRunRequest$runId' => '

The ID of a run to duplicate.

', 'StartRunResponse$id' => '

The run\'s ID.

', ], ], 'RunLeftNormalization' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$runLeftNormalization' => '

The job\'s left normalization setting.

', 'GetAnnotationImportResponse$runLeftNormalization' => '

The job\'s left normalization setting.

', 'GetVariantImportResponse$runLeftNormalization' => '

The job\'s left normalization setting.

', 'StartAnnotationImportRequest$runLeftNormalization' => '

The job\'s left normalization setting.

', 'StartVariantImportRequest$runLeftNormalization' => '

The job\'s left normalization setting.

', 'VariantImportJobItem$runLeftNormalization' => '

The job\'s left normalization setting.

', ], ], 'RunList' => [ 'base' => NULL, 'refs' => [ 'ListRunsResponse$items' => '

A list of runs.

', ], ], 'RunListItem' => [ 'base' => '

A workflow run.

', 'refs' => [ 'RunList$member' => NULL, ], ], 'RunListItemPriorityInteger' => [ 'base' => NULL, 'refs' => [ 'RunListItem$priority' => '

The run\'s priority.

', ], ], 'RunListItemStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'RunListItem$storageCapacity' => '

The run\'s storage capacity.

', ], ], 'RunListToken' => [ 'base' => NULL, 'refs' => [ 'ListRunsRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRunsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'RunLogLevel' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$logLevel' => '

The run\'s log level.

', 'StartRunRequest$logLevel' => '

A log level for the run.

', ], ], 'RunLogLocation' => [ 'base' => '

The URI for the run log.

', 'refs' => [ 'GetRunResponse$logLocation' => '

The location of the run log.

', ], ], 'RunLogStream' => [ 'base' => NULL, 'refs' => [ 'RunLogLocation$runLogStream' => '

The log stream ARN for the run log.

', ], ], 'RunName' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$name' => '

The run\'s name.

', 'ListRunsRequest$name' => '

Filter the list by run name.

', 'RunListItem$name' => '

The run\'s name.

', 'StartRunRequest$name' => '

A name for the run.

', ], ], 'RunOutputUri' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$outputUri' => '

The run\'s output URI.

', 'GetRunResponse$runOutputUri' => '

The destination for workflow outputs.

', 'StartRunRequest$outputUri' => '

An output URI for the run.

', 'StartRunResponse$runOutputUri' => '

The destination for workflow outputs.

', ], ], 'RunParameters' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$parameters' => '

The run\'s parameters.

', 'StartRunRequest$parameters' => '

Parameters for the run.

', ], ], 'RunRequestId' => [ 'base' => NULL, 'refs' => [ 'StartRunRequest$requestId' => '

To ensure that requests don\'t run multiple times, specify a unique ID for each request.

', ], ], 'RunResourceDigest' => [ 'base' => NULL, 'refs' => [ 'RunResourceDigests$value' => NULL, ], ], 'RunResourceDigestKey' => [ 'base' => NULL, 'refs' => [ 'RunResourceDigests$key' => NULL, ], ], 'RunResourceDigests' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$resourceDigests' => '

The run\'s resource digests.

', ], ], 'RunRetentionMode' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$retentionMode' => '

The run\'s retention mode.

', 'StartRunRequest$retentionMode' => '

The retention mode for the run.

', ], ], 'RunRoleArn' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$roleArn' => '

The run\'s service role ARN.

', 'StartRunRequest$roleArn' => '

A service role for the run.

', ], ], 'RunStartedBy' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$startedBy' => '

Who started the run.

', ], ], 'RunStatus' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$status' => '

The run\'s status.

', 'ListRunsRequest$status' => '

The status of a run.

', 'RunListItem$status' => '

The run\'s status.

', 'StartRunResponse$status' => '

The run\'s status.

', ], ], 'RunStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$statusMessage' => '

The run\'s status message.

', ], ], 'RunTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$creationTime' => '

When the run was created.

', 'GetRunResponse$startTime' => '

When the run started.

', 'GetRunResponse$stopTime' => '

The run\'s stop time.

', 'RunListItem$creationTime' => '

When the run was created.

', 'RunListItem$startTime' => '

When the run started.

', 'RunListItem$stopTime' => '

When the run stopped.

', ], ], 'RunUuid' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$uuid' => '

The universally unique identifier for a run.

', 'StartRunResponse$uuid' => '

The universally unique identifier for a run.

', ], ], 'S3AccessPointArn' => [ 'base' => NULL, 'refs' => [ 'SequenceStoreS3Access$s3AccessPointArn' => '

This is ARN of the access point associated with the S3 bucket storing read sets.

', ], ], 'S3Destination' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'CreateSequenceStoreResponse$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'ExportReadSetJobDetail$destination' => '

The job\'s destination in Amazon S3.

', 'GetReadSetExportJobResponse$destination' => '

The job\'s destination in Amazon S3.

', 'GetSequenceStoreResponse$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'SequenceStoreDetail$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'StartReadSetExportJobRequest$destination' => '

A location for exported files in Amazon S3.

', 'StartReadSetExportJobResponse$destination' => '

The job\'s output location.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportItemDetail$source' => '

The source file\'s location in Amazon S3.

', 'AnnotationImportItemSource$source' => '

The source file\'s location in Amazon S3.

', 'ImportReferenceSourceItem$sourceFile' => '

The source file\'s location in Amazon S3.

', 'ReadSetS3Access$s3Uri' => '

The S3 URI for each read set file.

', 'SequenceStoreS3Access$s3Uri' => '

The S3 URI of the sequence store.

', 'SourceFiles$source1' => '

The location of the first file in Amazon S3.

', 'SourceFiles$source2' => '

The location of the second file in Amazon S3.

', 'StartReferenceImportJobSourceItem$sourceFile' => '

The source file\'s location in Amazon S3.

', 'VariantImportItemDetail$source' => '

The source file\'s location in Amazon S3.

', 'VariantImportItemSource$source' => '

The source file\'s location in Amazon S3.

', ], ], 'SampleId' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$sampleId' => '

The source\'s sample ID.

', 'CreateMultipartReadSetUploadResponse$sampleId' => '

The source\'s sample ID.

', 'GetReadSetMetadataResponse$sampleId' => '

The read set\'s sample ID.

', 'ImportReadSetSourceItem$sampleId' => '

The source\'s sample ID.

', 'MultipartReadSetUploadListItem$sampleId' => '

The read set source\'s sample ID.

', 'ReadSetFilter$sampleId' => '

The read set source\'s sample ID.

', 'ReadSetListItem$sampleId' => '

The read set\'s sample ID.

', 'StartReadSetImportJobSourceItem$sampleId' => '

The source\'s sample ID.

', ], ], 'SchemaItem' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptionsSchemaList$member' => NULL, 'TsvVersionOptionsSchemaList$member' => NULL, ], ], 'SchemaItemKeyString' => [ 'base' => NULL, 'refs' => [ 'SchemaItem$key' => NULL, ], ], 'SchemaValueType' => [ 'base' => NULL, 'refs' => [ 'SchemaItem$value' => NULL, ], ], 'Separator' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$sep' => '

The file\'s field separator.

', ], ], 'SequenceInformation' => [ 'base' => '

Details about a sequence.

', 'refs' => [ 'GetReadSetMetadataResponse$sequenceInformation' => '

The read set\'s sequence information.

', 'ReadSetListItem$sequenceInformation' => NULL, ], ], 'SequenceStoreArn' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreResponse$arn' => '

The store\'s ARN.

', 'GetSequenceStoreResponse$arn' => '

The store\'s ARN.

', 'SequenceStoreDetail$arn' => '

The store\'s ARN.

', ], ], 'SequenceStoreDescription' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$description' => '

A description for the store.

', 'CreateSequenceStoreResponse$description' => '

The store\'s description.

', 'GetSequenceStoreResponse$description' => '

The store\'s description.

', 'SequenceStoreDetail$description' => '

The store\'s description.

', ], ], 'SequenceStoreDetail' => [ 'base' => '

Details about a sequence store.

', 'refs' => [ 'SequenceStoreDetailList$member' => NULL, ], ], 'SequenceStoreDetailList' => [ 'base' => NULL, 'refs' => [ 'ListSequenceStoresResponse$sequenceStores' => '

A list of sequence stores.

', ], ], 'SequenceStoreFilter' => [ 'base' => '

A filter for a sequence store.

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

A filter to apply to the list.

', ], ], 'SequenceStoreId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartReadSetUploadRequest$sequenceStoreId' => '

The sequence store ID for the store involved in the multipart upload.

', 'ActivateReadSetJobItem$sequenceStoreId' => '

The job\'s sequence store ID.

', 'BatchDeleteReadSetRequest$sequenceStoreId' => '

The read sets\' sequence store ID.

', 'CompleteMultipartReadSetUploadRequest$sequenceStoreId' => '

The sequence store ID for the store involved in the multipart upload.

', 'CreateMultipartReadSetUploadRequest$sequenceStoreId' => '

The sequence store ID for the store that is the destination of the multipart uploads.

', 'CreateMultipartReadSetUploadResponse$sequenceStoreId' => '

The sequence store ID for the store that the read set will be created in.

', 'CreateSequenceStoreResponse$id' => '

The store\'s ID.

', 'DeleteSequenceStoreRequest$id' => '

The sequence store\'s ID.

', 'ExportReadSetJobDetail$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetActivationJobRequest$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetActivationJobResponse$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetExportJobRequest$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetExportJobResponse$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetImportJobRequest$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetImportJobResponse$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetMetadataRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'GetReadSetMetadataResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'GetReadSetRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'GetSequenceStoreRequest$id' => '

The store\'s ID.

', 'GetSequenceStoreResponse$id' => '

The store\'s ID.

', 'ImportReadSetJobItem$sequenceStoreId' => '

The job\'s sequence store ID.

', 'ListMultipartReadSetUploadsRequest$sequenceStoreId' => '

The Sequence Store ID used for the multipart uploads.

', 'ListReadSetActivationJobsRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'ListReadSetExportJobsRequest$sequenceStoreId' => '

The jobs\' sequence store ID.

', 'ListReadSetImportJobsRequest$sequenceStoreId' => '

The jobs\' sequence store ID.

', 'ListReadSetUploadPartsRequest$sequenceStoreId' => '

The Sequence Store ID used for the multipart uploads.

', 'ListReadSetsRequest$sequenceStoreId' => '

The jobs\' sequence store ID.

', 'MultipartReadSetUploadListItem$sequenceStoreId' => '

The sequence store ID used for the multipart upload.

', 'ReadSetListItem$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'SequenceStoreDetail$id' => '

The store\'s ID.

', 'StartReadSetActivationJobRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetActivationJobResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetExportJobRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetExportJobResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetImportJobRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetImportJobResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'UploadReadSetPartRequest$sequenceStoreId' => '

The Sequence Store ID used for the multipart upload.

', ], ], 'SequenceStoreName' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$name' => '

A name for the store.

', 'CreateSequenceStoreResponse$name' => '

The store\'s name.

', 'GetSequenceStoreResponse$name' => '

The store\'s name.

', 'SequenceStoreDetail$name' => '

The store\'s name.

', 'SequenceStoreFilter$name' => '

A name to filter on.

', ], ], 'SequenceStoreS3Access' => [ 'base' => '

The S3 access metadata of the sequence store.

', 'refs' => [ 'GetSequenceStoreResponse$s3Access' => '

The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.

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

The request exceeds a service quota.

', 'refs' => [], ], 'ShareDetails' => [ 'base' => '

The details of a share.

', 'refs' => [ 'GetShareResponse$share' => '

An analytic store share details object. contains status, resourceArn, ownerId, etc.

', 'ShareDetailsList$member' => NULL, ], ], 'ShareDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListSharesResponse$shares' => '

The shares available and their meta details.

', ], ], 'ShareName' => [ 'base' => NULL, 'refs' => [ 'CreateShareRequest$shareName' => '

A name given to the share.

', 'CreateShareResponse$shareName' => '

A name given to the share.

', 'ShareDetails$shareName' => '

The name of the share.

', ], ], 'ShareStatus' => [ 'base' => NULL, 'refs' => [ 'AcceptShareResponse$status' => '

The status of an analytics store share.

', 'CreateShareResponse$status' => '

The status of a share.

', 'DeleteShareResponse$status' => '

The status of the share being deleted.

', 'ShareDetails$status' => '

The status of a share.

', 'StatusList$member' => NULL, ], ], 'SourceFiles' => [ 'base' => '

Source files for a sequence.

', 'refs' => [ 'ImportReadSetSourceItem$sourceFiles' => '

The source files\' location in Amazon S3.

', 'StartReadSetImportJobSourceItem$sourceFiles' => '

The source files\' location in Amazon S3.

', ], ], 'SseConfig' => [ 'base' => '

Server-side encryption (SSE) settings for a store.

', 'refs' => [ 'AnnotationStoreItem$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'CreateAnnotationStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'CreateReferenceStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'CreateReferenceStoreResponse$sseConfig' => '

The store\'s SSE settings.

', 'CreateSequenceStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'CreateSequenceStoreResponse$sseConfig' => '

The store\'s SSE settings.

', 'CreateVariantStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'GetAnnotationStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'GetReferenceStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'GetSequenceStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'GetVariantStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'ReferenceStoreDetail$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'SequenceStoreDetail$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'VariantStoreItem$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', ], ], 'SseConfigKeyArnString' => [ 'base' => NULL, 'refs' => [ 'SseConfig$keyArn' => '

An encryption key ARN.

', ], ], 'StartAnnotationImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAnnotationImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetActivationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetActivationJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReadSetActivationJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReadSetActivationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetActivationJobSourceItem' => [ 'base' => '

A source for a read set activation job.

', 'refs' => [ 'StartReadSetActivationJobRequestSourcesList$member' => NULL, ], ], 'StartReadSetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetExportJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReadSetExportJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReadSetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetImportJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReadSetImportJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReadSetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetImportJobSourceItem' => [ 'base' => '

A source for a read set import job.

', 'refs' => [ 'StartReadSetImportJobRequestSourcesList$member' => NULL, ], ], 'StartReferenceImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReferenceImportJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReferenceImportJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReferenceImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReferenceImportJobSourceItem' => [ 'base' => '

A source for a reference import job.

', 'refs' => [ 'StartReferenceImportJobRequestSourcesList$member' => NULL, ], ], 'StartRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRunRequestPriorityInteger' => [ 'base' => NULL, 'refs' => [ 'StartRunRequest$priority' => '

A priority for the run.

', ], ], 'StartRunRequestStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'StartRunRequest$storageCapacity' => '

A storage capacity for the run in gibibytes.

', ], ], 'StartRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartVariantImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartVariantImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusList' => [ 'base' => NULL, 'refs' => [ 'Filter$status' => '

The status of an annotation store version.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$statusMessage' => '

The store\'s status message.

', 'AnnotationStoreVersionItem$statusMessage' => '

The status of an annotation store version.

', 'GetAnnotationStoreResponse$statusMessage' => '

A status message.

', 'GetAnnotationStoreVersionResponse$statusMessage' => '

The status of an annotation store version.

', 'GetVariantStoreResponse$statusMessage' => '

The store\'s status message.

', 'ShareDetails$statusMessage' => '

The status message for a share. It provides more details on the status of the share.

', 'VariantStoreItem$statusMessage' => '

The store\'s status message.

', ], ], 'StoreFormat' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$storeFormat' => '

The store\'s file format.

', 'CreateAnnotationStoreRequest$storeFormat' => '

The annotation file format of the store.

', 'CreateAnnotationStoreResponse$storeFormat' => '

The annotation file format of the store.

', 'GetAnnotationStoreResponse$storeFormat' => '

The store\'s annotation file format.

', 'UpdateAnnotationStoreResponse$storeFormat' => '

The annotation file format of the store.

', ], ], 'StoreName' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreVersionItem$name' => '

A name given to an annotation store version to distinguish it from others.

', 'CreateAnnotationStoreRequest$name' => '

A name for the store.

', 'CreateAnnotationStoreVersionRequest$name' => '

The name of an annotation store version from which versions are being created.

', 'CreateAnnotationStoreVersionResponse$name' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateVariantStoreRequest$name' => '

A name for the store.

', 'GetAnnotationImportResponse$destinationName' => '

The job\'s destination annotation store.

', 'GetAnnotationStoreVersionResponse$name' => '

The name of the annotation store.

', 'GetVariantImportResponse$destinationName' => '

The job\'s destination variant store.

', 'StartAnnotationImportRequest$destinationName' => '

A destination annotation store for the job.

', 'StartVariantImportRequest$destinationName' => '

The destination variant store for the job.

', 'UpdateAnnotationStoreVersionResponse$name' => '

The name of an annotation store.

', ], ], 'StoreOptions' => [ 'base' => '

Settings for a store.

', 'refs' => [ 'CreateAnnotationStoreRequest$storeOptions' => '

File parsing options for the annotation store.

', 'CreateAnnotationStoreResponse$storeOptions' => '

The store\'s file parsing options.

', 'GetAnnotationStoreResponse$storeOptions' => '

The store\'s parsing options.

', 'UpdateAnnotationStoreResponse$storeOptions' => '

Parsing options for the store.

', ], ], 'StoreStatus' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$status' => '

The store\'s status.

', 'CreateAnnotationStoreResponse$status' => '

The store\'s status.

', 'CreateVariantStoreResponse$status' => '

The store\'s status.

', 'DeleteAnnotationStoreResponse$status' => '

The store\'s status.

', 'DeleteVariantStoreResponse$status' => '

The store\'s status.

', 'GetAnnotationStoreResponse$status' => '

The store\'s status.

', 'GetVariantStoreResponse$status' => '

The store\'s status.

', 'ListAnnotationStoresFilter$status' => '

A status to filter on.

', 'ListVariantStoresFilter$status' => '

A status to filter on.

', 'UpdateAnnotationStoreResponse$status' => '

The store\'s status.

', 'UpdateVariantStoreResponse$status' => '

The store\'s status.

', 'VariantStoreItem$status' => '

The store\'s status.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AcceptShareRequest$shareId' => '

The ID for a share offer for analytics store data.

', 'AccessDeniedException$message' => NULL, 'AnnotationImportJobItem$id' => '

The job\'s ID.

', 'AnnotationImportJobItem$destinationName' => '

The job\'s destination annotation store.

', 'AnnotationStoreItem$name' => '

The store\'s name.

', 'ArnList$member' => NULL, 'ConflictException$message' => NULL, 'CreateAnnotationStoreResponse$name' => '

The store\'s name.

', 'CreateShareRequest$resourceArn' => '

The resource ARN for the analytics store to be shared.

', 'CreateShareRequest$principalSubscriber' => '

The principal subscriber is the account being given access to the analytics store data through the share offer.

', 'CreateShareResponse$shareId' => '

An ID generated for the share.

', 'CreateVariantStoreResponse$name' => '

The store\'s name.

', 'DeleteAnnotationStoreRequest$name' => '

The store\'s name.

', 'DeleteAnnotationStoreVersionsRequest$name' => '

The name of the annotation store from which versions are being deleted.

', 'DeleteShareRequest$shareId' => '

The ID for the share request to be deleted.

', 'DeleteVariantStoreRequest$name' => '

The store\'s name.

', 'ETag$source1' => '

The ETag hash calculated on Source1 of the read set.

', 'ETag$source2' => '

The ETag hash calculated on Source2 of the read set.

', 'GetAnnotationStoreRequest$name' => '

The store\'s name.

', 'GetAnnotationStoreResponse$name' => '

The store\'s name.

', 'GetAnnotationStoreVersionRequest$name' => '

The name given to an annotation store version to distinguish it from others.

', 'GetAnnotationStoreVersionRequest$versionName' => '

The name given to an annotation store version to distinguish it from others.

', 'GetShareRequest$shareId' => '

The generated ID for a share.

', 'GetVariantStoreRequest$name' => '

The store\'s name.

', 'GetVariantStoreResponse$name' => '

The store\'s name.

', 'InternalServerException$message' => NULL, 'ListAnnotationImportJobsFilter$storeName' => '

A store name to filter on.

', 'ListAnnotationImportJobsResponse$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', 'ListAnnotationStoreVersionsRequest$name' => '

The name of an annotation store.

', 'ListAnnotationStoreVersionsResponse$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', 'ListAnnotationStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListSharesRequest$nextToken' => '

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

', 'ListSharesResponse$nextToken' => '

Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

', 'ListVariantImportJobsFilter$storeName' => '

A store name to filter on.

', 'ListVariantImportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListVariantStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'NotSupportedOperationException$message' => NULL, 'RangeNotSatisfiableException$message' => NULL, 'ReadSetBatchError$code' => '

The error\'s code.

', 'ReadSetBatchError$message' => '

The error\'s message.

', 'ReadSetUploadPartListItem$checksum' => '

A unique identifier used to confirm that parts are being added to the correct upload.

', 'RequestTimeoutException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'SequenceInformation$alignment' => '

The sequence\'s alignment setting.

', 'ServiceQuotaExceededException$message' => NULL, 'ShareDetails$shareId' => '

The ID for a share offer for an analytics store .

', 'ShareDetails$resourceArn' => '

The resource Arn of the analytics store being shared.

', 'ShareDetails$principalSubscriber' => '

The principal subscriber is the account the analytics store data is being shared with.

', 'ShareDetails$ownerId' => '

The account ID for the data owner. The owner creates the share offer.

', 'ThrottlingException$message' => NULL, 'UpdateAnnotationStoreRequest$name' => '

A name for the store.

', 'UpdateAnnotationStoreResponse$name' => '

The store\'s name.

', 'UpdateAnnotationStoreVersionRequest$name' => '

The name of an annotation store.

', 'UpdateAnnotationStoreVersionRequest$versionName' => '

The name of an annotation store version.

', 'UpdateVariantStoreRequest$name' => '

A name for the store.

', 'UpdateVariantStoreResponse$name' => '

The store\'s name.

', 'UploadReadSetPartResponse$checksum' => '

An identifier used to confirm that parts are being added to the intended upload.

', 'ValidationException$message' => NULL, 'VariantImportJobItem$id' => '

The job\'s ID.

', 'VariantImportJobItem$destinationName' => '

The job\'s destination variant store.

', 'VariantStoreItem$name' => '

The store\'s name.

', 'VersionDeleteError$message' => '

The message explaining the error in annotation store deletion.

', ], ], 'SubjectId' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$subjectId' => '

The source\'s subject ID.

', 'CreateMultipartReadSetUploadResponse$subjectId' => '

The source\'s subject ID.

', 'GetReadSetMetadataResponse$subjectId' => '

The read set\'s subject ID.

', 'ImportReadSetSourceItem$subjectId' => '

The source\'s subject ID.

', 'MultipartReadSetUploadListItem$subjectId' => '

The read set source\'s subject ID.

', 'ReadSetFilter$subjectId' => '

The read set source\'s subject ID.

', 'ReadSetListItem$subjectId' => '

The read set\'s subject ID.

', 'StartReadSetImportJobSourceItem$subjectId' => '

The source\'s subject ID.

', ], ], 'SyntheticTimestamp_date_time' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ActivateReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ActivateReadSetJobItem$creationTime' => '

When the job was created.

', 'ActivateReadSetJobItem$completionTime' => '

When the job completed.

', 'CreateMultipartReadSetUploadResponse$creationTime' => '

The creation time of the multipart upload.

', 'CreateReferenceStoreResponse$creationTime' => '

When the store was created.

', 'CreateSequenceStoreResponse$creationTime' => '

When the store was created.

', 'ExportReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ExportReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ExportReadSetJobDetail$creationTime' => '

When the job was created.

', 'ExportReadSetJobDetail$completionTime' => '

When the job completed.

', 'GetReadSetActivationJobResponse$creationTime' => '

When the job was created.

', 'GetReadSetActivationJobResponse$completionTime' => '

When the job completed.

', 'GetReadSetExportJobResponse$creationTime' => '

When the job was created.

', 'GetReadSetExportJobResponse$completionTime' => '

When the job completed.

', 'GetReadSetImportJobResponse$creationTime' => '

When the job was created.

', 'GetReadSetImportJobResponse$completionTime' => '

When the job completed.

', 'GetReadSetMetadataResponse$creationTime' => '

When the read set was created.

', 'GetReferenceImportJobResponse$creationTime' => '

When the job was created.

', 'GetReferenceImportJobResponse$completionTime' => '

When the job completed.

', 'GetReferenceMetadataResponse$creationTime' => '

When the reference was created.

', 'GetReferenceMetadataResponse$updateTime' => '

When the reference was updated.

', 'GetReferenceStoreResponse$creationTime' => '

When the store was created.

', 'GetSequenceStoreResponse$creationTime' => '

When the store was created.

', 'ImportReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ImportReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ImportReadSetJobItem$creationTime' => '

When the job was created.

', 'ImportReadSetJobItem$completionTime' => '

When the job completed.

', 'ImportReferenceFilter$createdAfter' => '

The filter\'s start date.

', 'ImportReferenceFilter$createdBefore' => '

The filter\'s end date.

', 'ImportReferenceJobItem$creationTime' => '

When the job was created.

', 'ImportReferenceJobItem$completionTime' => '

When the job completed.

', 'MultipartReadSetUploadListItem$creationTime' => '

The time stamp for when a direct upload was created.

', 'ReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ReadSetListItem$creationTime' => '

When the read set was created.

', 'ReadSetUploadPartListFilter$createdAfter' => '

Filters for read set uploads after a specified time.

', 'ReadSetUploadPartListFilter$createdBefore' => '

Filters for read set part uploads before a specified time.

', 'ReadSetUploadPartListItem$creationTime' => '

The time stamp for when a direct upload was created.

', 'ReadSetUploadPartListItem$lastUpdatedTime' => '

The time stamp for the most recent update to an uploaded part.

', 'ReferenceFilter$createdAfter' => '

The filter\'s start date.

', 'ReferenceFilter$createdBefore' => '

The filter\'s end date.

', 'ReferenceListItem$creationTime' => '

When the reference was created.

', 'ReferenceListItem$updateTime' => '

When the reference was updated.

', 'ReferenceStoreDetail$creationTime' => '

When the store was created.

', 'ReferenceStoreFilter$createdAfter' => '

The filter\'s start date.

', 'ReferenceStoreFilter$createdBefore' => '

The filter\'s end date.

', 'SequenceStoreDetail$creationTime' => '

When the store was created.

', 'SequenceStoreFilter$createdAfter' => '

The filter\'s start date.

', 'SequenceStoreFilter$createdBefore' => '

The filter\'s end date.

', 'StartReadSetActivationJobResponse$creationTime' => '

When the job was created.

', 'StartReadSetExportJobResponse$creationTime' => '

When the job was created.

', 'StartReadSetImportJobResponse$creationTime' => '

When the job was created.

', 'StartReferenceImportJobResponse$creationTime' => '

When the job was created.

', ], ], 'TagArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => '

The resource\'s ARN.

', 'TagResourceRequest$resourceArn' => '

The resource\'s ARN.

', 'UntagResourceRequest$resourceArn' => '

The resource\'s ARN.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, 'TagResourceRequestTagsMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

Keys of tags to remove.

', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateAnnotationStoreRequest$tags' => '

Tags for the store.

', 'CreateAnnotationStoreVersionRequest$tags' => '

Any tags added to annotation store version.

', 'CreateMultipartReadSetUploadRequest$tags' => '

Any tags to add to the read set.

', 'CreateMultipartReadSetUploadResponse$tags' => '

The tags to add to the read set.

', 'CreateReferenceStoreRequest$tags' => '

Tags for the store.

', 'CreateRunGroupRequest$tags' => '

Tags for the group.

', 'CreateRunGroupResponse$tags' => '

Tags for the run group.

', 'CreateSequenceStoreRequest$tags' => '

Tags for the store.

', 'CreateVariantStoreRequest$tags' => '

Tags for the store.

', 'CreateWorkflowRequest$tags' => '

Tags for the workflow.

', 'CreateWorkflowResponse$tags' => '

The workflow\'s tags.

', 'GetAnnotationStoreResponse$tags' => '

The store\'s tags.

', 'GetAnnotationStoreVersionResponse$tags' => '

Any tags associated with an annotation store version.

', 'GetRunGroupResponse$tags' => '

The group\'s tags.

', 'GetRunResponse$tags' => '

The run\'s tags.

', 'GetVariantStoreResponse$tags' => '

The store\'s tags.

', 'GetWorkflowResponse$tags' => '

The workflow\'s tags.

', 'ImportReadSetSourceItem$tags' => '

The source\'s tags.

', 'ImportReferenceSourceItem$tags' => '

The source\'s tags.

', 'ListTagsForResourceResponse$tags' => '

A list of tags.

', 'MultipartReadSetUploadListItem$tags' => '

Any tags you wish to add to a read set.

', 'StartReadSetImportJobSourceItem$tags' => '

The source\'s tags.

', 'StartReferenceImportJobSourceItem$tags' => '

The source\'s tags.

', 'StartRunRequest$tags' => '

Tags for the run.

', 'StartRunResponse$tags' => '

The run\'s tags.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceRequestTagsMap' => [ 'base' => NULL, 'refs' => [ 'TagResourceRequest$tags' => '

Tags for the resource.

', ], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, 'TagResourceRequestTagsMap$value' => NULL, ], ], 'TaskFailureReason' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$failureReason' => '

The reason a task has failed.

', ], ], 'TaskId' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskRequest$taskId' => '

The task\'s ID.

', 'GetRunTaskResponse$taskId' => '

The task\'s ID.

', 'TaskListItem$taskId' => '

The task\'s ID.

', ], ], 'TaskInstanceType' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$instanceType' => '

The instance type for a task.

', 'TaskListItem$instanceType' => '

The instance type for a task.

', ], ], 'TaskList' => [ 'base' => NULL, 'refs' => [ 'ListRunTasksResponse$items' => '

A list of tasks.

', ], ], 'TaskListItem' => [ 'base' => '

A workflow run task.

', 'refs' => [ 'TaskList$member' => NULL, ], ], 'TaskListItemCpusInteger' => [ 'base' => NULL, 'refs' => [ 'TaskListItem$cpus' => '

The task\'s CPU count.

', ], ], 'TaskListItemGpusInteger' => [ 'base' => NULL, 'refs' => [ 'TaskListItem$gpus' => '

The number of Graphics Processing Units (GPU) specified for the task.

', ], ], 'TaskListItemMemoryInteger' => [ 'base' => NULL, 'refs' => [ 'TaskListItem$memory' => '

The task\'s memory use in gigabyes.

', ], ], 'TaskListToken' => [ 'base' => NULL, 'refs' => [ 'ListRunTasksRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRunTasksResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'TaskLogStream' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$logStream' => '

The task\'s log stream.

', ], ], 'TaskName' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$name' => '

The task\'s name.

', 'TaskListItem$name' => '

The task\'s name.

', ], ], 'TaskStatus' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$status' => '

The task\'s status.

', 'ListRunTasksRequest$status' => '

Filter the list by status.

', 'TaskListItem$status' => '

The task\'s status.

', ], ], 'TaskStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$statusMessage' => '

The task\'s status message.

', ], ], 'TaskTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$creationTime' => '

When the task was created.

', 'GetRunTaskResponse$startTime' => '

The task\'s start time.

', 'GetRunTaskResponse$stopTime' => '

The task\'s stop time.

', 'TaskListItem$creationTime' => '

When the task was created.

', 'TaskListItem$startTime' => '

When the task started.

', 'TaskListItem$stopTime' => '

When the task stopped.

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

The request was denied due to request throttling.

', 'refs' => [], ], 'TsvOptions' => [ 'base' => '

Formatting options for a TSV file.

', 'refs' => [ 'FormatOptions$tsvOptions' => '

Options for a TSV file.

', ], ], 'TsvStoreOptions' => [ 'base' => '

File settings for a TSV store.

', 'refs' => [ 'StoreOptions$tsvStoreOptions' => '

File settings for a TSV store.

', ], ], 'TsvStoreOptionsSchemaList' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptions$schema' => '

The store\'s schema.

', ], ], 'TsvVersionOptions' => [ 'base' => '

The options for a TSV file.

', 'refs' => [ 'VersionOptions$tsvVersionOptions' => '

File settings for a version of a TSV store.

', ], ], 'TsvVersionOptionsSchemaList' => [ 'base' => NULL, 'refs' => [ 'TsvVersionOptions$schema' => '

The TSV schema for an annotation store version.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRunGroupRequestMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxCpus' => '

The maximum number of CPUs to use.

', ], ], 'UpdateRunGroupRequestMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxDuration' => '

A maximum run time for the group in minutes.

', ], ], 'UpdateRunGroupRequestMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'UpdateRunGroupRequestMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxRuns' => '

The maximum number of concurrent runs for the group.

', ], ], 'UpdateTime' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$updateTime' => '

When the job was updated.

', 'AnnotationStoreItem$updateTime' => '

When the store was updated.

', 'AnnotationStoreVersionItem$updateTime' => '

The time stamp for when an annotation store version was updated.

', 'GetAnnotationImportResponse$updateTime' => '

When the job was updated.

', 'GetAnnotationStoreResponse$updateTime' => '

When the store was updated.

', 'GetAnnotationStoreVersionResponse$updateTime' => '

The time stamp for when an annotation store version was updated.

', 'GetVariantImportResponse$updateTime' => '

When the job was updated.

', 'GetVariantStoreResponse$updateTime' => '

When the store was updated.

', 'ShareDetails$updateTime' => '

The timestamp of the share update.

', 'UpdateAnnotationStoreResponse$updateTime' => '

When the store was updated.

', 'UpdateAnnotationStoreVersionResponse$updateTime' => '

The time stamp for when an annotation store version was updated.

', 'UpdateVariantStoreResponse$updateTime' => '

When the store was updated.

', 'VariantImportJobItem$updateTime' => '

When the job was updated.

', 'VariantStoreItem$updateTime' => '

When the store was updated.

', ], ], 'UpdateVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'UploadId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartReadSetUploadRequest$uploadId' => '

The ID for the multipart upload.

', 'CompleteMultipartReadSetUploadRequest$uploadId' => '

The ID for the multipart upload.

', 'CreateMultipartReadSetUploadResponse$uploadId' => '

The ID for the initiated multipart upload.

', 'ListReadSetUploadPartsRequest$uploadId' => '

The ID for the initiated multipart upload.

', 'MultipartReadSetUploadListItem$uploadId' => '

The ID for the initiated multipart upload.

', 'UploadReadSetPartRequest$uploadId' => '

The ID for the initiated multipart upload.

', ], ], 'UploadReadSetPartRequest' => [ 'base' => NULL, 'refs' => [], ], 'UploadReadSetPartRequestPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'UploadReadSetPartRequest$partNumber' => '

The number of the part being uploaded.

', ], ], 'UploadReadSetPartResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

The input fails to satisfy the constraints specified by an AWS service.

', 'refs' => [], ], 'VariantImportItemDetail' => [ 'base' => '

Details about an imported variant item.

', 'refs' => [ 'VariantImportItemDetails$member' => NULL, ], ], 'VariantImportItemDetails' => [ 'base' => NULL, 'refs' => [ 'GetVariantImportResponse$items' => '

The job\'s items.

', ], ], 'VariantImportItemSource' => [ 'base' => '

A imported variant item\'s source.

', 'refs' => [ 'VariantImportItemSources$member' => NULL, ], ], 'VariantImportItemSources' => [ 'base' => NULL, 'refs' => [ 'StartVariantImportRequest$items' => '

Items to import.

', ], ], 'VariantImportJobItem' => [ 'base' => '

A variant import job.

', 'refs' => [ 'VariantImportJobItems$member' => NULL, ], ], 'VariantImportJobItems' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsResponse$variantImportJobs' => '

A list of jobs.

', ], ], 'VariantStoreItem' => [ 'base' => '

A variant store.

', 'refs' => [ 'VariantStoreItems$member' => NULL, ], ], 'VariantStoreItems' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresResponse$variantStores' => '

A list of variant stores.

', ], ], 'VcfOptions' => [ 'base' => '

Formatting options for a VCF file.

', 'refs' => [ 'FormatOptions$vcfOptions' => '

Options for a VCF file.

', ], ], 'VersionDeleteError' => [ 'base' => '

The error preventing deletion of the annotation store version.

', 'refs' => [ 'VersionDeleteErrorList$member' => NULL, ], ], 'VersionDeleteErrorList' => [ 'base' => NULL, 'refs' => [ 'DeleteAnnotationStoreVersionsResponse$errors' => '

Any errors that occur when attempting to delete an annotation store version.

', ], ], 'VersionList' => [ 'base' => NULL, 'refs' => [ 'DeleteAnnotationStoreVersionsRequest$versions' => '

The versions of an annotation store to be deleted.

', ], ], 'VersionName' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$versionName' => '

The name of the annotation store version.

', 'AnnotationStoreVersionItem$versionName' => '

The name of an annotation store version.

', 'CreateAnnotationStoreRequest$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateAnnotationStoreResponse$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateAnnotationStoreVersionRequest$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateAnnotationStoreVersionResponse$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'GetAnnotationImportResponse$versionName' => '

The name of the annotation store version.

', 'GetAnnotationStoreVersionResponse$versionName' => '

The name given to an annotation store version to distinguish it from others.

', 'StartAnnotationImportRequest$versionName' => '

The name of the annotation store version.

', 'UpdateAnnotationStoreVersionResponse$versionName' => '

The name of an annotation store version.

', 'VersionDeleteError$versionName' => '

The name given to an annotation store version.

', 'VersionList$member' => NULL, ], ], 'VersionOptions' => [ 'base' => '

The options for an annotation store version.

', 'refs' => [ 'CreateAnnotationStoreVersionRequest$versionOptions' => '

The options for an annotation store version.

', 'CreateAnnotationStoreVersionResponse$versionOptions' => '

The options for an annotation store version.

', 'GetAnnotationStoreVersionResponse$versionOptions' => '

The options for an annotation store version.

', ], ], 'VersionStatus' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreVersionItem$status' => '

The status of an annotation store version.

', 'CreateAnnotationStoreVersionResponse$status' => '

The status of a annotation store version.

', 'GetAnnotationStoreVersionResponse$status' => '

The status of an annotation store version.

', 'ListAnnotationStoreVersionsFilter$status' => '

The status of an annotation store version.

', 'UpdateAnnotationStoreVersionResponse$status' => '

The status of an annotation store version.

', ], ], 'WorkflowArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$arn' => '

The workflow\'s ARN.

', 'GetWorkflowResponse$arn' => '

The workflow\'s ARN.

', 'WorkflowListItem$arn' => '

The workflow\'s ARN.

', ], ], 'WorkflowDefinition' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$definitionUri' => '

The URI of a definition for the workflow.

', 'GetRunResponse$definition' => '

The run\'s definition.

', 'GetWorkflowResponse$definition' => '

The workflow\'s definition.

', ], ], 'WorkflowDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$description' => '

A description for the workflow.

', 'GetWorkflowResponse$description' => '

The workflow\'s description.

', 'UpdateWorkflowRequest$description' => '

A description for the workflow.

', ], ], 'WorkflowDigest' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$digest' => '

The run\'s digest.

', 'GetWorkflowResponse$digest' => '

The workflow\'s digest.

', 'WorkflowListItem$digest' => '

The workflow\'s digest.

', ], ], 'WorkflowEngine' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$engine' => '

An engine for the workflow.

', 'GetWorkflowResponse$engine' => '

The workflow\'s engine.

', ], ], 'WorkflowExport' => [ 'base' => NULL, 'refs' => [ 'WorkflowExportList$member' => NULL, ], ], 'WorkflowExportList' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowRequest$export' => '

The export format for the workflow.

', ], ], 'WorkflowId' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$id' => '

The workflow\'s ID.

', 'DeleteWorkflowRequest$id' => '

The workflow\'s ID.

', 'GetRunResponse$workflowId' => '

The run\'s workflow ID.

', 'GetWorkflowRequest$id' => '

The workflow\'s ID.

', 'GetWorkflowResponse$id' => '

The workflow\'s ID.

', 'RunListItem$workflowId' => '

The run\'s workflow ID.

', 'StartRunRequest$workflowId' => '

The run\'s workflow ID.

', 'UpdateWorkflowRequest$id' => '

The workflow\'s ID.

', 'WorkflowListItem$id' => '

The workflow\'s ID.

', ], ], 'WorkflowList' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsResponse$items' => '

The workflows\' items.

', ], ], 'WorkflowListItem' => [ 'base' => '

A workflow.

', 'refs' => [ 'WorkflowList$member' => NULL, ], ], 'WorkflowListToken' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListWorkflowsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'WorkflowMain' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$main' => '

The path of the main definition file for the workflow.

', 'GetWorkflowResponse$main' => '

The path of the main definition file for the workflow.

', ], ], 'WorkflowMetadata' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$metadata' => '

Gets metadata for workflow.

', 'WorkflowListItem$metadata' => '

Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.

', ], ], 'WorkflowMetadataKey' => [ 'base' => NULL, 'refs' => [ 'WorkflowMetadata$key' => NULL, ], ], 'WorkflowMetadataValue' => [ 'base' => NULL, 'refs' => [ 'WorkflowMetadata$value' => NULL, ], ], 'WorkflowName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$name' => '

A name for the workflow.

', 'GetWorkflowResponse$name' => '

The workflow\'s name.

', 'ListWorkflowsRequest$name' => '

The workflows\' name.

', 'UpdateWorkflowRequest$name' => '

A name for the workflow.

', 'WorkflowListItem$name' => '

The workflow\'s name.

', ], ], 'WorkflowParameter' => [ 'base' => '

A workflow parameter.

', 'refs' => [ 'WorkflowParameterTemplate$value' => NULL, ], ], 'WorkflowParameterDescription' => [ 'base' => NULL, 'refs' => [ 'WorkflowParameter$description' => '

The parameter\'s description.

', ], ], 'WorkflowParameterName' => [ 'base' => NULL, 'refs' => [ 'WorkflowParameterTemplate$key' => NULL, ], ], 'WorkflowParameterTemplate' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$parameterTemplate' => '

A parameter template for the workflow.

', 'GetWorkflowResponse$parameterTemplate' => '

The workflow\'s parameter template.

', ], ], 'WorkflowRequestId' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$requestId' => '

To ensure that requests don\'t run multiple times, specify a unique ID for each request.

', ], ], 'WorkflowStatus' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$status' => '

The workflow\'s status.

', 'GetWorkflowResponse$status' => '

The workflow\'s status.

', 'WorkflowListItem$status' => '

The workflow\'s status.

', ], ], 'WorkflowStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$statusMessage' => '

The workflow\'s status message.

', ], ], 'WorkflowTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$creationTime' => '

When the workflow was created.

', 'WorkflowListItem$creationTime' => '

When the workflow was created.

', ], ], 'WorkflowType' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$workflowType' => '

The run\'s workflow type.

', 'GetWorkflowRequest$type' => '

The workflow\'s type.

', 'GetWorkflowResponse$type' => '

The workflow\'s type.

', 'ListWorkflowsRequest$type' => '

The workflows\' type.

', 'StartRunRequest$workflowType' => '

The run\'s workflow type.

', 'WorkflowListItem$type' => '

The workflow\'s type.

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

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

', 'operations' => [ 'AbortMultipartReadSetUpload' => '

Stops a multipart upload.

', 'AcceptShare' => '

Accept a resource share request.

', 'BatchDeleteReadSet' => '

Deletes one or more read sets.

', 'CancelAnnotationImportJob' => '

Cancels an annotation import job.

', 'CancelRun' => '

Cancels a run.

', 'CancelVariantImportJob' => '

Cancels a variant import job.

', 'CompleteMultipartReadSetUpload' => '

Concludes a multipart upload once you have uploaded all the components.

', 'CreateAnnotationStore' => '

Creates an annotation store.

', 'CreateAnnotationStoreVersion' => '

Creates a new version of an annotation store.

', 'CreateMultipartReadSetUpload' => '

Begins a multipart read set upload.

', 'CreateReferenceStore' => '

Creates a reference store.

', 'CreateRunGroup' => '

Creates a run group.

', 'CreateSequenceStore' => '

Creates a sequence store.

', 'CreateShare' => '

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

', 'CreateVariantStore' => '

Creates a variant store.

', 'CreateWorkflow' => '

Creates a workflow.

', 'DeleteAnnotationStore' => '

Deletes an annotation store.

', 'DeleteAnnotationStoreVersions' => '

Deletes one or multiple versions of an annotation store.

', 'DeleteReference' => '

Deletes a genome reference.

', 'DeleteReferenceStore' => '

Deletes a genome reference store.

', 'DeleteRun' => '

Deletes a workflow run.

', 'DeleteRunGroup' => '

Deletes a workflow run group.

', 'DeleteSequenceStore' => '

Deletes a sequence store.

', 'DeleteShare' => '

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

', 'DeleteVariantStore' => '

Deletes a variant store.

', 'DeleteWorkflow' => '

Deletes a workflow.

', 'GetAnnotationImportJob' => '

Gets information about an annotation import job.

', 'GetAnnotationStore' => '

Gets information about an annotation store.

', 'GetAnnotationStoreVersion' => '

Retrieves the metadata for an annotation store version.

', 'GetReadSet' => '

Gets a file from a read set.

', 'GetReadSetActivationJob' => '

Gets information about a read set activation job.

', 'GetReadSetExportJob' => '

Gets information about a read set export job.

', 'GetReadSetImportJob' => '

Gets information about a read set import job.

', 'GetReadSetMetadata' => '

Gets details about a read set.

', 'GetReference' => '

Gets a reference file.

', 'GetReferenceImportJob' => '

Gets information about a reference import job.

', 'GetReferenceMetadata' => '

Gets information about a genome reference\'s metadata.

', 'GetReferenceStore' => '

Gets information about a reference store.

', 'GetRun' => '

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

', 'GetRunGroup' => '

Gets information about a workflow run group.

', 'GetRunTask' => '

Gets information about a workflow run task.

', 'GetSequenceStore' => '

Gets information about a sequence store.

', 'GetShare' => '

Retrieves the metadata for the specified resource share.

', 'GetVariantImportJob' => '

Gets information about a variant import job.

', 'GetVariantStore' => '

Gets information about a variant store.

', 'GetWorkflow' => '

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

', 'ListAnnotationImportJobs' => '

Retrieves a list of annotation import jobs.

', 'ListAnnotationStoreVersions' => '

Lists the versions of an annotation store.

', 'ListAnnotationStores' => '

Retrieves a list of annotation stores.

', 'ListMultipartReadSetUploads' => '

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

', 'ListReadSetActivationJobs' => '

Retrieves a list of read set activation jobs.

', 'ListReadSetExportJobs' => '

Retrieves a list of read set export jobs.

', 'ListReadSetImportJobs' => '

Retrieves a list of read set import jobs.

', 'ListReadSetUploadParts' => '

This operation will list all parts in a requested multipart upload for a sequence store.

', 'ListReadSets' => '

Retrieves a list of read sets.

', 'ListReferenceImportJobs' => '

Retrieves a list of reference import jobs.

', 'ListReferenceStores' => '

Retrieves a list of reference stores.

', 'ListReferences' => '

Retrieves a list of references.

', 'ListRunGroups' => '

Retrieves a list of run groups.

', 'ListRunTasks' => '

Retrieves a list of tasks for a run.

', 'ListRuns' => '

Retrieves a list of runs.

', 'ListSequenceStores' => '

Retrieves a list of sequence stores.

', 'ListShares' => '

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

', 'ListTagsForResource' => '

Retrieves a list of tags for a resource.

', 'ListVariantImportJobs' => '

Retrieves a list of variant import jobs.

', 'ListVariantStores' => '

Retrieves a list of variant stores.

', 'ListWorkflows' => '

Retrieves a list of workflows.

', 'StartAnnotationImportJob' => '

Starts an annotation import job.

', 'StartReadSetActivationJob' => '

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

', 'StartReadSetExportJob' => '

Exports a read set to Amazon S3.

', 'StartReadSetImportJob' => '

Starts a read set import job.

', 'StartReferenceImportJob' => '

Starts a reference import job.

', 'StartRun' => '

Starts a workflow run. To duplicate a run, specify the run\'s ID and a role ARN. The remaining parameters are copied from the previous run.

StartRun will not support re-run for a workflow that is shared with you.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.

', 'StartVariantImportJob' => '

Starts a variant import job.

', 'TagResource' => '

Tags a resource.

', 'UntagResource' => '

Removes tags from a resource.

', 'UpdateAnnotationStore' => '

Updates an annotation store.

', 'UpdateAnnotationStoreVersion' => '

Updates the description of an annotation store version.

', 'UpdateRunGroup' => '

Updates a run group.

', 'UpdateVariantStore' => '

Updates a variant store.

', 'UpdateWorkflow' => '

Updates a workflow.

', 'UploadReadSetPart' => '

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.

', ], 'shapes' => [ 'AbortMultipartReadSetUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'AbortMultipartReadSetUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'Accelerators' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$accelerators' => '

The computational accelerator specified to run the workflow.

', 'GetRunResponse$accelerators' => '

The computational accelerator used to run the workflow.

', 'GetWorkflowResponse$accelerators' => '

The computational accelerator specified to run the workflow.

', ], ], 'AcceptShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => '

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'ActivateReadSetFilter' => [ 'base' => '

A read set activation job filter.

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

A filter to apply to the list.

', ], ], 'ActivateReadSetJobItem' => [ 'base' => '

A read set activation job.

', 'refs' => [ 'ActivateReadSetJobList$member' => NULL, ], ], 'ActivateReadSetJobList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetActivationJobsResponse$activationJobs' => '

A list of jobs.

', ], ], 'ActivateReadSetSourceItem' => [ 'base' => '

A source for a read set activation job.

', 'refs' => [ 'ActivateReadSetSourceList$member' => NULL, ], ], 'ActivateReadSetSourceList' => [ 'base' => NULL, 'refs' => [ 'GetReadSetActivationJobResponse$sources' => '

The job\'s source files.

', ], ], 'ActivationJobId' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetJobItem$id' => '

The job\'s ID.

', 'GetReadSetActivationJobRequest$id' => '

The job\'s ID.

', 'GetReadSetActivationJobResponse$id' => '

The job\'s ID.

', 'StartReadSetActivationJobResponse$id' => '

The job\'s ID.

', ], ], 'AnnotationFieldMap' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'GetAnnotationImportResponse$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'GetVariantImportResponse$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'StartAnnotationImportRequest$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'StartVariantImportRequest$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', 'VariantImportJobItem$annotationFields' => '

The annotation schema generated by the parsed annotation data.

', ], ], 'AnnotationFieldMapKeyString' => [ 'base' => NULL, 'refs' => [ 'AnnotationFieldMap$key' => NULL, ], ], 'AnnotationFieldMapValueString' => [ 'base' => NULL, 'refs' => [ 'AnnotationFieldMap$value' => NULL, ], ], 'AnnotationImportItemDetail' => [ 'base' => '

Details about an imported annotation item.

', 'refs' => [ 'AnnotationImportItemDetails$member' => NULL, ], ], 'AnnotationImportItemDetails' => [ 'base' => NULL, 'refs' => [ 'GetAnnotationImportResponse$items' => '

The job\'s imported items.

', ], ], 'AnnotationImportItemSource' => [ 'base' => '

A source for an annotation import job.

', 'refs' => [ 'AnnotationImportItemSources$member' => NULL, ], ], 'AnnotationImportItemSources' => [ 'base' => NULL, 'refs' => [ 'StartAnnotationImportRequest$items' => '

Items to import.

', ], ], 'AnnotationImportJobItem' => [ 'base' => '

An annotation import job.

', 'refs' => [ 'AnnotationImportJobItems$member' => NULL, ], ], 'AnnotationImportJobItems' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsResponse$annotationImportJobs' => '

A list of jobs.

', ], ], 'AnnotationStoreItem' => [ 'base' => '

An annotation store.

', 'refs' => [ 'AnnotationStoreItems$member' => NULL, ], ], 'AnnotationStoreItems' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresResponse$annotationStores' => '

A list of stores.

', ], ], 'AnnotationStoreVersionItem' => [ 'base' => '

Annotation store versions.

', 'refs' => [ 'AnnotationStoreVersionItems$member' => NULL, ], ], 'AnnotationStoreVersionItems' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoreVersionsResponse$annotationStoreVersions' => '

Lists all versions of an annotation store.

', ], ], 'AnnotationType' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptions$annotationType' => '

The store\'s annotation type.

', 'TsvVersionOptions$annotationType' => '

The store version\'s annotation type.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$roleArn' => '

The job\'s service role ARN.

', 'AnnotationStoreItem$storeArn' => '

The store\'s ARN.

', 'AnnotationStoreVersionItem$versionArn' => '

The Arn for an annotation store version.

', 'GetAnnotationImportResponse$roleArn' => '

The job\'s service role ARN.

', 'GetAnnotationStoreResponse$storeArn' => '

The store\'s ARN.

', 'GetAnnotationStoreVersionResponse$versionArn' => '

The Arn for the annotation store.

', 'GetVariantImportResponse$roleArn' => '

The job\'s service role ARN.

', 'GetVariantStoreResponse$storeArn' => '

The store\'s ARN.

', 'StartAnnotationImportRequest$roleArn' => '

A service role for the job.

', 'StartVariantImportRequest$roleArn' => '

A service role for the job.

', 'VariantImportJobItem$roleArn' => '

The job\'s service role ARN.

', 'VariantStoreItem$storeArn' => '

The store\'s ARN.

', ], ], 'ArnList' => [ 'base' => NULL, 'refs' => [ 'Filter$resourceArns' => '

Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.

', ], ], 'BatchDeleteReadSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteReadSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$definitionZip' => '

A ZIP archive for the workflow.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'VcfOptions$ignoreQualField' => '

The file\'s ignore qual field setting.

', 'VcfOptions$ignoreFilterField' => '

The file\'s ignore filter field setting.

', 'WorkflowParameter$optional' => '

Whether the parameter is optional.

', ], ], 'CancelAnnotationImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelAnnotationImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelVariantImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelVariantImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$clientToken' => '

An idempotency token that can be used to avoid triggering multiple multipart uploads.

', 'CreateReferenceStoreRequest$clientToken' => '

To ensure that requests don\'t run multiple times, specify a unique token for each request.

', 'CreateSequenceStoreRequest$clientToken' => '

To ensure that requests don\'t run multiple times, specify a unique token for each request.

', 'StartReadSetActivationJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', 'StartReadSetExportJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', 'StartReadSetImportJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', 'StartReferenceImportJobRequest$clientToken' => '

To ensure that jobs don\'t run multiple times, specify a unique token for each job.

', ], ], 'CommentChar' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$comment' => '

The file\'s comment character.

', ], ], 'CompleteMultipartReadSetUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CompleteMultipartReadSetUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'CompleteReadSetUploadPartList' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartReadSetUploadRequest$parts' => '

The individual uploads or parts of a multipart upload.

', ], ], 'CompleteReadSetUploadPartListItem' => [ 'base' => '

Part of the response to the CompleteReadSetUpload API, including metadata.

', 'refs' => [ 'CompleteReadSetUploadPartList$member' => NULL, ], ], 'CompleteReadSetUploadPartListItemChecksumString' => [ 'base' => NULL, 'refs' => [ 'CompleteReadSetUploadPartListItem$checksum' => '

A unique identifier used to confirm that parts are being added to the correct upload.

', ], ], 'CompleteReadSetUploadPartListItemPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'CompleteReadSetUploadPartListItem$partNumber' => '

A number identifying the part in a read set upload.

', ], ], 'CompletionTime' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$completionTime' => '

When the job completed.

', 'GetAnnotationImportResponse$completionTime' => '

When the job completed.

', 'GetVariantImportResponse$completionTime' => '

When the job completed.

', 'VariantImportJobItem$completionTime' => '

When the job completed.

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

The request cannot be applied to the target resource in its current state.

', 'refs' => [], ], 'CreateAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnnotationStoreVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnnotationStoreVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartReadSetUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartReadSetUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateReferenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateReferenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRunGroupRequestMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxCpus' => '

The maximum number of CPUs to use in the group.

', ], ], 'CreateRunGroupRequestMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxDuration' => '

A maximum run time for the group in minutes.

', ], ], 'CreateRunGroupRequestMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'CreateRunGroupRequestMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$maxRuns' => '

The maximum number of concurrent runs for the group.

', ], ], 'CreateRunGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSequenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSequenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequestStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$storageCapacity' => '

The storage capacity for the workflow in gibibytes.

', ], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$creationTime' => '

When the job was created.

', 'AnnotationStoreItem$creationTime' => '

The store\'s creation time.

', 'AnnotationStoreVersionItem$creationTime' => '

The time stamp for when an annotation store version was created.

', 'CreateAnnotationStoreResponse$creationTime' => '

When the store was created.

', 'CreateAnnotationStoreVersionResponse$creationTime' => '

The time stamp for the creation of an annotation store version.

', 'CreateVariantStoreResponse$creationTime' => '

When the store was created.

', 'GetAnnotationImportResponse$creationTime' => '

When the job was created.

', 'GetAnnotationStoreResponse$creationTime' => '

When the store was created.

', 'GetAnnotationStoreVersionResponse$creationTime' => '

The time stamp for when an annotation store version was created.

', 'GetVariantImportResponse$creationTime' => '

When the job was created.

', 'GetVariantStoreResponse$creationTime' => '

When the store was created.

', 'ShareDetails$creationTime' => '

The timestamp of when the resource share was created.

', 'UpdateAnnotationStoreResponse$creationTime' => '

When the store was created.

', 'UpdateAnnotationStoreVersionResponse$creationTime' => '

The time stamp for when an annotation store version was created.

', 'UpdateVariantStoreResponse$creationTime' => '

When the store was created.

', 'VariantImportJobItem$creationTime' => '

When the job was created.

', 'VariantStoreItem$creationTime' => '

When the store was created.

', ], ], 'CreationType' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$creationType' => '

The creation type of the read set.

', 'ReadSetFilter$creationType' => '

The creation type of the read set.

', 'ReadSetListItem$creationType' => '

The creation type of the read set.

', ], ], 'DeleteAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnnotationStoreVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnnotationStoreVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReferenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSequenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSequenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$description' => '

The store\'s description.

', 'AnnotationStoreVersionItem$description' => '

The description of an annotation store version.

', 'CreateAnnotationStoreRequest$description' => '

A description for the store.

', 'CreateAnnotationStoreVersionRequest$description' => '

The description of an annotation store version.

', 'CreateVariantStoreRequest$description' => '

A description for the store.

', 'GetAnnotationStoreResponse$description' => '

The store\'s description.

', 'GetAnnotationStoreVersionResponse$description' => '

The description for an annotation store version.

', 'GetVariantStoreResponse$description' => '

The store\'s description.

', 'UpdateAnnotationStoreRequest$description' => '

A description for the store.

', 'UpdateAnnotationStoreResponse$description' => '

The store\'s description.

', 'UpdateAnnotationStoreVersionRequest$description' => '

The description of an annotation store.

', 'UpdateAnnotationStoreVersionResponse$description' => '

The description of an annotation store version.

', 'UpdateVariantStoreRequest$description' => '

A description for the store.

', 'UpdateVariantStoreResponse$description' => '

The store\'s description.

', 'VariantStoreItem$description' => '

The store\'s description.

', ], ], 'ETag' => [ 'base' => '

The entity tag (ETag) is a hash of the object representing its semantic content.

', 'refs' => [ 'GetReadSetMetadataResponse$etag' => '

The entity tag (ETag) is a hash of the object meant to represent its semantic content.

', 'ReadSetListItem$etag' => '

The entity tag (ETag) is a hash of the object representing its semantic content.

', ], ], 'ETagAlgorithm' => [ 'base' => NULL, 'refs' => [ 'ETag$algorithm' => '

The algorithm used to calculate the read set’s ETag(s).

', ], ], 'ETagAlgorithmFamily' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$eTagAlgorithmFamily' => '

The ETag algorithm family to use for ingested read sets.

', 'CreateSequenceStoreResponse$eTagAlgorithmFamily' => '

The algorithm family of the ETag.

', 'GetSequenceStoreResponse$eTagAlgorithmFamily' => '

The algorithm family of the ETag.

', 'SequenceStoreDetail$eTagAlgorithmFamily' => '

The algorithm family of the ETag.

', ], ], 'Encoding' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$encoding' => '

The file\'s encoding.

', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'SseConfig$type' => '

The encryption type.

', ], ], 'EngineLogStream' => [ 'base' => NULL, 'refs' => [ 'RunLogLocation$engineLogStream' => '

The log stream ARN for the engine log.

', ], ], 'EscapeChar' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$escape' => '

A character for escaping quotes in the file.

', ], ], 'EscapeQuotes' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$escapeQuotes' => '

Whether quotes need to be escaped in the file.

', ], ], 'ExportJobId' => [ 'base' => NULL, 'refs' => [ 'ExportReadSetJobDetail$id' => '

The job\'s ID.

', 'GetReadSetExportJobRequest$id' => '

The job\'s ID.

', 'GetReadSetExportJobResponse$id' => '

The job\'s ID.

', 'StartReadSetExportJobResponse$id' => '

The job\'s ID.

', ], ], 'ExportReadSet' => [ 'base' => '

A read set.

', 'refs' => [ 'StartReadSetExportJobRequestSourcesList$member' => NULL, ], ], 'ExportReadSetDetail' => [ 'base' => '

Details about a read set.

', 'refs' => [ 'ExportReadSetDetailList$member' => NULL, ], ], 'ExportReadSetDetailList' => [ 'base' => NULL, 'refs' => [ 'GetReadSetExportJobResponse$readSets' => '

The job\'s read sets.

', ], ], 'ExportReadSetFilter' => [ 'base' => '

An read set export job filter.

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

A filter to apply to the list.

', ], ], 'ExportReadSetJobDetail' => [ 'base' => '

Details about a read set export job.

', 'refs' => [ 'ExportReadSetJobDetailList$member' => NULL, ], ], 'ExportReadSetJobDetailList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetExportJobsResponse$exportJobs' => '

A list of jobs.

', ], ], 'FileInformation' => [ 'base' => '

Details about a file.

', 'refs' => [ 'ReadSetFiles$source1' => '

The location of the first file in Amazon S3.

', 'ReadSetFiles$source2' => '

The location of the second file in Amazon S3.

', 'ReadSetFiles$index' => '

The files\' index.

', 'ReferenceFiles$source' => '

The source file\'s location in Amazon S3.

', 'ReferenceFiles$index' => '

The files\' index.

', ], ], 'FileInformationContentLengthLong' => [ 'base' => NULL, 'refs' => [ 'FileInformation$contentLength' => '

The file\'s content length.

', ], ], 'FileInformationPartSizeLong' => [ 'base' => NULL, 'refs' => [ 'FileInformation$partSize' => '

The file\'s part size.

', ], ], 'FileInformationTotalPartsInteger' => [ 'base' => NULL, 'refs' => [ 'FileInformation$totalParts' => '

The file\'s total parts.

', ], ], 'FileType' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$sourceFileType' => '

The type of file being uploaded.

', 'CreateMultipartReadSetUploadResponse$sourceFileType' => '

The file type of the read set source.

', 'GetReadSetMetadataResponse$fileType' => '

The read set\'s file type.

', 'ImportReadSetSourceItem$sourceFileType' => '

The source\'s file type.

', 'MultipartReadSetUploadListItem$sourceFileType' => '

The type of file the read set originated from.

', 'ReadSetListItem$fileType' => '

The read set\'s file type.

', 'StartReadSetImportJobSourceItem$sourceFileType' => '

The source\'s file type.

', ], ], 'Filter' => [ 'base' => '

Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.

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

Attributes that you use to filter for a specific subset of resource shares.

', ], ], 'FormatOptions' => [ 'base' => '

Formatting options for a file.

', 'refs' => [ 'GetAnnotationImportResponse$formatOptions' => NULL, 'StartAnnotationImportRequest$formatOptions' => '

Formatting options for the annotation file.

', ], ], 'FormatToHeader' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptions$formatToHeader' => '

The store\'s header key to column name mapping.

', 'TsvVersionOptions$formatToHeader' => '

The annotation store version\'s header key to column name mapping.

', ], ], 'FormatToHeaderKey' => [ 'base' => NULL, 'refs' => [ 'FormatToHeader$key' => NULL, ], ], 'FormatToHeaderValueString' => [ 'base' => NULL, 'refs' => [ 'FormatToHeader$value' => NULL, ], ], 'GeneratedFrom' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$generatedFrom' => '

Where the source originated.

', 'CreateMultipartReadSetUploadResponse$generatedFrom' => '

The source of the read set.

', 'ImportReadSetSourceItem$generatedFrom' => '

Where the source originated.

', 'MultipartReadSetUploadListItem$generatedFrom' => '

The source of an uploaded part.

', 'ReadSetFilter$generatedFrom' => '

Where the source originated.

', 'SequenceInformation$generatedFrom' => '

Where the sequence originated.

', 'StartReadSetImportJobSourceItem$generatedFrom' => '

Where the source originated.

', ], ], 'GetAnnotationImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAnnotationStoreVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetActivationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetActivationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReadSetRequestPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'GetReadSetRequest$partNumber' => '

The part number to retrieve.

', ], ], 'GetReadSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceRequestPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'GetReferenceRequest$partNumber' => '

The part number to retrieve.

', ], ], 'GetReferenceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetReferenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRunGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunGroupResponseMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxCpus' => '

The group\'s maximum number of CPUs to use.

', ], ], 'GetRunGroupResponseMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxDuration' => '

The group\'s maximum run time in minutes.

', ], ], 'GetRunGroupResponseMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'GetRunGroupResponseMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$maxRuns' => '

The maximum number of concurrent runs for the group.

', ], ], 'GetRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunResponsePriorityInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$priority' => '

The run\'s priority.

', ], ], 'GetRunResponseStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$storageCapacity' => '

The run\'s storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

', ], ], 'GetRunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRunTaskResponseCpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$cpus' => '

The task\'s CPU usage.

', ], ], 'GetRunTaskResponseGpusInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$gpus' => '

The number of Graphics Processing Units (GPU) specified in the task.

', ], ], 'GetRunTaskResponseMemoryInteger' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$memory' => '

The task\'s memory use in gigabytes.

', ], ], 'GetSequenceStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSequenceStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetShareRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetShareResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponseStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$storageCapacity' => '

The workflow\'s storage capacity in gibibytes.

', ], ], 'Header' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$header' => '

Whether the file has a header row.

', ], ], 'ImportJobId' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobRequest$id' => '

The job\'s ID.

', 'GetReadSetImportJobResponse$id' => '

The job\'s ID.

', 'GetReferenceImportJobRequest$id' => '

The job\'s ID.

', 'GetReferenceImportJobResponse$id' => '

The job\'s ID.

', 'ImportReadSetJobItem$id' => '

The job\'s ID.

', 'ImportReferenceJobItem$id' => '

The job\'s ID.

', 'StartReadSetImportJobResponse$id' => '

The job\'s ID.

', 'StartReferenceImportJobResponse$id' => '

The job\'s ID.

', ], ], 'ImportReadSetFilter' => [ 'base' => '

A filter for import read set jobs.

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

A filter to apply to the list.

', ], ], 'ImportReadSetJobItem' => [ 'base' => '

An import read set job.

', 'refs' => [ 'ImportReadSetJobList$member' => NULL, ], ], 'ImportReadSetJobList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetImportJobsResponse$importJobs' => '

A list of jobs.

', ], ], 'ImportReadSetSourceItem' => [ 'base' => '

A source for an import read set job.

', 'refs' => [ 'ImportReadSetSourceList$member' => NULL, ], ], 'ImportReadSetSourceList' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobResponse$sources' => '

The job\'s source files.

', ], ], 'ImportReferenceFilter' => [ 'base' => '

A filter for import references.

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

A filter to apply to the list.

', ], ], 'ImportReferenceJobItem' => [ 'base' => '

An import reference job.

', 'refs' => [ 'ImportReferenceJobList$member' => NULL, ], ], 'ImportReferenceJobList' => [ 'base' => NULL, 'refs' => [ 'ListReferenceImportJobsResponse$importJobs' => '

A lis of jobs.

', ], ], 'ImportReferenceSourceItem' => [ 'base' => '

An genome reference source.

', 'refs' => [ 'ImportReferenceSourceList$member' => NULL, ], ], 'ImportReferenceSourceList' => [ 'base' => NULL, 'refs' => [ 'GetReferenceImportJobResponse$sources' => '

The job\'s source files.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'GetAnnotationStoreResponse$numVersions' => '

An integer indicating how many versions of an annotation store exist.

', 'ListSharesRequest$maxResults' => '

The maximum number of shares to return in one page of results.

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

An unexpected error occurred. Try the request again.

', 'refs' => [], ], 'JobStatus' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportItemDetail$jobStatus' => '

The item\'s job status.

', 'AnnotationImportJobItem$status' => '

The job\'s status.

', 'GetAnnotationImportResponse$status' => '

The job\'s status.

', 'GetVariantImportResponse$status' => '

The job\'s status.

', 'ListAnnotationImportJobsFilter$status' => '

A status to filter on.

', 'ListVariantImportJobsFilter$status' => '

A status to filter on.

', 'VariantImportItemDetail$jobStatus' => '

The item\'s job status.

', 'VariantImportJobItem$status' => '

The job\'s status.

', ], ], 'JobStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetSourceItem$statusMessage' => '

The source\'s status message.

', 'ExportReadSetDetail$statusMessage' => '

The set\'s status message.

', 'GetReadSetActivationJobResponse$statusMessage' => '

The job\'s status message.

', 'GetReadSetExportJobResponse$statusMessage' => '

The job\'s status message.

', 'GetReadSetImportJobResponse$statusMessage' => '

The job\'s status message.

', 'GetReferenceImportJobResponse$statusMessage' => '

The job\'s status message.

', 'ImportReadSetSourceItem$statusMessage' => '

The source\'s status message.

', 'ImportReferenceSourceItem$statusMessage' => '

The source\'s status message.

', ], ], 'JobStatusMsg' => [ 'base' => NULL, 'refs' => [ 'GetAnnotationImportResponse$statusMessage' => '

The job\'s status message.

', 'GetVariantImportResponse$statusMessage' => '

The job\'s status message.

', 'VariantImportItemDetail$statusMessage' => '

A message that provides additional context about a job

', ], ], 'LineSep' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$lineSep' => '

A line separator for the file.

', ], ], 'ListAnnotationImportJobsFilter' => [ 'base' => '

A filter for annotation import jobs.

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

A filter to apply to the list.

', ], ], 'ListAnnotationImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationImportJobsRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequest$ids' => '

IDs of annotation import jobs to retrieve.

', ], ], 'ListAnnotationImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListAnnotationImportJobsRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequest$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListAnnotationImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoreVersionsFilter' => [ 'base' => '

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

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

A filter to apply to the list of annotation store versions.

', ], ], 'ListAnnotationStoreVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoreVersionsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoreVersionsRequest$maxResults' => '

The maximum number of annotation store versions to return in one page of results.

', ], ], 'ListAnnotationStoreVersionsRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoreVersionsRequest$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListAnnotationStoreVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoresFilter' => [ 'base' => '

A filter for annotation stores.

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

A filter to apply to the list.

', ], ], 'ListAnnotationStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnnotationStoresRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresRequest$ids' => '

IDs of stores to list.

', ], ], 'ListAnnotationStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListAnnotationStoresRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListAnnotationStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartReadSetUploadsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartReadSetUploadsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListMultipartReadSetUploadsRequest$maxResults' => '

The maximum number of multipart uploads returned in a page.

', ], ], 'ListMultipartReadSetUploadsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetActivationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetActivationJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetActivationJobsRequest$maxResults' => '

The maximum number of read set activation jobs to return in one page of results.

', ], ], 'ListReadSetActivationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetExportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetExportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListReadSetExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetImportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListReadSetImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetUploadPartsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetUploadPartsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetUploadPartsRequest$maxResults' => '

The maximum number of read set upload parts returned in a page.

', ], ], 'ListReadSetUploadPartsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReadSetsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReadSetsRequest$maxResults' => '

The maximum number of read sets to return in one page of results.

', ], ], 'ListReadSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReferenceImportJobsRequest$maxResults' => '

The maximum number of jobs to return in one page of results.

', ], ], 'ListReferenceImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReferenceStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReferenceStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListReferenceStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListReferencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListReferencesRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListReferencesRequest$maxResults' => '

The maximum number of references to return in one page of results.

', ], ], 'ListReferencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRunGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRunGroupsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListRunGroupsRequest$maxResults' => '

The maximum number of run groups to return in one page of results.

', ], ], 'ListRunGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRunTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRunTasksRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListRunTasksRequest$maxResults' => '

The maximum number of run tasks to return in one page of results.

', ], ], 'ListRunTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRunsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListRunsRequest$maxResults' => '

The maximum number of runs to return in one page of results.

', ], ], 'ListRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSequenceStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSequenceStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListSequenceStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListSequenceStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSharesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSharesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantImportJobsFilter' => [ 'base' => '

A filter for variant import jobs.

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

A filter to apply to the list.

', ], ], 'ListVariantImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantImportJobsRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsRequest$ids' => '

A list of job IDs.

', ], ], 'ListVariantImportJobsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsRequest$maxResults' => '

The maximum number of import jobs to return in one page of results.

', ], ], 'ListVariantImportJobsRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListVariantImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantStoresFilter' => [ 'base' => '

A filter for variant stores.

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

A filter to apply to the list.

', ], ], 'ListVariantStoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVariantStoresRequestIdsList' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresRequest$ids' => '

A list of store IDs.

', ], ], 'ListVariantStoresRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresRequest$maxResults' => '

The maximum number of stores to return in one page of results.

', ], ], 'ListVariantStoresRequestNextTokenString' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', ], ], 'ListVariantStoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsRequest$maxResults' => '

The maximum number of workflows to return in one page of results.

', ], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$storeSizeBytes' => '

The store\'s size in bytes.

', 'AnnotationStoreVersionItem$versionSizeBytes' => '

The size of an annotation store version in Bytes.

', 'GetAnnotationStoreResponse$storeSizeBytes' => '

The store\'s size in bytes.

', 'GetAnnotationStoreVersionResponse$versionSizeBytes' => '

The size of the annotation store version in Bytes.

', 'GetVariantStoreResponse$storeSizeBytes' => '

The store\'s size in bytes.

', 'SequenceInformation$totalReadCount' => '

The sequence\'s total read count.

', 'SequenceInformation$totalBaseCount' => '

The sequence\'s total base count.

', 'VariantStoreItem$storeSizeBytes' => '

The store\'s size in bytes.

', ], ], 'Md5' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$md5' => '

The reference\'s MD5 checksum.

', 'ReferenceFilter$md5' => '

An MD5 checksum to filter on.

', 'ReferenceListItem$md5' => '

The reference\'s MD5 checksum.

', ], ], 'MultipartReadSetUploadList' => [ 'base' => NULL, 'refs' => [ 'ListMultipartReadSetUploadsResponse$uploads' => '

An array of multipart uploads.

', ], ], 'MultipartReadSetUploadListItem' => [ 'base' => '

Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.

', 'refs' => [ 'MultipartReadSetUploadList$member' => NULL, ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListMultipartReadSetUploadsRequest$nextToken' => '

Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

', 'ListMultipartReadSetUploadsResponse$nextToken' => '

Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

', 'ListReadSetActivationJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetActivationJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReadSetExportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetExportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReadSetImportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetImportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReadSetUploadPartsRequest$nextToken' => '

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

', 'ListReadSetUploadPartsResponse$nextToken' => '

Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

', 'ListReadSetsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReadSetsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReferenceImportJobsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReferenceImportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReferenceStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReferenceStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListReferencesRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListReferencesResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListSequenceStoresRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListSequenceStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'NotSupportedOperationException' => [ 'base' => '

The operation is not supported by Amazon Omics, or the API does not exist.

', 'refs' => [], ], 'PrimitiveBoolean' => [ 'base' => NULL, 'refs' => [ 'DeleteAnnotationStoreRequest$force' => '

Whether to force deletion.

', 'DeleteAnnotationStoreVersionsRequest$force' => '

Forces the deletion of an annotation store version when imports are in-progress..

', 'DeleteVariantStoreRequest$force' => '

Whether to force deletion.

', ], ], 'Quote' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$quote' => '

The file\'s quote character.

', ], ], 'QuoteAll' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$quoteAll' => '

Whether all values need to be quoted, or just those that contain quotes.

', ], ], 'Range' => [ 'base' => NULL, 'refs' => [ 'GetReferenceRequest$range' => '

The range to retrieve.

', ], ], 'RangeNotSatisfiableException' => [ 'base' => '

The ranges specified in the request are not valid.

', 'refs' => [], ], 'ReadOptions' => [ 'base' => '

Read options for an annotation import job.

', 'refs' => [ 'TsvOptions$readOptions' => '

The file\'s read options.

', ], ], 'ReadSetActivationJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetSourceItem$status' => '

The source\'s status.

', ], ], 'ReadSetActivationJobStatus' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetFilter$status' => '

The filter\'s status.

', 'ActivateReadSetJobItem$status' => '

The job\'s status.

', 'GetReadSetActivationJobResponse$status' => '

The job\'s status.

', 'StartReadSetActivationJobResponse$status' => '

The job\'s status.

', ], ], 'ReadSetArn' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$arn' => '

The read set\'s ARN.

', 'ReadSetListItem$arn' => '

The read set\'s ARN.

', ], ], 'ReadSetBatchError' => [ 'base' => '

An error from a batch read set operation.

', 'refs' => [ 'ReadSetBatchErrorList$member' => NULL, ], ], 'ReadSetBatchErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteReadSetResponse$errors' => '

Errors returned by individual delete operations.

', ], ], 'ReadSetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$description' => '

The description of the read set.

', 'CreateMultipartReadSetUploadResponse$description' => '

The description of the read set.

', 'GetReadSetMetadataResponse$description' => '

The read set\'s description.

', 'ImportReadSetSourceItem$description' => '

The source\'s description.

', 'MultipartReadSetUploadListItem$description' => '

The description of a read set.

', 'ReadSetListItem$description' => '

The read set\'s description.

', 'StartReadSetImportJobSourceItem$description' => '

The source\'s description.

', ], ], 'ReadSetExportJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ExportReadSetDetail$status' => '

The set\'s status.

', ], ], 'ReadSetExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'ExportReadSetFilter$status' => '

A status to filter on.

', 'ExportReadSetJobDetail$status' => '

The job\'s status.

', 'GetReadSetExportJobResponse$status' => '

The job\'s status.

', 'StartReadSetExportJobResponse$status' => '

The job\'s status.

', ], ], 'ReadSetFile' => [ 'base' => NULL, 'refs' => [ 'GetReadSetRequest$file' => '

The file to retrieve.

', ], ], 'ReadSetFiles' => [ 'base' => '

Files in a read set.

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

The read set\'s files.

', ], ], 'ReadSetFilter' => [ 'base' => '

A filter for read sets.

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

A filter to apply to the list.

', ], ], 'ReadSetId' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetSourceItem$readSetId' => '

The source\'s read set ID.

', 'CompleteMultipartReadSetUploadResponse$readSetId' => '

The read set ID created for an uploaded read set.

', 'ExportReadSet$readSetId' => '

The set\'s ID.

', 'ExportReadSetDetail$id' => '

The set\'s ID.

', 'GetReadSetMetadataRequest$id' => '

The read set\'s ID.

', 'GetReadSetMetadataResponse$id' => '

The read set\'s ID.

', 'GetReadSetRequest$id' => '

The read set\'s ID.

', 'ReadSetBatchError$id' => '

The error\'s ID.

', 'ReadSetIdList$member' => NULL, 'ReadSetListItem$id' => '

The read set\'s ID.

', 'StartReadSetActivationJobSourceItem$readSetId' => '

The source\'s read set ID.

', ], ], 'ReadSetIdList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteReadSetRequest$ids' => '

The read sets\' IDs.

', ], ], 'ReadSetImportJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ImportReadSetSourceItem$status' => '

The source\'s status.

', ], ], 'ReadSetImportJobStatus' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobResponse$status' => '

The job\'s status.

', 'ImportReadSetFilter$status' => '

A status to filter on.

', 'ImportReadSetJobItem$status' => '

The job\'s status.

', 'StartReadSetImportJobResponse$status' => '

The job\'s status.

', ], ], 'ReadSetList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetsResponse$readSets' => '

A list of read sets.

', ], ], 'ReadSetListItem' => [ 'base' => '

A read set.

', 'refs' => [ 'ReadSetList$member' => NULL, ], ], 'ReadSetName' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$name' => '

The name of the read set.

', 'CreateMultipartReadSetUploadResponse$name' => '

The name of the read set.

', 'GetReadSetMetadataResponse$name' => '

The read set\'s name.

', 'ImportReadSetSourceItem$name' => '

The source\'s name.

', 'MultipartReadSetUploadListItem$name' => '

The name of a read set.

', 'ReadSetFilter$name' => '

A name to filter on.

', 'ReadSetListItem$name' => '

The read set\'s name.

', 'StartReadSetImportJobSourceItem$name' => '

The source\'s name.

', ], ], 'ReadSetPartSource' => [ 'base' => NULL, 'refs' => [ 'CompleteReadSetUploadPartListItem$partSource' => '

The source file of the part being uploaded.

', 'ListReadSetUploadPartsRequest$partSource' => '

The source file for the upload part.

', 'ReadSetUploadPartListItem$partSource' => '

The origin of the part being direct uploaded.

', 'UploadReadSetPartRequest$partSource' => '

The source file for an upload part.

', ], ], 'ReadSetPartStreamingBlob' => [ 'base' => NULL, 'refs' => [ 'UploadReadSetPartRequest$payload' => '

The read set data to upload for a part.

', ], ], 'ReadSetS3Access' => [ 'base' => '

The S3 URI for each read set file.

', 'refs' => [ 'FileInformation$s3Access' => '

The S3 URI metadata of a sequence store.

', ], ], 'ReadSetStatus' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$status' => '

The read set\'s status.

', 'ReadSetFilter$status' => '

A status to filter on.

', 'ReadSetListItem$status' => '

The read set\'s status.

', ], ], 'ReadSetStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetReadSetMetadataResponse$statusMessage' => '

The status message for a read set. It provides more detail as to why the read set has a status.

', 'ReadSetListItem$statusMessage' => '

The status for a read set. It provides more detail as to why the read set has a status.

', ], ], 'ReadSetStreamingBlob' => [ 'base' => NULL, 'refs' => [ 'GetReadSetResponse$payload' => '

The read set file payload.

', ], ], 'ReadSetUploadPartList' => [ 'base' => NULL, 'refs' => [ 'ListReadSetUploadPartsResponse$parts' => '

An array of upload parts.

', ], ], 'ReadSetUploadPartListFilter' => [ 'base' => '

Filter settings that select for read set upload parts of interest.

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

Attributes used to filter for a specific subset of read set part uploads.

', ], ], 'ReadSetUploadPartListItem' => [ 'base' => '

The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.

', 'refs' => [ 'ReadSetUploadPartList$member' => NULL, ], ], 'ReadSetUploadPartListItemPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'ReadSetUploadPartListItem$partNumber' => '

The number identifying the part in an upload.

', ], ], 'ReadSetUploadPartListItemPartSizeLong' => [ 'base' => NULL, 'refs' => [ 'ReadSetUploadPartListItem$partSize' => '

The size of the the part in an upload.

', ], ], 'ReferenceArn' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$referenceArn' => '

The ARN of the reference.

', 'CreateMultipartReadSetUploadResponse$referenceArn' => '

The read set source\'s reference ARN.

', 'GetReadSetMetadataResponse$referenceArn' => '

The read set\'s genome reference ARN.

', 'GetReferenceMetadataResponse$arn' => '

The reference\'s ARN.

', 'ImportReadSetSourceItem$referenceArn' => '

The source\'s genome reference ARN.

', 'MultipartReadSetUploadListItem$referenceArn' => '

The source\'s reference ARN.

', 'ReadSetListItem$referenceArn' => '

The read set\'s genome reference ARN.

', 'ReferenceItem$referenceArn' => '

The reference\'s ARN.

', 'ReferenceListItem$arn' => '

The reference\'s ARN.

', 'StartReadSetImportJobSourceItem$referenceArn' => '

The source\'s reference ARN.

', ], ], 'ReferenceArnFilter' => [ 'base' => NULL, 'refs' => [ 'ReadSetFilter$referenceArn' => '

A genome reference ARN to filter on.

', ], ], 'ReferenceDescription' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$description' => '

The reference\'s description.

', 'ImportReferenceSourceItem$description' => '

The source\'s description.

', 'ReferenceListItem$description' => '

The reference\'s description.

', 'StartReferenceImportJobSourceItem$description' => '

The source\'s description.

', ], ], 'ReferenceFile' => [ 'base' => NULL, 'refs' => [ 'GetReferenceRequest$file' => '

The file to retrieve.

', ], ], 'ReferenceFiles' => [ 'base' => '

A set of genome reference files.

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

The reference\'s files.

', ], ], 'ReferenceFilter' => [ 'base' => '

A filter for references.

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

A filter to apply to the list.

', ], ], 'ReferenceId' => [ 'base' => NULL, 'refs' => [ 'DeleteReferenceRequest$id' => '

The reference\'s ID.

', 'GetReferenceMetadataRequest$id' => '

The reference\'s ID.

', 'GetReferenceMetadataResponse$id' => '

The reference\'s ID.

', 'GetReferenceRequest$id' => '

The reference\'s ID.

', 'ReferenceListItem$id' => '

The reference\'s ID.

', ], ], 'ReferenceImportJobItemStatus' => [ 'base' => NULL, 'refs' => [ 'ImportReferenceSourceItem$status' => '

The source\'s status.

', ], ], 'ReferenceImportJobStatus' => [ 'base' => NULL, 'refs' => [ 'GetReferenceImportJobResponse$status' => '

The job\'s status.

', 'ImportReferenceFilter$status' => '

A status to filter on.

', 'ImportReferenceJobItem$status' => '

The job\'s status.

', 'StartReferenceImportJobResponse$status' => '

The job\'s status.

', ], ], 'ReferenceItem' => [ 'base' => '

A genome reference.

', 'refs' => [ 'AnnotationStoreItem$reference' => '

The store\'s genome reference.

', 'CreateAnnotationStoreRequest$reference' => '

The genome reference for the store\'s annotations.

', 'CreateAnnotationStoreResponse$reference' => '

The store\'s genome reference. Required for all stores except TSV format with generic annotations.

', 'CreateVariantStoreRequest$reference' => '

The genome reference for the store\'s variants.

', 'CreateVariantStoreResponse$reference' => '

The store\'s genome reference.

', 'GetAnnotationStoreResponse$reference' => '

The store\'s genome reference.

', 'GetVariantStoreResponse$reference' => '

The store\'s genome reference.

', 'UpdateAnnotationStoreResponse$reference' => '

The store\'s genome reference.

', 'UpdateVariantStoreResponse$reference' => '

The store\'s genome reference.

', 'VariantStoreItem$reference' => '

The store\'s genome reference.

', ], ], 'ReferenceList' => [ 'base' => NULL, 'refs' => [ 'ListReferencesResponse$references' => '

A list of references.

', ], ], 'ReferenceListItem' => [ 'base' => '

A genome reference.

', 'refs' => [ 'ReferenceList$member' => NULL, ], ], 'ReferenceName' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$name' => '

The reference\'s name.

', 'ImportReferenceSourceItem$name' => '

The source\'s name.

', 'ReferenceFilter$name' => '

A name to filter on.

', 'ReferenceListItem$name' => '

The reference\'s name.

', 'StartReferenceImportJobSourceItem$name' => '

The source\'s name.

', ], ], 'ReferenceStatus' => [ 'base' => NULL, 'refs' => [ 'GetReferenceMetadataResponse$status' => '

The reference\'s status.

', 'ReferenceListItem$status' => '

The reference\'s status.

', ], ], 'ReferenceStoreArn' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreResponse$arn' => '

The store\'s ARN.

', 'GetReferenceStoreResponse$arn' => '

The store\'s ARN.

', 'ReferenceStoreDetail$arn' => '

The store\'s ARN.

', ], ], 'ReferenceStoreDescription' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreRequest$description' => '

A description for the store.

', 'CreateReferenceStoreResponse$description' => '

The store\'s description.

', 'GetReferenceStoreResponse$description' => '

The store\'s description.

', 'ReferenceStoreDetail$description' => '

The store\'s description.

', ], ], 'ReferenceStoreDetail' => [ 'base' => '

Details about a reference store.

', 'refs' => [ 'ReferenceStoreDetailList$member' => NULL, ], ], 'ReferenceStoreDetailList' => [ 'base' => NULL, 'refs' => [ 'ListReferenceStoresResponse$referenceStores' => '

A list of reference stores.

', ], ], 'ReferenceStoreFilter' => [ 'base' => '

A filter for reference stores.

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

A filter to apply to the list.

', ], ], 'ReferenceStoreId' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreResponse$id' => '

The store\'s ID.

', 'DeleteReferenceRequest$referenceStoreId' => '

The reference\'s store ID.

', 'DeleteReferenceStoreRequest$id' => '

The store\'s ID.

', 'GetReferenceImportJobRequest$referenceStoreId' => '

The job\'s reference store ID.

', 'GetReferenceImportJobResponse$referenceStoreId' => '

The job\'s reference store ID.

', 'GetReferenceMetadataRequest$referenceStoreId' => '

The reference\'s reference store ID.

', 'GetReferenceMetadataResponse$referenceStoreId' => '

The reference\'s reference store ID.

', 'GetReferenceRequest$referenceStoreId' => '

The reference\'s store ID.

', 'GetReferenceStoreRequest$id' => '

The store\'s ID.

', 'GetReferenceStoreResponse$id' => '

The store\'s ID.

', 'ImportReferenceJobItem$referenceStoreId' => '

The job\'s reference store ID.

', 'ListReferenceImportJobsRequest$referenceStoreId' => '

The job\'s reference store ID.

', 'ListReferencesRequest$referenceStoreId' => '

The references\' reference store ID.

', 'ReferenceListItem$referenceStoreId' => '

The reference\'s store ID.

', 'ReferenceStoreDetail$id' => '

The store\'s ID.

', 'StartReferenceImportJobRequest$referenceStoreId' => '

The job\'s reference store ID.

', 'StartReferenceImportJobResponse$referenceStoreId' => '

The job\'s reference store ID.

', ], ], 'ReferenceStoreName' => [ 'base' => NULL, 'refs' => [ 'CreateReferenceStoreRequest$name' => '

A name for the store.

', 'CreateReferenceStoreResponse$name' => '

The store\'s name.

', 'GetReferenceStoreResponse$name' => '

The store\'s name.

', 'ReferenceStoreDetail$name' => '

The store\'s name.

', 'ReferenceStoreFilter$name' => '

The name to filter on.

', ], ], 'ReferenceStreamingBlob' => [ 'base' => NULL, 'refs' => [ 'GetReferenceResponse$payload' => '

The reference file payload.

', ], ], 'RequestTimeoutException' => [ 'base' => '

The request timed out.

', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$id' => '

The store\'s ID.

', 'AnnotationStoreVersionItem$storeId' => '

The store ID for an annotation store version.

', 'AnnotationStoreVersionItem$id' => '

The annotation store version ID.

', 'CancelAnnotationImportRequest$jobId' => '

The job\'s ID.

', 'CancelVariantImportRequest$jobId' => '

The job\'s ID.

', 'CreateAnnotationStoreResponse$id' => '

The store\'s ID.

', 'CreateAnnotationStoreVersionResponse$id' => '

A generated ID for the annotation store

', 'CreateAnnotationStoreVersionResponse$storeId' => '

The ID for the annotation store from which new versions are being created.

', 'CreateVariantStoreResponse$id' => '

The store\'s ID.

', 'GetAnnotationImportRequest$jobId' => '

The job\'s ID.

', 'GetAnnotationImportResponse$id' => '

The job\'s ID.

', 'GetAnnotationStoreResponse$id' => '

The store\'s ID.

', 'GetAnnotationStoreVersionResponse$storeId' => '

The store ID for annotation store version.

', 'GetAnnotationStoreVersionResponse$id' => '

The annotation store version ID.

', 'GetVariantImportRequest$jobId' => '

The job\'s ID.

', 'GetVariantImportResponse$id' => '

The job\'s ID.

', 'GetVariantStoreResponse$id' => '

The store\'s ID.

', 'StartAnnotationImportResponse$jobId' => '

The job\'s ID.

', 'StartVariantImportResponse$jobId' => '

The job\'s ID.

', 'UpdateAnnotationStoreResponse$id' => '

The store\'s ID.

', 'UpdateAnnotationStoreVersionResponse$storeId' => '

The annotation store ID.

', 'UpdateAnnotationStoreVersionResponse$id' => '

The annotation store version ID.

', 'UpdateVariantStoreResponse$id' => '

The store\'s ID.

', 'VariantStoreItem$id' => '

The store\'s ID.

', ], ], 'ResourceIdentifier' => [ 'base' => NULL, 'refs' => [ 'ListAnnotationImportJobsRequestIdsList$member' => NULL, 'ListAnnotationStoresRequestIdsList$member' => NULL, 'ListVariantImportJobsRequestIdsList$member' => NULL, 'ListVariantStoresRequestIdsList$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => '

The target resource was not found in the current Region.

', 'refs' => [], ], 'ResourceOwner' => [ 'base' => NULL, 'refs' => [ 'ListSharesRequest$resourceOwner' => '

The account that owns the resource shares.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'GetReadSetImportJobResponse$roleArn' => '

The job\'s service role ARN.

', 'GetReferenceImportJobResponse$roleArn' => '

The job\'s service role ARN.

', 'ImportReadSetJobItem$roleArn' => '

The job\'s service role ARN.

', 'ImportReferenceJobItem$roleArn' => '

The job\'s service role ARN.

', 'StartReadSetExportJobRequest$roleArn' => '

A service role for the job.

', 'StartReadSetImportJobRequest$roleArn' => '

A service role for the job.

', 'StartReadSetImportJobResponse$roleArn' => '

The job\'s service role ARN.

', 'StartReferenceImportJobRequest$roleArn' => '

A service role for the job.

', 'StartReferenceImportJobResponse$roleArn' => '

The job\'s service role ARN.

', ], ], 'RunArn' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$arn' => '

The run\'s ARN.

', 'RunListItem$arn' => '

The run\'s ARN.

', 'StartRunResponse$arn' => '

The run\'s ARN.

', ], ], 'RunExport' => [ 'base' => NULL, 'refs' => [ 'RunExportList$member' => NULL, ], ], 'RunExportList' => [ 'base' => NULL, 'refs' => [ 'GetRunRequest$export' => '

The run\'s export format.

', ], ], 'RunFailureReason' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$failureReason' => '

The reason a run has failed.

', ], ], 'RunGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupResponse$arn' => '

The group\'s ARN.

', 'GetRunGroupResponse$arn' => '

The group\'s ARN.

', 'RunGroupListItem$arn' => '

The group\'s ARN.

', ], ], 'RunGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupResponse$id' => '

The group\'s ID.

', 'DeleteRunGroupRequest$id' => '

The run group\'s ID.

', 'GetRunGroupRequest$id' => '

The group\'s ID.

', 'GetRunGroupResponse$id' => '

The group\'s ID.

', 'GetRunResponse$runGroupId' => '

The run\'s group ID.

', 'ListRunsRequest$runGroupId' => '

Filter the list by run group ID.

', 'RunGroupListItem$id' => '

The group\'s ID.

', 'StartRunRequest$runGroupId' => '

The run\'s group ID.

', 'UpdateRunGroupRequest$id' => '

The group\'s ID.

', ], ], 'RunGroupList' => [ 'base' => NULL, 'refs' => [ 'ListRunGroupsResponse$items' => '

A list of groups.

', ], ], 'RunGroupListItem' => [ 'base' => '

A run group.

', 'refs' => [ 'RunGroupList$member' => NULL, ], ], 'RunGroupListItemMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxCpus' => '

The group\'s maximum CPU count setting.

', ], ], 'RunGroupListItemMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxDuration' => '

The group\'s maximum duration setting in minutes.

', ], ], 'RunGroupListItemMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'RunGroupListItemMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'RunGroupListItem$maxRuns' => '

The group\'s maximum concurrent run setting.

', ], ], 'RunGroupListToken' => [ 'base' => NULL, 'refs' => [ 'ListRunGroupsRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRunGroupsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'RunGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$name' => '

A name for the group.

', 'GetRunGroupResponse$name' => '

The group\'s name.

', 'ListRunGroupsRequest$name' => '

The run groups\' name.

', 'RunGroupListItem$name' => '

The group\'s name.

', 'UpdateRunGroupRequest$name' => '

A name for the group.

', ], ], 'RunGroupRequestId' => [ 'base' => NULL, 'refs' => [ 'CreateRunGroupRequest$requestId' => '

To ensure that requests don\'t run multiple times, specify a unique ID for each request.

', ], ], 'RunGroupTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetRunGroupResponse$creationTime' => '

When the group was created.

', 'RunGroupListItem$creationTime' => '

When the group was created.

', ], ], 'RunId' => [ 'base' => NULL, 'refs' => [ 'CancelRunRequest$id' => '

The run\'s ID.

', 'DeleteRunRequest$id' => '

The run\'s ID.

', 'GetRunRequest$id' => '

The run\'s ID.

', 'GetRunResponse$id' => '

The run\'s ID.

', 'GetRunResponse$runId' => '

The run\'s ID.

', 'GetRunTaskRequest$id' => '

The workflow run ID.

', 'ListRunTasksRequest$id' => '

The run\'s ID.

', 'RunListItem$id' => '

The run\'s ID.

', 'StartRunRequest$runId' => '

The ID of a run to duplicate.

', 'StartRunResponse$id' => '

The run\'s ID.

', ], ], 'RunLeftNormalization' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$runLeftNormalization' => '

The job\'s left normalization setting.

', 'GetAnnotationImportResponse$runLeftNormalization' => '

The job\'s left normalization setting.

', 'GetVariantImportResponse$runLeftNormalization' => '

The job\'s left normalization setting.

', 'StartAnnotationImportRequest$runLeftNormalization' => '

The job\'s left normalization setting.

', 'StartVariantImportRequest$runLeftNormalization' => '

The job\'s left normalization setting.

', 'VariantImportJobItem$runLeftNormalization' => '

The job\'s left normalization setting.

', ], ], 'RunList' => [ 'base' => NULL, 'refs' => [ 'ListRunsResponse$items' => '

A list of runs.

', ], ], 'RunListItem' => [ 'base' => '

A workflow run.

', 'refs' => [ 'RunList$member' => NULL, ], ], 'RunListItemPriorityInteger' => [ 'base' => NULL, 'refs' => [ 'RunListItem$priority' => '

The run\'s priority.

', ], ], 'RunListItemStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'RunListItem$storageCapacity' => '

The run\'s storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

', ], ], 'RunListToken' => [ 'base' => NULL, 'refs' => [ 'ListRunsRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRunsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'RunLogLevel' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$logLevel' => '

The run\'s log level.

', 'StartRunRequest$logLevel' => '

A log level for the run.

', ], ], 'RunLogLocation' => [ 'base' => '

The URI for the run log.

', 'refs' => [ 'GetRunResponse$logLocation' => '

The location of the run log.

', ], ], 'RunLogStream' => [ 'base' => NULL, 'refs' => [ 'RunLogLocation$runLogStream' => '

The log stream ARN for the run log.

', ], ], 'RunName' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$name' => '

The run\'s name.

', 'ListRunsRequest$name' => '

Filter the list by run name.

', 'RunListItem$name' => '

The run\'s name.

', 'StartRunRequest$name' => '

A name for the run.

', ], ], 'RunOutputUri' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$outputUri' => '

The run\'s output URI.

', 'GetRunResponse$runOutputUri' => '

The destination for workflow outputs.

', 'StartRunRequest$outputUri' => '

An output URI for the run.

', 'StartRunResponse$runOutputUri' => '

The destination for workflow outputs.

', ], ], 'RunParameters' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$parameters' => '

The run\'s parameters.

', 'StartRunRequest$parameters' => '

Parameters for the run.

', ], ], 'RunRequestId' => [ 'base' => NULL, 'refs' => [ 'StartRunRequest$requestId' => '

To ensure that requests don\'t run multiple times, specify a unique ID for each request.

', ], ], 'RunResourceDigest' => [ 'base' => NULL, 'refs' => [ 'RunResourceDigests$value' => NULL, ], ], 'RunResourceDigestKey' => [ 'base' => NULL, 'refs' => [ 'RunResourceDigests$key' => NULL, ], ], 'RunResourceDigests' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$resourceDigests' => '

The run\'s resource digests.

', ], ], 'RunRetentionMode' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$retentionMode' => '

The run\'s retention mode.

', 'StartRunRequest$retentionMode' => '

The retention mode for the run.

', ], ], 'RunRoleArn' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$roleArn' => '

The run\'s service role ARN.

', 'StartRunRequest$roleArn' => '

A service role for the run.

', ], ], 'RunStartedBy' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$startedBy' => '

Who started the run.

', ], ], 'RunStatus' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$status' => '

The run\'s status.

', 'ListRunsRequest$status' => '

The status of a run.

', 'RunListItem$status' => '

The run\'s status.

', 'StartRunResponse$status' => '

The run\'s status.

', ], ], 'RunStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$statusMessage' => '

The run\'s status message.

', ], ], 'RunTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$creationTime' => '

When the run was created.

', 'GetRunResponse$startTime' => '

When the run started.

', 'GetRunResponse$stopTime' => '

The run\'s stop time.

', 'RunListItem$creationTime' => '

When the run was created.

', 'RunListItem$startTime' => '

When the run started.

', 'RunListItem$stopTime' => '

When the run stopped.

', ], ], 'RunUuid' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$uuid' => '

The universally unique identifier for a run.

', 'StartRunResponse$uuid' => '

The universally unique identifier for a run.

', ], ], 'S3AccessPointArn' => [ 'base' => NULL, 'refs' => [ 'SequenceStoreS3Access$s3AccessPointArn' => '

This is ARN of the access point associated with the S3 bucket storing read sets.

', ], ], 'S3Destination' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'CreateSequenceStoreResponse$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'ExportReadSetJobDetail$destination' => '

The job\'s destination in Amazon S3.

', 'GetReadSetExportJobResponse$destination' => '

The job\'s destination in Amazon S3.

', 'GetSequenceStoreResponse$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'SequenceStoreDetail$fallbackLocation' => '

An S3 location that is used to store files that have failed a direct upload.

', 'StartReadSetExportJobRequest$destination' => '

A location for exported files in Amazon S3.

', 'StartReadSetExportJobResponse$destination' => '

The job\'s output location.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportItemDetail$source' => '

The source file\'s location in Amazon S3.

', 'AnnotationImportItemSource$source' => '

The source file\'s location in Amazon S3.

', 'ImportReferenceSourceItem$sourceFile' => '

The source file\'s location in Amazon S3.

', 'ReadSetS3Access$s3Uri' => '

The S3 URI for each read set file.

', 'SequenceStoreS3Access$s3Uri' => '

The S3 URI of the sequence store.

', 'SourceFiles$source1' => '

The location of the first file in Amazon S3.

', 'SourceFiles$source2' => '

The location of the second file in Amazon S3.

', 'StartReferenceImportJobSourceItem$sourceFile' => '

The source file\'s location in Amazon S3.

', 'VariantImportItemDetail$source' => '

The source file\'s location in Amazon S3.

', 'VariantImportItemSource$source' => '

The source file\'s location in Amazon S3.

', ], ], 'SampleId' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$sampleId' => '

The source\'s sample ID.

', 'CreateMultipartReadSetUploadResponse$sampleId' => '

The source\'s sample ID.

', 'GetReadSetMetadataResponse$sampleId' => '

The read set\'s sample ID.

', 'ImportReadSetSourceItem$sampleId' => '

The source\'s sample ID.

', 'MultipartReadSetUploadListItem$sampleId' => '

The read set source\'s sample ID.

', 'ReadSetFilter$sampleId' => '

The read set source\'s sample ID.

', 'ReadSetListItem$sampleId' => '

The read set\'s sample ID.

', 'StartReadSetImportJobSourceItem$sampleId' => '

The source\'s sample ID.

', ], ], 'SchemaItem' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptionsSchemaList$member' => NULL, 'TsvVersionOptionsSchemaList$member' => NULL, ], ], 'SchemaItemKeyString' => [ 'base' => NULL, 'refs' => [ 'SchemaItem$key' => NULL, ], ], 'SchemaValueType' => [ 'base' => NULL, 'refs' => [ 'SchemaItem$value' => NULL, ], ], 'Separator' => [ 'base' => NULL, 'refs' => [ 'ReadOptions$sep' => '

The file\'s field separator.

', ], ], 'SequenceInformation' => [ 'base' => '

Details about a sequence.

', 'refs' => [ 'GetReadSetMetadataResponse$sequenceInformation' => '

The read set\'s sequence information.

', 'ReadSetListItem$sequenceInformation' => NULL, ], ], 'SequenceStoreArn' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreResponse$arn' => '

The store\'s ARN.

', 'GetSequenceStoreResponse$arn' => '

The store\'s ARN.

', 'SequenceStoreDetail$arn' => '

The store\'s ARN.

', ], ], 'SequenceStoreDescription' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$description' => '

A description for the store.

', 'CreateSequenceStoreResponse$description' => '

The store\'s description.

', 'GetSequenceStoreResponse$description' => '

The store\'s description.

', 'SequenceStoreDetail$description' => '

The store\'s description.

', ], ], 'SequenceStoreDetail' => [ 'base' => '

Details about a sequence store.

', 'refs' => [ 'SequenceStoreDetailList$member' => NULL, ], ], 'SequenceStoreDetailList' => [ 'base' => NULL, 'refs' => [ 'ListSequenceStoresResponse$sequenceStores' => '

A list of sequence stores.

', ], ], 'SequenceStoreFilter' => [ 'base' => '

A filter for a sequence store.

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

A filter to apply to the list.

', ], ], 'SequenceStoreId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartReadSetUploadRequest$sequenceStoreId' => '

The sequence store ID for the store involved in the multipart upload.

', 'ActivateReadSetJobItem$sequenceStoreId' => '

The job\'s sequence store ID.

', 'BatchDeleteReadSetRequest$sequenceStoreId' => '

The read sets\' sequence store ID.

', 'CompleteMultipartReadSetUploadRequest$sequenceStoreId' => '

The sequence store ID for the store involved in the multipart upload.

', 'CreateMultipartReadSetUploadRequest$sequenceStoreId' => '

The sequence store ID for the store that is the destination of the multipart uploads.

', 'CreateMultipartReadSetUploadResponse$sequenceStoreId' => '

The sequence store ID for the store that the read set will be created in.

', 'CreateSequenceStoreResponse$id' => '

The store\'s ID.

', 'DeleteSequenceStoreRequest$id' => '

The sequence store\'s ID.

', 'ExportReadSetJobDetail$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetActivationJobRequest$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetActivationJobResponse$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetExportJobRequest$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetExportJobResponse$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetImportJobRequest$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetImportJobResponse$sequenceStoreId' => '

The job\'s sequence store ID.

', 'GetReadSetMetadataRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'GetReadSetMetadataResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'GetReadSetRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'GetSequenceStoreRequest$id' => '

The store\'s ID.

', 'GetSequenceStoreResponse$id' => '

The store\'s ID.

', 'ImportReadSetJobItem$sequenceStoreId' => '

The job\'s sequence store ID.

', 'ListMultipartReadSetUploadsRequest$sequenceStoreId' => '

The Sequence Store ID used for the multipart uploads.

', 'ListReadSetActivationJobsRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'ListReadSetExportJobsRequest$sequenceStoreId' => '

The jobs\' sequence store ID.

', 'ListReadSetImportJobsRequest$sequenceStoreId' => '

The jobs\' sequence store ID.

', 'ListReadSetUploadPartsRequest$sequenceStoreId' => '

The Sequence Store ID used for the multipart uploads.

', 'ListReadSetsRequest$sequenceStoreId' => '

The jobs\' sequence store ID.

', 'MultipartReadSetUploadListItem$sequenceStoreId' => '

The sequence store ID used for the multipart upload.

', 'ReadSetListItem$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'SequenceStoreDetail$id' => '

The store\'s ID.

', 'StartReadSetActivationJobRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetActivationJobResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetExportJobRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetExportJobResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetImportJobRequest$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'StartReadSetImportJobResponse$sequenceStoreId' => '

The read set\'s sequence store ID.

', 'UploadReadSetPartRequest$sequenceStoreId' => '

The Sequence Store ID used for the multipart upload.

', ], ], 'SequenceStoreName' => [ 'base' => NULL, 'refs' => [ 'CreateSequenceStoreRequest$name' => '

A name for the store.

', 'CreateSequenceStoreResponse$name' => '

The store\'s name.

', 'GetSequenceStoreResponse$name' => '

The store\'s name.

', 'SequenceStoreDetail$name' => '

The store\'s name.

', 'SequenceStoreFilter$name' => '

A name to filter on.

', ], ], 'SequenceStoreS3Access' => [ 'base' => '

The S3 access metadata of the sequence store.

', 'refs' => [ 'GetSequenceStoreResponse$s3Access' => '

The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.

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

The request exceeds a service quota.

', 'refs' => [], ], 'ShareDetails' => [ 'base' => '

The details of a resource share.

', 'refs' => [ 'GetShareResponse$share' => '

A resource share details object. The object includes the status, the resourceArn, and ownerId.

', 'ShareDetailsList$member' => NULL, ], ], 'ShareDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListSharesResponse$shares' => '

The shares available and their metadata details.

', ], ], 'ShareName' => [ 'base' => NULL, 'refs' => [ 'CreateShareRequest$shareName' => '

A name that the owner defines for the share.

', 'CreateShareResponse$shareName' => '

The name of the share.

', 'ShareDetails$shareName' => '

The name of the resource share.

', ], ], 'ShareResourceType' => [ 'base' => NULL, 'refs' => [ 'TypeList$member' => NULL, ], ], 'ShareStatus' => [ 'base' => NULL, 'refs' => [ 'AcceptShareResponse$status' => '

The status of the resource share.

', 'CreateShareResponse$status' => '

The status of the share.

', 'DeleteShareResponse$status' => '

The status of the share being deleted.

', 'ShareDetails$status' => '

The status of the share.

', 'StatusList$member' => NULL, ], ], 'SourceFiles' => [ 'base' => '

Source files for a sequence.

', 'refs' => [ 'ImportReadSetSourceItem$sourceFiles' => '

The source files\' location in Amazon S3.

', 'StartReadSetImportJobSourceItem$sourceFiles' => '

The source files\' location in Amazon S3.

', ], ], 'SseConfig' => [ 'base' => '

Server-side encryption (SSE) settings for a store.

', 'refs' => [ 'AnnotationStoreItem$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'CreateAnnotationStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'CreateReferenceStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'CreateReferenceStoreResponse$sseConfig' => '

The store\'s SSE settings.

', 'CreateSequenceStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'CreateSequenceStoreResponse$sseConfig' => '

The store\'s SSE settings.

', 'CreateVariantStoreRequest$sseConfig' => '

Server-side encryption (SSE) settings for the store.

', 'GetAnnotationStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'GetReferenceStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'GetSequenceStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'GetVariantStoreResponse$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'ReferenceStoreDetail$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'SequenceStoreDetail$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', 'VariantStoreItem$sseConfig' => '

The store\'s server-side encryption (SSE) settings.

', ], ], 'SseConfigKeyArnString' => [ 'base' => NULL, 'refs' => [ 'SseConfig$keyArn' => '

An encryption key ARN.

', ], ], 'StartAnnotationImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAnnotationImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetActivationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetActivationJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReadSetActivationJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReadSetActivationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetActivationJobSourceItem' => [ 'base' => '

A source for a read set activation job.

', 'refs' => [ 'StartReadSetActivationJobRequestSourcesList$member' => NULL, ], ], 'StartReadSetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetExportJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReadSetExportJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReadSetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetImportJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReadSetImportJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReadSetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReadSetImportJobSourceItem' => [ 'base' => '

A source for a read set import job.

', 'refs' => [ 'StartReadSetImportJobRequestSourcesList$member' => NULL, ], ], 'StartReferenceImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartReferenceImportJobRequestSourcesList' => [ 'base' => NULL, 'refs' => [ 'StartReferenceImportJobRequest$sources' => '

The job\'s source files.

', ], ], 'StartReferenceImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartReferenceImportJobSourceItem' => [ 'base' => '

A source for a reference import job.

', 'refs' => [ 'StartReferenceImportJobRequestSourcesList$member' => NULL, ], ], 'StartRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRunRequestPriorityInteger' => [ 'base' => NULL, 'refs' => [ 'StartRunRequest$priority' => '

A priority for the run.

', ], ], 'StartRunRequestStorageCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'StartRunRequest$storageCapacity' => '

A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

', ], ], 'StartRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartVariantImportRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartVariantImportResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusList' => [ 'base' => NULL, 'refs' => [ 'Filter$status' => '

Filter based on the resource status. You can specify up to 10 values.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$statusMessage' => '

The store\'s status message.

', 'AnnotationStoreVersionItem$statusMessage' => '

The status of an annotation store version.

', 'GetAnnotationStoreResponse$statusMessage' => '

A status message.

', 'GetAnnotationStoreVersionResponse$statusMessage' => '

The status of an annotation store version.

', 'GetVariantStoreResponse$statusMessage' => '

The store\'s status message.

', 'ShareDetails$statusMessage' => '

The status message for a resource share. It provides additional details about the share status.

', 'VariantStoreItem$statusMessage' => '

The store\'s status message.

', ], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$storageType' => '

The run\'s storage type.

', 'RunListItem$storageType' => '

The run\'s storage type.

', 'StartRunRequest$storageType' => '

The run\'s storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

', ], ], 'StoreFormat' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$storeFormat' => '

The store\'s file format.

', 'CreateAnnotationStoreRequest$storeFormat' => '

The annotation file format of the store.

', 'CreateAnnotationStoreResponse$storeFormat' => '

The annotation file format of the store.

', 'GetAnnotationStoreResponse$storeFormat' => '

The store\'s annotation file format.

', 'UpdateAnnotationStoreResponse$storeFormat' => '

The annotation file format of the store.

', ], ], 'StoreName' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreVersionItem$name' => '

A name given to an annotation store version to distinguish it from others.

', 'CreateAnnotationStoreRequest$name' => '

A name for the store.

', 'CreateAnnotationStoreVersionRequest$name' => '

The name of an annotation store version from which versions are being created.

', 'CreateAnnotationStoreVersionResponse$name' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateVariantStoreRequest$name' => '

A name for the store.

', 'GetAnnotationImportResponse$destinationName' => '

The job\'s destination annotation store.

', 'GetAnnotationStoreVersionResponse$name' => '

The name of the annotation store.

', 'GetVariantImportResponse$destinationName' => '

The job\'s destination variant store.

', 'StartAnnotationImportRequest$destinationName' => '

A destination annotation store for the job.

', 'StartVariantImportRequest$destinationName' => '

The destination variant store for the job.

', 'UpdateAnnotationStoreVersionResponse$name' => '

The name of an annotation store.

', ], ], 'StoreOptions' => [ 'base' => '

Settings for a store.

', 'refs' => [ 'CreateAnnotationStoreRequest$storeOptions' => '

File parsing options for the annotation store.

', 'CreateAnnotationStoreResponse$storeOptions' => '

The store\'s file parsing options.

', 'GetAnnotationStoreResponse$storeOptions' => '

The store\'s parsing options.

', 'UpdateAnnotationStoreResponse$storeOptions' => '

Parsing options for the store.

', ], ], 'StoreStatus' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreItem$status' => '

The store\'s status.

', 'CreateAnnotationStoreResponse$status' => '

The store\'s status.

', 'CreateVariantStoreResponse$status' => '

The store\'s status.

', 'DeleteAnnotationStoreResponse$status' => '

The store\'s status.

', 'DeleteVariantStoreResponse$status' => '

The store\'s status.

', 'GetAnnotationStoreResponse$status' => '

The store\'s status.

', 'GetVariantStoreResponse$status' => '

The store\'s status.

', 'ListAnnotationStoresFilter$status' => '

A status to filter on.

', 'ListVariantStoresFilter$status' => '

A status to filter on.

', 'UpdateAnnotationStoreResponse$status' => '

The store\'s status.

', 'UpdateVariantStoreResponse$status' => '

The store\'s status.

', 'VariantStoreItem$status' => '

The store\'s status.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AcceptShareRequest$shareId' => '

The ID of the resource share.

', 'AccessDeniedException$message' => NULL, 'AnnotationImportJobItem$id' => '

The job\'s ID.

', 'AnnotationImportJobItem$destinationName' => '

The job\'s destination annotation store.

', 'AnnotationStoreItem$name' => '

The store\'s name.

', 'ArnList$member' => NULL, 'ConflictException$message' => NULL, 'CreateAnnotationStoreResponse$name' => '

The store\'s name.

', 'CreateShareRequest$resourceArn' => '

The ARN of the resource to be shared.

', 'CreateShareRequest$principalSubscriber' => '

The principal subscriber is the account being offered shared access to the resource.

', 'CreateShareResponse$shareId' => '

The ID that HealthOmics generates for the share.

', 'CreateVariantStoreResponse$name' => '

The store\'s name.

', 'DeleteAnnotationStoreRequest$name' => '

The store\'s name.

', 'DeleteAnnotationStoreVersionsRequest$name' => '

The name of the annotation store from which versions are being deleted.

', 'DeleteShareRequest$shareId' => '

The ID for the resource share to be deleted.

', 'DeleteVariantStoreRequest$name' => '

The store\'s name.

', 'ETag$source1' => '

The ETag hash calculated on Source1 of the read set.

', 'ETag$source2' => '

The ETag hash calculated on Source2 of the read set.

', 'GetAnnotationStoreRequest$name' => '

The store\'s name.

', 'GetAnnotationStoreResponse$name' => '

The store\'s name.

', 'GetAnnotationStoreVersionRequest$name' => '

The name given to an annotation store version to distinguish it from others.

', 'GetAnnotationStoreVersionRequest$versionName' => '

The name given to an annotation store version to distinguish it from others.

', 'GetShareRequest$shareId' => '

The ID of the share.

', 'GetVariantStoreRequest$name' => '

The store\'s name.

', 'GetVariantStoreResponse$name' => '

The store\'s name.

', 'InternalServerException$message' => NULL, 'ListAnnotationImportJobsFilter$storeName' => '

A store name to filter on.

', 'ListAnnotationImportJobsResponse$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', 'ListAnnotationStoreVersionsRequest$name' => '

The name of an annotation store.

', 'ListAnnotationStoreVersionsResponse$nextToken' => '

Specifies the pagination token from a previous request to retrieve the next page of results.

', 'ListAnnotationStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListSharesRequest$nextToken' => '

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

', 'ListSharesResponse$nextToken' => '

Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

', 'ListVariantImportJobsFilter$storeName' => '

A store name to filter on.

', 'ListVariantImportJobsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'ListVariantStoresResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', 'NotSupportedOperationException$message' => NULL, 'RangeNotSatisfiableException$message' => NULL, 'ReadSetBatchError$code' => '

The error\'s code.

', 'ReadSetBatchError$message' => '

The error\'s message.

', 'ReadSetUploadPartListItem$checksum' => '

A unique identifier used to confirm that parts are being added to the correct upload.

', 'RequestTimeoutException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'SequenceInformation$alignment' => '

The sequence\'s alignment setting.

', 'ServiceQuotaExceededException$message' => NULL, 'ShareDetails$shareId' => '

The ID of the resource share.

', 'ShareDetails$resourceArn' => '

The Arn of the shared resource.

', 'ShareDetails$resourceId' => '

The ID of the shared resource.

', 'ShareDetails$principalSubscriber' => '

The principal subscriber is the account that is sharing the resource.

', 'ShareDetails$ownerId' => '

The account ID for the data owner. The owner creates the resource share.

', 'ThrottlingException$message' => NULL, 'UpdateAnnotationStoreRequest$name' => '

A name for the store.

', 'UpdateAnnotationStoreResponse$name' => '

The store\'s name.

', 'UpdateAnnotationStoreVersionRequest$name' => '

The name of an annotation store.

', 'UpdateAnnotationStoreVersionRequest$versionName' => '

The name of an annotation store version.

', 'UpdateVariantStoreRequest$name' => '

A name for the store.

', 'UpdateVariantStoreResponse$name' => '

The store\'s name.

', 'UploadReadSetPartResponse$checksum' => '

An identifier used to confirm that parts are being added to the intended upload.

', 'ValidationException$message' => NULL, 'VariantImportJobItem$id' => '

The job\'s ID.

', 'VariantImportJobItem$destinationName' => '

The job\'s destination variant store.

', 'VariantStoreItem$name' => '

The store\'s name.

', 'VersionDeleteError$message' => '

The message explaining the error in annotation store deletion.

', ], ], 'SubjectId' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartReadSetUploadRequest$subjectId' => '

The source\'s subject ID.

', 'CreateMultipartReadSetUploadResponse$subjectId' => '

The source\'s subject ID.

', 'GetReadSetMetadataResponse$subjectId' => '

The read set\'s subject ID.

', 'ImportReadSetSourceItem$subjectId' => '

The source\'s subject ID.

', 'MultipartReadSetUploadListItem$subjectId' => '

The read set source\'s subject ID.

', 'ReadSetFilter$subjectId' => '

The read set source\'s subject ID.

', 'ReadSetListItem$subjectId' => '

The read set\'s subject ID.

', 'StartReadSetImportJobSourceItem$subjectId' => '

The source\'s subject ID.

', ], ], 'SyntheticTimestamp_date_time' => [ 'base' => NULL, 'refs' => [ 'ActivateReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ActivateReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ActivateReadSetJobItem$creationTime' => '

When the job was created.

', 'ActivateReadSetJobItem$completionTime' => '

When the job completed.

', 'CreateMultipartReadSetUploadResponse$creationTime' => '

The creation time of the multipart upload.

', 'CreateReferenceStoreResponse$creationTime' => '

When the store was created.

', 'CreateSequenceStoreResponse$creationTime' => '

When the store was created.

', 'ExportReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ExportReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ExportReadSetJobDetail$creationTime' => '

When the job was created.

', 'ExportReadSetJobDetail$completionTime' => '

When the job completed.

', 'GetReadSetActivationJobResponse$creationTime' => '

When the job was created.

', 'GetReadSetActivationJobResponse$completionTime' => '

When the job completed.

', 'GetReadSetExportJobResponse$creationTime' => '

When the job was created.

', 'GetReadSetExportJobResponse$completionTime' => '

When the job completed.

', 'GetReadSetImportJobResponse$creationTime' => '

When the job was created.

', 'GetReadSetImportJobResponse$completionTime' => '

When the job completed.

', 'GetReadSetMetadataResponse$creationTime' => '

When the read set was created.

', 'GetReferenceImportJobResponse$creationTime' => '

When the job was created.

', 'GetReferenceImportJobResponse$completionTime' => '

When the job completed.

', 'GetReferenceMetadataResponse$creationTime' => '

When the reference was created.

', 'GetReferenceMetadataResponse$updateTime' => '

When the reference was updated.

', 'GetReferenceStoreResponse$creationTime' => '

When the store was created.

', 'GetSequenceStoreResponse$creationTime' => '

When the store was created.

', 'ImportReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ImportReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ImportReadSetJobItem$creationTime' => '

When the job was created.

', 'ImportReadSetJobItem$completionTime' => '

When the job completed.

', 'ImportReferenceFilter$createdAfter' => '

The filter\'s start date.

', 'ImportReferenceFilter$createdBefore' => '

The filter\'s end date.

', 'ImportReferenceJobItem$creationTime' => '

When the job was created.

', 'ImportReferenceJobItem$completionTime' => '

When the job completed.

', 'MultipartReadSetUploadListItem$creationTime' => '

The time stamp for when a direct upload was created.

', 'ReadSetFilter$createdAfter' => '

The filter\'s start date.

', 'ReadSetFilter$createdBefore' => '

The filter\'s end date.

', 'ReadSetListItem$creationTime' => '

When the read set was created.

', 'ReadSetUploadPartListFilter$createdAfter' => '

Filters for read set uploads after a specified time.

', 'ReadSetUploadPartListFilter$createdBefore' => '

Filters for read set part uploads before a specified time.

', 'ReadSetUploadPartListItem$creationTime' => '

The time stamp for when a direct upload was created.

', 'ReadSetUploadPartListItem$lastUpdatedTime' => '

The time stamp for the most recent update to an uploaded part.

', 'ReferenceFilter$createdAfter' => '

The filter\'s start date.

', 'ReferenceFilter$createdBefore' => '

The filter\'s end date.

', 'ReferenceListItem$creationTime' => '

When the reference was created.

', 'ReferenceListItem$updateTime' => '

When the reference was updated.

', 'ReferenceStoreDetail$creationTime' => '

When the store was created.

', 'ReferenceStoreFilter$createdAfter' => '

The filter\'s start date.

', 'ReferenceStoreFilter$createdBefore' => '

The filter\'s end date.

', 'SequenceStoreDetail$creationTime' => '

When the store was created.

', 'SequenceStoreFilter$createdAfter' => '

The filter\'s start date.

', 'SequenceStoreFilter$createdBefore' => '

The filter\'s end date.

', 'StartReadSetActivationJobResponse$creationTime' => '

When the job was created.

', 'StartReadSetExportJobResponse$creationTime' => '

When the job was created.

', 'StartReadSetImportJobResponse$creationTime' => '

When the job was created.

', 'StartReferenceImportJobResponse$creationTime' => '

When the job was created.

', ], ], 'TagArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => '

The resource\'s ARN.

', 'TagResourceRequest$resourceArn' => '

The resource\'s ARN.

', 'UntagResourceRequest$resourceArn' => '

The resource\'s ARN.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, 'TagResourceRequestTagsMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

Keys of tags to remove.

', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateAnnotationStoreRequest$tags' => '

Tags for the store.

', 'CreateAnnotationStoreVersionRequest$tags' => '

Any tags added to annotation store version.

', 'CreateMultipartReadSetUploadRequest$tags' => '

Any tags to add to the read set.

', 'CreateMultipartReadSetUploadResponse$tags' => '

The tags to add to the read set.

', 'CreateReferenceStoreRequest$tags' => '

Tags for the store.

', 'CreateRunGroupRequest$tags' => '

Tags for the group.

', 'CreateRunGroupResponse$tags' => '

Tags for the run group.

', 'CreateSequenceStoreRequest$tags' => '

Tags for the store.

', 'CreateVariantStoreRequest$tags' => '

Tags for the store.

', 'CreateWorkflowRequest$tags' => '

Tags for the workflow.

', 'CreateWorkflowResponse$tags' => '

The workflow\'s tags.

', 'GetAnnotationStoreResponse$tags' => '

The store\'s tags.

', 'GetAnnotationStoreVersionResponse$tags' => '

Any tags associated with an annotation store version.

', 'GetRunGroupResponse$tags' => '

The group\'s tags.

', 'GetRunResponse$tags' => '

The run\'s tags.

', 'GetVariantStoreResponse$tags' => '

The store\'s tags.

', 'GetWorkflowResponse$tags' => '

The workflow\'s tags.

', 'ImportReadSetSourceItem$tags' => '

The source\'s tags.

', 'ImportReferenceSourceItem$tags' => '

The source\'s tags.

', 'ListTagsForResourceResponse$tags' => '

A list of tags.

', 'MultipartReadSetUploadListItem$tags' => '

Any tags you wish to add to a read set.

', 'StartReadSetImportJobSourceItem$tags' => '

The source\'s tags.

', 'StartReferenceImportJobSourceItem$tags' => '

The source\'s tags.

', 'StartRunRequest$tags' => '

Tags for the run.

', 'StartRunResponse$tags' => '

The run\'s tags.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceRequestTagsMap' => [ 'base' => NULL, 'refs' => [ 'TagResourceRequest$tags' => '

Tags for the resource.

', ], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, 'TagResourceRequestTagsMap$value' => NULL, ], ], 'TaskFailureReason' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$failureReason' => '

The reason a task has failed.

', ], ], 'TaskId' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskRequest$taskId' => '

The task\'s ID.

', 'GetRunTaskResponse$taskId' => '

The task\'s ID.

', 'TaskListItem$taskId' => '

The task\'s ID.

', ], ], 'TaskInstanceType' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$instanceType' => '

The instance type for a task.

', 'TaskListItem$instanceType' => '

The instance type for a task.

', ], ], 'TaskList' => [ 'base' => NULL, 'refs' => [ 'ListRunTasksResponse$items' => '

A list of tasks.

', ], ], 'TaskListItem' => [ 'base' => '

A workflow run task.

', 'refs' => [ 'TaskList$member' => NULL, ], ], 'TaskListItemCpusInteger' => [ 'base' => NULL, 'refs' => [ 'TaskListItem$cpus' => '

The task\'s CPU count.

', ], ], 'TaskListItemGpusInteger' => [ 'base' => NULL, 'refs' => [ 'TaskListItem$gpus' => '

The number of Graphics Processing Units (GPU) specified for the task.

', ], ], 'TaskListItemMemoryInteger' => [ 'base' => NULL, 'refs' => [ 'TaskListItem$memory' => '

The task\'s memory use in gigabyes.

', ], ], 'TaskListToken' => [ 'base' => NULL, 'refs' => [ 'ListRunTasksRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRunTasksResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'TaskLogStream' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$logStream' => '

The task\'s log stream.

', ], ], 'TaskName' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$name' => '

The task\'s name.

', 'TaskListItem$name' => '

The task\'s name.

', ], ], 'TaskStatus' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$status' => '

The task\'s status.

', 'ListRunTasksRequest$status' => '

Filter the list by status.

', 'TaskListItem$status' => '

The task\'s status.

', ], ], 'TaskStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$statusMessage' => '

The task\'s status message.

', ], ], 'TaskTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetRunTaskResponse$creationTime' => '

When the task was created.

', 'GetRunTaskResponse$startTime' => '

The task\'s start time.

', 'GetRunTaskResponse$stopTime' => '

The task\'s stop time.

', 'TaskListItem$creationTime' => '

When the task was created.

', 'TaskListItem$startTime' => '

When the task started.

', 'TaskListItem$stopTime' => '

When the task stopped.

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

The request was denied due to request throttling.

', 'refs' => [], ], 'TsvOptions' => [ 'base' => '

Formatting options for a TSV file.

', 'refs' => [ 'FormatOptions$tsvOptions' => '

Options for a TSV file.

', ], ], 'TsvStoreOptions' => [ 'base' => '

File settings for a TSV store.

', 'refs' => [ 'StoreOptions$tsvStoreOptions' => '

File settings for a TSV store.

', ], ], 'TsvStoreOptionsSchemaList' => [ 'base' => NULL, 'refs' => [ 'TsvStoreOptions$schema' => '

The store\'s schema.

', ], ], 'TsvVersionOptions' => [ 'base' => '

The options for a TSV file.

', 'refs' => [ 'VersionOptions$tsvVersionOptions' => '

File settings for a version of a TSV store.

', ], ], 'TsvVersionOptionsSchemaList' => [ 'base' => NULL, 'refs' => [ 'TsvVersionOptions$schema' => '

The TSV schema for an annotation store version.

', ], ], 'TypeList' => [ 'base' => NULL, 'refs' => [ 'Filter$type' => '

The type of resources to be filtered. You can specify one or more of the resource types.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnnotationStoreVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRunGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRunGroupRequestMaxCpusInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxCpus' => '

The maximum number of CPUs to use.

', ], ], 'UpdateRunGroupRequestMaxDurationInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxDuration' => '

A maximum run time for the group in minutes.

', ], ], 'UpdateRunGroupRequestMaxGpusInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxGpus' => '

The maximum GPUs that can be used by a run group.

', ], ], 'UpdateRunGroupRequestMaxRunsInteger' => [ 'base' => NULL, 'refs' => [ 'UpdateRunGroupRequest$maxRuns' => '

The maximum number of concurrent runs for the group.

', ], ], 'UpdateTime' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$updateTime' => '

When the job was updated.

', 'AnnotationStoreItem$updateTime' => '

When the store was updated.

', 'AnnotationStoreVersionItem$updateTime' => '

The time stamp for when an annotation store version was updated.

', 'GetAnnotationImportResponse$updateTime' => '

When the job was updated.

', 'GetAnnotationStoreResponse$updateTime' => '

When the store was updated.

', 'GetAnnotationStoreVersionResponse$updateTime' => '

The time stamp for when an annotation store version was updated.

', 'GetVariantImportResponse$updateTime' => '

When the job was updated.

', 'GetVariantStoreResponse$updateTime' => '

When the store was updated.

', 'ShareDetails$updateTime' => '

The timestamp of the resource share update.

', 'UpdateAnnotationStoreResponse$updateTime' => '

When the store was updated.

', 'UpdateAnnotationStoreVersionResponse$updateTime' => '

The time stamp for when an annotation store version was updated.

', 'UpdateVariantStoreResponse$updateTime' => '

When the store was updated.

', 'VariantImportJobItem$updateTime' => '

When the job was updated.

', 'VariantStoreItem$updateTime' => '

When the store was updated.

', ], ], 'UpdateVariantStoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVariantStoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'UploadId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartReadSetUploadRequest$uploadId' => '

The ID for the multipart upload.

', 'CompleteMultipartReadSetUploadRequest$uploadId' => '

The ID for the multipart upload.

', 'CreateMultipartReadSetUploadResponse$uploadId' => '

The ID for the initiated multipart upload.

', 'ListReadSetUploadPartsRequest$uploadId' => '

The ID for the initiated multipart upload.

', 'MultipartReadSetUploadListItem$uploadId' => '

The ID for the initiated multipart upload.

', 'UploadReadSetPartRequest$uploadId' => '

The ID for the initiated multipart upload.

', ], ], 'UploadReadSetPartRequest' => [ 'base' => NULL, 'refs' => [], ], 'UploadReadSetPartRequestPartNumberInteger' => [ 'base' => NULL, 'refs' => [ 'UploadReadSetPartRequest$partNumber' => '

The number of the part being uploaded.

', ], ], 'UploadReadSetPartResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

The input fails to satisfy the constraints specified by an AWS service.

', 'refs' => [], ], 'VariantImportItemDetail' => [ 'base' => '

Details about an imported variant item.

', 'refs' => [ 'VariantImportItemDetails$member' => NULL, ], ], 'VariantImportItemDetails' => [ 'base' => NULL, 'refs' => [ 'GetVariantImportResponse$items' => '

The job\'s items.

', ], ], 'VariantImportItemSource' => [ 'base' => '

A imported variant item\'s source.

', 'refs' => [ 'VariantImportItemSources$member' => NULL, ], ], 'VariantImportItemSources' => [ 'base' => NULL, 'refs' => [ 'StartVariantImportRequest$items' => '

Items to import.

', ], ], 'VariantImportJobItem' => [ 'base' => '

A variant import job.

', 'refs' => [ 'VariantImportJobItems$member' => NULL, ], ], 'VariantImportJobItems' => [ 'base' => NULL, 'refs' => [ 'ListVariantImportJobsResponse$variantImportJobs' => '

A list of jobs.

', ], ], 'VariantStoreItem' => [ 'base' => '

A variant store.

', 'refs' => [ 'VariantStoreItems$member' => NULL, ], ], 'VariantStoreItems' => [ 'base' => NULL, 'refs' => [ 'ListVariantStoresResponse$variantStores' => '

A list of variant stores.

', ], ], 'VcfOptions' => [ 'base' => '

Formatting options for a VCF file.

', 'refs' => [ 'FormatOptions$vcfOptions' => '

Options for a VCF file.

', ], ], 'VersionDeleteError' => [ 'base' => '

The error preventing deletion of the annotation store version.

', 'refs' => [ 'VersionDeleteErrorList$member' => NULL, ], ], 'VersionDeleteErrorList' => [ 'base' => NULL, 'refs' => [ 'DeleteAnnotationStoreVersionsResponse$errors' => '

Any errors that occur when attempting to delete an annotation store version.

', ], ], 'VersionList' => [ 'base' => NULL, 'refs' => [ 'DeleteAnnotationStoreVersionsRequest$versions' => '

The versions of an annotation store to be deleted.

', ], ], 'VersionName' => [ 'base' => NULL, 'refs' => [ 'AnnotationImportJobItem$versionName' => '

The name of the annotation store version.

', 'AnnotationStoreVersionItem$versionName' => '

The name of an annotation store version.

', 'CreateAnnotationStoreRequest$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateAnnotationStoreResponse$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateAnnotationStoreVersionRequest$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'CreateAnnotationStoreVersionResponse$versionName' => '

The name given to an annotation store version to distinguish it from other versions.

', 'GetAnnotationImportResponse$versionName' => '

The name of the annotation store version.

', 'GetAnnotationStoreVersionResponse$versionName' => '

The name given to an annotation store version to distinguish it from others.

', 'StartAnnotationImportRequest$versionName' => '

The name of the annotation store version.

', 'UpdateAnnotationStoreVersionResponse$versionName' => '

The name of an annotation store version.

', 'VersionDeleteError$versionName' => '

The name given to an annotation store version.

', 'VersionList$member' => NULL, ], ], 'VersionOptions' => [ 'base' => '

The options for an annotation store version.

', 'refs' => [ 'CreateAnnotationStoreVersionRequest$versionOptions' => '

The options for an annotation store version.

', 'CreateAnnotationStoreVersionResponse$versionOptions' => '

The options for an annotation store version.

', 'GetAnnotationStoreVersionResponse$versionOptions' => '

The options for an annotation store version.

', ], ], 'VersionStatus' => [ 'base' => NULL, 'refs' => [ 'AnnotationStoreVersionItem$status' => '

The status of an annotation store version.

', 'CreateAnnotationStoreVersionResponse$status' => '

The status of a annotation store version.

', 'GetAnnotationStoreVersionResponse$status' => '

The status of an annotation store version.

', 'ListAnnotationStoreVersionsFilter$status' => '

The status of an annotation store version.

', 'UpdateAnnotationStoreVersionResponse$status' => '

The status of an annotation store version.

', ], ], 'WorkflowArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$arn' => '

The workflow\'s ARN.

', 'GetWorkflowResponse$arn' => '

The workflow\'s ARN.

', 'WorkflowListItem$arn' => '

The workflow\'s ARN.

', ], ], 'WorkflowDefinition' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$definitionUri' => '

The URI of a definition for the workflow.

', 'GetRunResponse$definition' => '

The run\'s definition.

', 'GetWorkflowResponse$definition' => '

The workflow\'s definition.

', ], ], 'WorkflowDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$description' => '

A description for the workflow.

', 'GetWorkflowResponse$description' => '

The workflow\'s description.

', 'UpdateWorkflowRequest$description' => '

A description for the workflow.

', ], ], 'WorkflowDigest' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$digest' => '

The run\'s digest.

', 'GetWorkflowResponse$digest' => '

The workflow\'s digest.

', 'WorkflowListItem$digest' => '

The workflow\'s digest.

', ], ], 'WorkflowEngine' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$engine' => '

An engine for the workflow.

', 'GetWorkflowResponse$engine' => '

The workflow\'s engine.

', ], ], 'WorkflowExport' => [ 'base' => NULL, 'refs' => [ 'WorkflowExportList$member' => NULL, ], ], 'WorkflowExportList' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowRequest$export' => '

The export format for the workflow.

', ], ], 'WorkflowId' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$id' => '

The workflow\'s ID.

', 'DeleteWorkflowRequest$id' => '

The workflow\'s ID.

', 'GetRunResponse$workflowId' => '

The run\'s workflow ID.

', 'GetWorkflowRequest$id' => '

The workflow\'s ID.

', 'GetWorkflowResponse$id' => '

The workflow\'s ID.

', 'RunListItem$workflowId' => '

The run\'s workflow ID.

', 'StartRunRequest$workflowId' => '

The run\'s workflow ID.

', 'UpdateWorkflowRequest$id' => '

The workflow\'s ID.

', 'WorkflowListItem$id' => '

The workflow\'s ID.

', ], ], 'WorkflowList' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsResponse$items' => '

A list of workflow items.

', ], ], 'WorkflowListItem' => [ 'base' => '

A workflow.

', 'refs' => [ 'WorkflowList$member' => NULL, ], ], 'WorkflowListToken' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsRequest$startingToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListWorkflowsResponse$nextToken' => '

A pagination token that\'s included if more results are available.

', ], ], 'WorkflowMain' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$main' => '

The path of the main definition file for the workflow.

', 'GetWorkflowResponse$main' => '

The path of the main definition file for the workflow.

', ], ], 'WorkflowMetadata' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$metadata' => '

Gets metadata for workflow.

', 'WorkflowListItem$metadata' => '

Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.

', ], ], 'WorkflowMetadataKey' => [ 'base' => NULL, 'refs' => [ 'WorkflowMetadata$key' => NULL, ], ], 'WorkflowMetadataValue' => [ 'base' => NULL, 'refs' => [ 'WorkflowMetadata$value' => NULL, ], ], 'WorkflowName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$name' => '

A name for the workflow.

', 'GetWorkflowResponse$name' => '

The workflow\'s name.

', 'ListWorkflowsRequest$name' => '

Filter the list by workflow name.

', 'UpdateWorkflowRequest$name' => '

A name for the workflow.

', 'WorkflowListItem$name' => '

The workflow\'s name.

', ], ], 'WorkflowOwnerId' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$workflowOwnerId' => '

The ID of the workflow owner.

', 'GetWorkflowRequest$workflowOwnerId' => '

The ID of the workflow owner.

', 'StartRunRequest$workflowOwnerId' => '

The ID of the workflow owner.

', ], ], 'WorkflowParameter' => [ 'base' => '

A workflow parameter.

', 'refs' => [ 'WorkflowParameterTemplate$value' => NULL, ], ], 'WorkflowParameterDescription' => [ 'base' => NULL, 'refs' => [ 'WorkflowParameter$description' => '

The parameter\'s description.

', ], ], 'WorkflowParameterName' => [ 'base' => NULL, 'refs' => [ 'WorkflowParameterTemplate$key' => NULL, ], ], 'WorkflowParameterTemplate' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$parameterTemplate' => '

A parameter template for the workflow.

', 'GetWorkflowResponse$parameterTemplate' => '

The workflow\'s parameter template.

', ], ], 'WorkflowRequestId' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$requestId' => '

To ensure that requests don\'t run multiple times, specify a unique ID for each request.

', ], ], 'WorkflowStatus' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$status' => '

The workflow\'s status.

', 'GetWorkflowResponse$status' => '

The workflow\'s status.

', 'WorkflowListItem$status' => '

The workflow\'s status.

', ], ], 'WorkflowStatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$statusMessage' => '

The workflow\'s status message.

', ], ], 'WorkflowTimestamp' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowResponse$creationTime' => '

When the workflow was created.

', 'WorkflowListItem$creationTime' => '

When the workflow was created.

', ], ], 'WorkflowType' => [ 'base' => NULL, 'refs' => [ 'GetRunResponse$workflowType' => '

The run\'s workflow type.

', 'GetWorkflowRequest$type' => '

The workflow\'s type.

', 'GetWorkflowResponse$type' => '

The workflow\'s type.

', 'ListWorkflowsRequest$type' => '

Filter the list by workflow type.

', 'StartRunRequest$workflowType' => '

The run\'s workflow type.

', 'WorkflowListItem$type' => '

The workflow\'s type.

', ], ], ],]; diff --git a/src/data/opensearch/2021-01-01/api-2.json b/src/data/opensearch/2021-01-01/api-2.json index a03f6971d0..f0a4c8eea3 100644 --- a/src/data/opensearch/2021-01-01/api-2.json +++ b/src/data/opensearch/2021-01-01/api-2.json @@ -2436,6 +2436,7 @@ "Endpoint":{"shape":"ServiceUrl"}, "EndpointV2":{"shape":"ServiceUrl"}, "Endpoints":{"shape":"EndpointsMap"}, + "DomainEndpointV2HostedZoneId":{"shape":"HostedZoneId"}, "Processing":{"shape":"Boolean"}, "UpgradeProcessing":{"shape":"Boolean"}, "EngineVersion":{"shape":"VersionString"}, @@ -2757,6 +2758,7 @@ "UpgradeName":{"shape":"UpgradeName"} } }, + "HostedZoneId":{"type":"string"}, "IPAddressType":{ "type":"string", "enum":[ diff --git a/src/data/opensearch/2021-01-01/api-2.json.php b/src/data/opensearch/2021-01-01/api-2.json.php index b1fc939ff0..1d39854bc6 100644 --- a/src/data/opensearch/2021-01-01/api-2.json.php +++ b/src/data/opensearch/2021-01-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2021-01-01', 'endpointPrefix' => 'es', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon OpenSearch Service', 'serviceId' => 'OpenSearch', 'signatureVersion' => 'v4', 'uid' => 'opensearch-2021-01-01', ], 'operations' => [ 'AcceptInboundConnection' => [ 'name' => 'AcceptInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept', ], 'input' => [ 'shape' => 'AcceptInboundConnectionRequest', ], 'output' => [ 'shape' => 'AcceptInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'AddDataSource' => [ 'name' => 'AddDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'AddDataSourceRequest', ], 'output' => [ 'shape' => 'AddDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags', ], 'input' => [ 'shape' => 'AddTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'AssociatePackage' => [ 'name' => 'AssociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/associate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'AssociatePackageRequest', ], 'output' => [ 'shape' => 'AssociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'AuthorizeVpcEndpointAccess' => [ 'name' => 'AuthorizeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess', ], 'input' => [ 'shape' => 'AuthorizeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'AuthorizeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'CancelDomainConfigChange' => [ 'name' => 'CancelDomainConfigChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config/cancel', ], 'input' => [ 'shape' => 'CancelDomainConfigChangeRequest', ], 'output' => [ 'shape' => 'CancelDomainConfigChangeResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CancelServiceSoftwareUpdate' => [ 'name' => 'CancelServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/cancel', ], 'input' => [ 'shape' => 'CancelServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'CancelServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateOutboundConnection' => [ 'name' => 'CreateOutboundConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection', ], 'input' => [ 'shape' => 'CreateOutboundConnectionRequest', ], 'output' => [ 'shape' => 'CreateOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CreatePackage' => [ 'name' => 'CreatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages', ], 'input' => [ 'shape' => 'CreatePackageRequest', ], 'output' => [ 'shape' => 'CreatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateVpcEndpoint' => [ 'name' => 'CreateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'CreateVpcEndpointRequest', ], 'output' => [ 'shape' => 'CreateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteInboundConnection' => [ 'name' => 'DeleteInboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteInboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeleteOutboundConnection' => [ 'name' => 'DeleteOutboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteOutboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/packages/{PackageID}', ], 'input' => [ 'shape' => 'DeletePackageRequest', ], 'output' => [ 'shape' => 'DeletePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteVpcEndpoint' => [ 'name' => 'DeleteVpcEndpoint', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}', ], 'input' => [ 'shape' => 'DeleteVpcEndpointRequest', ], 'output' => [ 'shape' => 'DeleteVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainAutoTunes' => [ 'name' => 'DescribeDomainAutoTunes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/autoTunes', ], 'input' => [ 'shape' => 'DescribeDomainAutoTunesRequest', ], 'output' => [ 'shape' => 'DescribeDomainAutoTunesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainChangeProgress' => [ 'name' => 'DescribeDomainChangeProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/progress', ], 'input' => [ 'shape' => 'DescribeDomainChangeProgressRequest', ], 'output' => [ 'shape' => 'DescribeDomainChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainConfig' => [ 'name' => 'DescribeDomainConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'DescribeDomainConfigRequest', ], 'output' => [ 'shape' => 'DescribeDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainHealth' => [ 'name' => 'DescribeDomainHealth', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/health', ], 'input' => [ 'shape' => 'DescribeDomainHealthRequest', ], 'output' => [ 'shape' => 'DescribeDomainHealthResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeDomainNodes' => [ 'name' => 'DescribeDomainNodes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/nodes', ], 'input' => [ 'shape' => 'DescribeDomainNodesRequest', ], 'output' => [ 'shape' => 'DescribeDomainNodesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DescribeDomains' => [ 'name' => 'DescribeDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain-info', ], 'input' => [ 'shape' => 'DescribeDomainsRequest', ], 'output' => [ 'shape' => 'DescribeDomainsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDryRunProgress' => [ 'name' => 'DescribeDryRunProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dryRun', ], 'input' => [ 'shape' => 'DescribeDryRunProgressRequest', ], 'output' => [ 'shape' => 'DescribeDryRunProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInboundConnections' => [ 'name' => 'DescribeInboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/search', ], 'input' => [ 'shape' => 'DescribeInboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeInboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInstanceTypeLimits' => [ 'name' => 'DescribeInstanceTypeLimits', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}', ], 'input' => [ 'shape' => 'DescribeInstanceTypeLimitsRequest', ], 'output' => [ 'shape' => 'DescribeInstanceTypeLimitsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeOutboundConnections' => [ 'name' => 'DescribeOutboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/search', ], 'input' => [ 'shape' => 'DescribeOutboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeOutboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribePackages' => [ 'name' => 'DescribePackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/describe', ], 'input' => [ 'shape' => 'DescribePackagesRequest', ], 'output' => [ 'shape' => 'DescribePackagesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeReservedInstanceOfferings' => [ 'name' => 'DescribeReservedInstanceOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstanceOfferings', ], 'input' => [ 'shape' => 'DescribeReservedInstanceOfferingsRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstanceOfferingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], ], ], 'DescribeReservedInstances' => [ 'name' => 'DescribeReservedInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstances', ], 'input' => [ 'shape' => 'DescribeReservedInstancesRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstancesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeVpcEndpoints' => [ 'name' => 'DescribeVpcEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/describe', ], 'input' => [ 'shape' => 'DescribeVpcEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DissociatePackage' => [ 'name' => 'DissociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/dissociate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'DissociatePackageRequest', ], 'output' => [ 'shape' => 'DissociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetCompatibleVersions' => [ 'name' => 'GetCompatibleVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/compatibleVersions', ], 'input' => [ 'shape' => 'GetCompatibleVersionsRequest', ], 'output' => [ 'shape' => 'GetCompatibleVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'GetDomainMaintenanceStatus' => [ 'name' => 'GetDomainMaintenanceStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'GetDomainMaintenanceStatusRequest', ], 'output' => [ 'shape' => 'GetDomainMaintenanceStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'GetPackageVersionHistory' => [ 'name' => 'GetPackageVersionHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/history', ], 'input' => [ 'shape' => 'GetPackageVersionHistoryRequest', ], 'output' => [ 'shape' => 'GetPackageVersionHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetUpgradeHistory' => [ 'name' => 'GetUpgradeHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/history', ], 'input' => [ 'shape' => 'GetUpgradeHistoryRequest', ], 'output' => [ 'shape' => 'GetUpgradeHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetUpgradeStatus' => [ 'name' => 'GetUpgradeStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/status', ], 'input' => [ 'shape' => 'GetUpgradeStatusRequest', ], 'output' => [ 'shape' => 'GetUpgradeStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'ListDomainMaintenances' => [ 'name' => 'ListDomainMaintenances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances', ], 'input' => [ 'shape' => 'ListDomainMaintenancesRequest', ], 'output' => [ 'shape' => 'ListDomainMaintenancesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'ListDomainNames' => [ 'name' => 'ListDomainNames', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain', ], 'input' => [ 'shape' => 'ListDomainNamesRequest', ], 'output' => [ 'shape' => 'ListDomainNamesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListDomainsForPackage' => [ 'name' => 'ListDomainsForPackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/domains', ], 'input' => [ 'shape' => 'ListDomainsForPackageRequest', ], 'output' => [ 'shape' => 'ListDomainsForPackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListInstanceTypeDetails' => [ 'name' => 'ListInstanceTypeDetails', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}', ], 'input' => [ 'shape' => 'ListInstanceTypeDetailsRequest', ], 'output' => [ 'shape' => 'ListInstanceTypeDetailsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackagesForDomain' => [ 'name' => 'ListPackagesForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain/{DomainName}/packages', ], 'input' => [ 'shape' => 'ListPackagesForDomainRequest', ], 'output' => [ 'shape' => 'ListPackagesForDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListScheduledActions' => [ 'name' => 'ListScheduledActions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledActions', ], 'input' => [ 'shape' => 'ListScheduledActionsRequest', ], 'output' => [ 'shape' => 'ListScheduledActionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/tags/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListVersions' => [ 'name' => 'ListVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/versions', ], 'input' => [ 'shape' => 'ListVersionsRequest', ], 'output' => [ 'shape' => 'ListVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListVpcEndpointAccess' => [ 'name' => 'ListVpcEndpointAccess', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess', ], 'input' => [ 'shape' => 'ListVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpoints' => [ 'name' => 'ListVpcEndpoints', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpointsForDomain' => [ 'name' => 'ListVpcEndpointsForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsForDomainRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsForDomainResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'BaseException', ], ], ], 'PurchaseReservedInstanceOffering' => [ 'name' => 'PurchaseReservedInstanceOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/purchaseReservedInstanceOffering', ], 'input' => [ 'shape' => 'PurchaseReservedInstanceOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseReservedInstanceOfferingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RejectInboundConnection' => [ 'name' => 'RejectInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject', ], 'input' => [ 'shape' => 'RejectInboundConnectionRequest', ], 'output' => [ 'shape' => 'RejectInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags-removal', ], 'input' => [ 'shape' => 'RemoveTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RevokeVpcEndpointAccess' => [ 'name' => 'RevokeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess', ], 'input' => [ 'shape' => 'RevokeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'RevokeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'StartDomainMaintenance' => [ 'name' => 'StartDomainMaintenance', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'StartDomainMaintenanceRequest', ], 'output' => [ 'shape' => 'StartDomainMaintenanceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'StartServiceSoftwareUpdate' => [ 'name' => 'StartServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/start', ], 'input' => [ 'shape' => 'StartServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'StartServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'UpdateDomainConfig' => [ 'name' => 'UpdateDomainConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'UpdateDomainConfigRequest', ], 'output' => [ 'shape' => 'UpdateDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackage' => [ 'name' => 'UpdatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/update', ], 'input' => [ 'shape' => 'UpdatePackageRequest', ], 'output' => [ 'shape' => 'UpdatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateScheduledAction' => [ 'name' => 'UpdateScheduledAction', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update', ], 'input' => [ 'shape' => 'UpdateScheduledActionRequest', ], 'output' => [ 'shape' => 'UpdateScheduledActionResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'SlotNotAvailableException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateVpcEndpoint' => [ 'name' => 'UpdateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/update', ], 'input' => [ 'shape' => 'UpdateVpcEndpointRequest', ], 'output' => [ 'shape' => 'UpdateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'BaseException', ], ], ], 'UpgradeDomain' => [ 'name' => 'UpgradeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain', ], 'input' => [ 'shape' => 'UpgradeDomainRequest', ], 'output' => [ 'shape' => 'UpgradeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*', ], 'AWSAccount' => [ 'type' => 'string', 'pattern' => '^[0-9]+$', ], 'AWSDomainInformation' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'OwnerId' => [ 'shape' => 'OwnerId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Region' => [ 'shape' => 'Region', ], ], ], 'AcceptInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'AcceptInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccessPoliciesStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'PolicyDocument', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ActionSeverity' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'MEDIUM', 'LOW', ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'FAILED', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'SERVICE_SOFTWARE_UPDATE', 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'AddDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'AddDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'AddTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagList', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'AdditionalLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'AdditionalLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalLimit', ], ], 'AdvancedOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'AdvancedOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AdvancedSecurityOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedSecurityOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AssociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'AssociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipal', ], 'members' => [ 'AuthorizedPrincipal' => [ 'shape' => 'AuthorizedPrincipal', ], ], ], 'AuthorizedPrincipal' => [ 'type' => 'structure', 'members' => [ 'PrincipalType' => [ 'shape' => 'PrincipalType', ], 'Principal' => [ 'shape' => 'String', ], ], ], 'AuthorizedPrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedPrincipal', ], ], 'AutoTune' => [ 'type' => 'structure', 'members' => [ 'AutoTuneType' => [ 'shape' => 'AutoTuneType', ], 'AutoTuneDetails' => [ 'shape' => 'AutoTuneDetails', ], ], ], 'AutoTuneDate' => [ 'type' => 'timestamp', ], 'AutoTuneDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'ScheduledAutoTuneDetails' => [ 'shape' => 'ScheduledAutoTuneDetails', ], ], ], 'AutoTuneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTune', ], ], 'AutoTuneMaintenanceSchedule' => [ 'type' => 'structure', 'members' => [ 'StartAt' => [ 'shape' => 'StartAt', ], 'Duration' => [ 'shape' => 'Duration', ], 'CronExpressionForRecurrence' => [ 'shape' => 'String', ], ], ], 'AutoTuneMaintenanceScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTuneMaintenanceSchedule', ], 'max' => 100, ], 'AutoTuneOptions' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'RollbackOnDisable' => [ 'shape' => 'RollbackOnDisable', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'AutoTuneOptions', ], 'Status' => [ 'shape' => 'AutoTuneStatus', ], ], ], 'AutoTuneState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'ENABLE_IN_PROGRESS', 'DISABLE_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_SCHEDULED', 'DISABLED_AND_ROLLBACK_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_COMPLETE', 'DISABLED_AND_ROLLBACK_ERROR', 'ERROR', ], ], 'AutoTuneStatus' => [ 'type' => 'structure', 'required' => [ 'CreationDate', 'UpdateDate', 'State', ], 'members' => [ 'CreationDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateVersion' => [ 'shape' => 'UIntValue', ], 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'PendingDeletion' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneType' => [ 'type' => 'string', 'enum' => [ 'SCHEDULED_ACTION', ], ], 'AvailabilityZone' => [ 'type' => 'string', 'max' => 15, 'min' => 1, ], 'AvailabilityZoneInfo' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneName' => [ 'shape' => 'AvailabilityZone', ], 'ZoneStatus' => [ 'shape' => 'ZoneStatus', ], 'ConfiguredDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'AvailableDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], ], ], 'AvailabilityZoneInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZoneInfo', ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'BackendRole' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BaseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CancelDomainConfigChangeRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'DryRun' => [ 'shape' => 'DryRun', ], ], ], 'CancelDomainConfigChangeResponse' => [ 'type' => 'structure', 'members' => [ 'CancelledChangeIds' => [ 'shape' => 'GUIDList', ], 'CancelledChangeProperties' => [ 'shape' => 'CancelledChangePropertyList', ], 'DryRun' => [ 'shape' => 'DryRun', ], ], ], 'CancelServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'CancelServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'CancelledChangeProperty' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'String', ], 'CancelledValue' => [ 'shape' => 'String', ], 'ActiveValue' => [ 'shape' => 'String', ], ], ], 'CancelledChangePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CancelledChangeProperty', ], ], 'ChangeProgressDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'Message' => [ 'shape' => 'Message', ], 'ConfigChangeStatus' => [ 'shape' => 'ConfigChangeStatus', ], 'InitiatedBy' => [ 'shape' => 'InitiatedBy', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'LastUpdatedTime' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'ChangeProgressStage' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ChangeProgressStageName', ], 'Status' => [ 'shape' => 'ChangeProgressStageStatus', ], 'Description' => [ 'shape' => 'Description', ], 'LastUpdated' => [ 'shape' => 'LastUpdated', ], ], ], 'ChangeProgressStageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChangeProgressStage', ], ], 'ChangeProgressStageName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ChangeProgressStageStatus' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ChangeProgressStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Status' => [ 'shape' => 'OverallChangeStatus', ], 'PendingProperties' => [ 'shape' => 'StringList', ], 'CompletedProperties' => [ 'shape' => 'StringList', ], 'TotalNumberOfStages' => [ 'shape' => 'TotalNumberOfStages', ], 'ChangeProgressStages' => [ 'shape' => 'ChangeProgressStageList', ], 'LastUpdatedTime' => [ 'shape' => 'UpdateTimestamp', ], 'ConfigChangeStatus' => [ 'shape' => 'ConfigChangeStatus', ], 'InitiatedBy' => [ 'shape' => 'InitiatedBy', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CloudWatchLogsLogGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*', ], 'ClusterConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'InstanceCount' => [ 'shape' => 'IntegerClass', ], 'DedicatedMasterEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessConfig' => [ 'shape' => 'ZoneAwarenessConfig', ], 'DedicatedMasterType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'DedicatedMasterCount' => [ 'shape' => 'IntegerClass', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'WarmType' => [ 'shape' => 'OpenSearchWarmPartitionInstanceType', ], 'WarmCount' => [ 'shape' => 'IntegerClass', ], 'ColdStorageOptions' => [ 'shape' => 'ColdStorageOptions', ], 'MultiAZWithStandbyEnabled' => [ 'shape' => 'Boolean', ], ], ], 'ClusterConfigStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'ClusterConfig', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'CognitoOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'UserPoolId' => [ 'shape' => 'UserPoolId', ], 'IdentityPoolId' => [ 'shape' => 'IdentityPoolId', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'CognitoOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'CognitoOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ColdStorageOptions' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'CommitMessage' => [ 'type' => 'string', 'max' => 160, ], 'CompatibleVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompatibleVersionsMap', ], ], 'CompatibleVersionsMap' => [ 'type' => 'structure', 'members' => [ 'SourceVersion' => [ 'shape' => 'VersionString', ], 'TargetVersions' => [ 'shape' => 'VersionList', ], ], ], 'ConfigChangeStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Initializing', 'Validating', 'ValidationFailed', 'ApplyingChanges', 'Completed', 'PendingUserInput', 'Cancelled', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionAlias' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-\\_]+', ], 'ConnectionId' => [ 'type' => 'string', 'max' => 256, 'min' => 10, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'ConnectionMode' => [ 'type' => 'string', 'enum' => [ 'DIRECT', 'VPC_ENDPOINT', ], ], 'ConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'Endpoint' => [ 'shape' => 'Endpoint', ], 'CrossClusterSearch' => [ 'shape' => 'CrossClusterSearchConnectionProperties', ], ], ], 'ConnectionStatusMessage' => [ 'type' => 'string', ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'TagList' => [ 'shape' => 'TagList', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsInput', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'CreateOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'LocalDomainInfo', 'RemoteDomainInfo', 'ConnectionAlias', ], 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreateOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundConnectionStatus', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageName', 'PackageType', 'PackageSource', ], 'members' => [ 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], ], ], 'CreatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'CreateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DomainArn', 'VpcOptions', ], 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'CreatedAt' => [ 'type' => 'timestamp', ], 'CrossClusterSearchConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'SkipUnavailable' => [ 'shape' => 'SkipUnavailableStatus', ], ], ], 'DataSourceDescription' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$', ], 'DataSourceDetails' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceDetails', ], ], 'DataSourceName' => [ 'type' => 'string', 'max' => 80, 'min' => 3, 'pattern' => '[a-z][a-z0-9_]+', ], 'DataSourceType' => [ 'type' => 'structure', 'members' => [ 'S3GlueDataCatalog' => [ 'shape' => 'S3GlueDataCatalog', ], ], 'union' => true, ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DeleteDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DeleteInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'DeleteOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'OutboundConnection', ], ], ], 'DeletePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], ], ], 'DeletePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'DeleteVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', 'location' => 'uri', 'locationName' => 'VpcEndpointId', ], ], ], 'DeleteVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummary', ], 'members' => [ 'VpcEndpointSummary' => [ 'shape' => 'VpcEndpointSummary', ], ], ], 'DependencyFailureException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 424, ], 'exception' => true, ], 'DeploymentCloseDateTimeStamp' => [ 'type' => 'timestamp', ], 'DeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'DeploymentType' => [ 'type' => 'string', 'max' => 128, 'min' => 2, ], 'DescribeDomainAutoTunesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainAutoTunesResponse' => [ 'type' => 'structure', 'members' => [ 'AutoTunes' => [ 'shape' => 'AutoTuneList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainChangeProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ChangeId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'changeid', ], ], ], 'DescribeDomainChangeProgressResponse' => [ 'type' => 'structure', 'members' => [ 'ChangeProgressStatus' => [ 'shape' => 'ChangeProgressStatusDetails', ], ], ], 'DescribeDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], ], ], 'DescribeDomainHealthRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainHealthResponse' => [ 'type' => 'structure', 'members' => [ 'DomainState' => [ 'shape' => 'DomainState', ], 'AvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'ActiveAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'StandByAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'DataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'DedicatedMaster' => [ 'shape' => 'Boolean', ], 'MasterEligibleNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'WarmNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'MasterNode' => [ 'shape' => 'MasterNodeStatus', ], 'ClusterHealth' => [ 'shape' => 'DomainHealth', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], 'EnvironmentInformation' => [ 'shape' => 'EnvironmentInfoList', ], ], ], 'DescribeDomainNodesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainNodesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNodesStatusList' => [ 'shape' => 'DomainNodesStatusList', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatus', ], 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DescribeDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainNames', ], 'members' => [ 'DomainNames' => [ 'shape' => 'DomainNameList', ], ], ], 'DescribeDomainsResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatusList', ], 'members' => [ 'DomainStatusList' => [ 'shape' => 'DomainStatusList', ], ], ], 'DescribeDryRunProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'DryRunId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'dryRunId', ], 'LoadDryRunConfig' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'loadDryRunConfig', ], ], ], 'DescribeDryRunProgressResponse' => [ 'type' => 'structure', 'members' => [ 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], 'DryRunConfig' => [ 'shape' => 'DomainStatus', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], ], ], 'DescribeInboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'InboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInstanceTypeLimitsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'EngineVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', 'location' => 'uri', 'locationName' => 'InstanceType', ], 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], ], ], 'DescribeInstanceTypeLimitsResponse' => [ 'type' => 'structure', 'members' => [ 'LimitsByRole' => [ 'shape' => 'LimitsByRole', ], ], ], 'DescribeOutboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'OutboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesFilter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'DescribePackagesFilterName', ], 'Value' => [ 'shape' => 'DescribePackagesFilterValues', ], ], ], 'DescribePackagesFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilter', ], ], 'DescribePackagesFilterName' => [ 'type' => 'string', 'enum' => [ 'PackageID', 'PackageName', 'PackageStatus', 'PackageType', 'EngineVersion', ], ], 'DescribePackagesFilterValue' => [ 'type' => 'string', 'pattern' => '^[0-9a-zA-Z\\*\\.\\_\\\\\\/\\?-]+$', ], 'DescribePackagesFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilterValue', ], 'min' => 1, ], 'DescribePackagesRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'DescribePackagesFilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetailsList' => [ 'shape' => 'PackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeReservedInstanceOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'offeringId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstanceOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ReservedInstanceOfferings' => [ 'shape' => 'ReservedInstanceOfferingList', ], ], ], 'DescribeReservedInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'reservationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ReservedInstances' => [ 'shape' => 'ReservedInstanceList', ], ], ], 'DescribeVpcEndpointsRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointIds', ], 'members' => [ 'VpcEndpointIds' => [ 'shape' => 'VpcEndpointIdList', ], ], ], 'DescribeVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoints', 'VpcEndpointErrors', ], 'members' => [ 'VpcEndpoints' => [ 'shape' => 'VpcEndpoints', ], 'VpcEndpointErrors' => [ 'shape' => 'VpcEndpointErrorList', ], ], ], 'Description' => [ 'type' => 'string', ], 'DisableTimestamp' => [ 'type' => 'timestamp', ], 'DisabledOperationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DissociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DissociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'DomainArn' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]+:[0-9]+:domain\\/[a-z0-9\\-]+', ], 'DomainConfig' => [ 'type' => 'structure', 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionStatus', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfigStatus', ], 'EBSOptions' => [ 'shape' => 'EBSOptionsStatus', ], 'AccessPolicies' => [ 'shape' => 'AccessPoliciesStatus', ], 'IPAddressType' => [ 'shape' => 'IPAddressTypeStatus', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptionsStatus', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfoStatus', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptionsStatus', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptionsStatus', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptionsStatus', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptionsStatus', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptionsStatus', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptionsStatus', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsStatus', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsStatus', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptionsStatus', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptionsStatus', ], 'ModifyingProperties' => [ 'shape' => 'ModifyingPropertiesList', ], ], ], 'DomainEndpointOptions' => [ 'type' => 'structure', 'members' => [ 'EnforceHTTPS' => [ 'shape' => 'Boolean', ], 'TLSSecurityPolicy' => [ 'shape' => 'TLSSecurityPolicy', ], 'CustomEndpointEnabled' => [ 'shape' => 'Boolean', ], 'CustomEndpoint' => [ 'shape' => 'DomainNameFqdn', ], 'CustomEndpointCertificateArn' => [ 'shape' => 'ARN', ], ], ], 'DomainEndpointOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'DomainEndpointOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'DomainHealth' => [ 'type' => 'string', 'enum' => [ 'Red', 'Yellow', 'Green', 'NotAvailable', ], ], 'DomainId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DomainInfo' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineType' => [ 'shape' => 'EngineType', ], ], ], 'DomainInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainInfo', ], ], 'DomainInformationContainer' => [ 'type' => 'structure', 'members' => [ 'AWSDomainInformation' => [ 'shape' => 'AWSDomainInformation', ], ], ], 'DomainMaintenanceDetails' => [ 'type' => 'structure', 'members' => [ 'MaintenanceId' => [ 'shape' => 'RequestId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'NodeId' => [ 'shape' => 'NodeId', ], 'Status' => [ 'shape' => 'MaintenanceStatus', ], 'StatusMessage' => [ 'shape' => 'MaintenanceStatusMessage', ], 'CreatedAt' => [ 'shape' => 'UpdateTimestamp', ], 'UpdatedAt' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'DomainMaintenanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainMaintenanceDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 28, 'min' => 3, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'DomainNameFqdn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$', ], 'DomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'DomainNodesStatus' => [ 'type' => 'structure', 'members' => [ 'NodeId' => [ 'shape' => 'NodeId', ], 'NodeType' => [ 'shape' => 'NodeType', ], 'AvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'NodeStatus' => [ 'shape' => 'NodeStatus', ], 'StorageType' => [ 'shape' => 'StorageTypeName', ], 'StorageVolumeType' => [ 'shape' => 'VolumeType', ], 'StorageSize' => [ 'shape' => 'VolumeSize', ], ], ], 'DomainNodesStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainNodesStatus', ], ], 'DomainPackageDetails' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'LastUpdated' => [ 'shape' => 'LastUpdated', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'DomainPackageStatus' => [ 'shape' => 'DomainPackageStatus', ], 'PackageVersion' => [ 'shape' => 'PackageVersion', ], 'ReferencePath' => [ 'shape' => 'ReferencePath', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], ], ], 'DomainPackageDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainPackageDetails', ], ], 'DomainPackageStatus' => [ 'type' => 'string', 'enum' => [ 'ASSOCIATING', 'ASSOCIATION_FAILED', 'ACTIVE', 'DISSOCIATING', 'DISSOCIATION_FAILED', ], ], 'DomainProcessingStatusType' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Active', 'Modifying', 'UpgradingEngineVersion', 'UpdatingServiceSoftware', 'Isolated', 'Deleting', ], ], 'DomainState' => [ 'type' => 'string', 'enum' => [ 'Active', 'Processing', 'NotAvailable', ], ], 'DomainStatus' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'DomainName', 'ARN', 'ClusterConfig', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'ARN' => [ 'shape' => 'ARN', ], 'Created' => [ 'shape' => 'Boolean', ], 'Deleted' => [ 'shape' => 'Boolean', ], 'Endpoint' => [ 'shape' => 'ServiceUrl', ], 'EndpointV2' => [ 'shape' => 'ServiceUrl', ], 'Endpoints' => [ 'shape' => 'EndpointsMap', ], 'Processing' => [ 'shape' => 'Boolean', ], 'UpgradeProcessing' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptions', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsOutput', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], 'DomainProcessingStatus' => [ 'shape' => 'DomainProcessingStatusType', ], 'ModifyingProperties' => [ 'shape' => 'ModifyingPropertiesList', ], ], ], 'DomainStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainStatus', ], ], 'Double' => [ 'type' => 'double', ], 'DryRun' => [ 'type' => 'boolean', ], 'DryRunMode' => [ 'type' => 'string', 'enum' => [ 'Basic', 'Verbose', ], ], 'DryRunProgressStatus' => [ 'type' => 'structure', 'required' => [ 'DryRunId', 'DryRunStatus', 'CreationDate', 'UpdateDate', ], 'members' => [ 'DryRunId' => [ 'shape' => 'GUID', ], 'DryRunStatus' => [ 'shape' => 'String', ], 'CreationDate' => [ 'shape' => 'String', ], 'UpdateDate' => [ 'shape' => 'String', ], 'ValidationFailures' => [ 'shape' => 'ValidationFailures', ], ], ], 'DryRunResults' => [ 'type' => 'structure', 'members' => [ 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'Message' => [ 'shape' => 'Message', ], ], ], 'Duration' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'DurationValue', ], 'Unit' => [ 'shape' => 'TimeUnit', ], ], ], 'DurationValue' => [ 'type' => 'long', 'max' => 24, 'min' => 1, ], 'EBSOptions' => [ 'type' => 'structure', 'members' => [ 'EBSEnabled' => [ 'shape' => 'Boolean', ], 'VolumeType' => [ 'shape' => 'VolumeType', ], 'VolumeSize' => [ 'shape' => 'IntegerClass', ], 'Iops' => [ 'shape' => 'IntegerClass', ], 'Throughput' => [ 'shape' => 'IntegerClass', ], ], ], 'EBSOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'EBSOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'EncryptionAtRestOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'EncryptionAtRestOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'EncryptionAtRestOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'Endpoint' => [ 'type' => 'string', 'pattern' => '^[A-Za-z0-9\\-\\.]+$', ], 'EndpointsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'ServiceUrl', ], ], 'EngineType' => [ 'type' => 'string', 'enum' => [ 'OpenSearch', 'Elasticsearch', ], ], 'EngineVersion' => [ 'type' => 'string', 'pattern' => '^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$', ], 'EnvironmentInfo' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneInformation' => [ 'shape' => 'AvailabilityZoneInfoList', ], ], ], 'EnvironmentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentInfo', ], ], 'ErrorDetails' => [ 'type' => 'structure', 'members' => [ 'ErrorType' => [ 'shape' => 'ErrorType', ], 'ErrorMessage' => [ 'shape' => 'ErrorMessage', ], ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorType' => [ 'type' => 'string', ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'ValueStringList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'GUID' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}', ], 'GUIDList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GUID', ], ], 'GetCompatibleVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], ], ], 'GetCompatibleVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CompatibleVersions' => [ 'shape' => 'CompatibleVersionsList', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'GetDomainMaintenanceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'MaintenanceId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaintenanceId' => [ 'shape' => 'RequestId', 'location' => 'querystring', 'locationName' => 'maintenanceId', ], ], ], 'GetDomainMaintenanceStatusResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'MaintenanceStatus', ], 'StatusMessage' => [ 'shape' => 'MaintenanceStatusMessage', ], 'NodeId' => [ 'shape' => 'NodeId', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'CreatedAt' => [ 'shape' => 'UpdateTimestamp', ], 'UpdatedAt' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'GetPackageVersionHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetPackageVersionHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageVersionHistoryList' => [ 'shape' => 'PackageVersionHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetUpgradeHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeHistories' => [ 'shape' => 'UpgradeHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'GetUpgradeStatusResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'StepStatus' => [ 'shape' => 'UpgradeStatus', ], 'UpgradeName' => [ 'shape' => 'UpgradeName', ], ], ], 'IPAddressType' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'dualstack', ], ], 'IPAddressTypeStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'IPAddressType', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'IdentityPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+:[0-9a-f-]+', ], 'InboundConnection' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionStatus' => [ 'shape' => 'InboundConnectionStatus', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], ], ], 'InboundConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'InboundConnectionStatusCode', ], 'Message' => [ 'shape' => 'ConnectionStatusMessage', ], ], ], 'InboundConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'APPROVED', 'PROVISIONING', 'ACTIVE', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'InboundConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'InboundConnection', ], ], 'InitiatedBy' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SERVICE', ], ], 'InstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InstanceCountLimits' => [ 'type' => 'structure', 'members' => [ 'MinimumInstanceCount' => [ 'shape' => 'MinimumInstanceCount', ], 'MaximumInstanceCount' => [ 'shape' => 'MaximumInstanceCount', ], ], ], 'InstanceLimits' => [ 'type' => 'structure', 'members' => [ 'InstanceCountLimits' => [ 'shape' => 'InstanceCountLimits', ], ], ], 'InstanceRole' => [ 'type' => 'string', ], 'InstanceRoleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceRole', ], ], 'InstanceTypeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'EncryptionEnabled' => [ 'shape' => 'Boolean', ], 'CognitoEnabled' => [ 'shape' => 'Boolean', ], 'AppLogsEnabled' => [ 'shape' => 'Boolean', ], 'AdvancedSecurityEnabled' => [ 'shape' => 'Boolean', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleList', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'InstanceTypeDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeDetails', ], ], 'InstanceTypeString' => [ 'type' => 'string', 'max' => 40, 'min' => 10, 'pattern' => '^.*\\..*\\.search$', ], 'Integer' => [ 'type' => 'integer', ], 'IntegerClass' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Issue' => [ 'type' => 'string', ], 'Issues' => [ 'type' => 'list', 'member' => [ 'shape' => 'Issue', ], ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.*', ], 'LastUpdated' => [ 'type' => 'timestamp', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'LimitName' => [ 'type' => 'string', ], 'LimitValue' => [ 'type' => 'string', ], 'LimitValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LimitValue', ], ], 'Limits' => [ 'type' => 'structure', 'members' => [ 'StorageTypes' => [ 'shape' => 'StorageTypeList', ], 'InstanceLimits' => [ 'shape' => 'InstanceLimits', ], 'AdditionalLimits' => [ 'shape' => 'AdditionalLimitList', ], ], ], 'LimitsByRole' => [ 'type' => 'map', 'key' => [ 'shape' => 'InstanceRole', ], 'value' => [ 'shape' => 'Limits', ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'DataSourceList', ], ], ], 'ListDomainMaintenancesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', 'location' => 'querystring', 'locationName' => 'action', ], 'Status' => [ 'shape' => 'MaintenanceStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainMaintenancesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainMaintenances' => [ 'shape' => 'DomainMaintenanceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainNamesRequest' => [ 'type' => 'structure', 'members' => [ 'EngineType' => [ 'shape' => 'EngineType', 'location' => 'querystring', 'locationName' => 'engineType', ], ], ], 'ListDomainNamesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNames' => [ 'shape' => 'DomainInfoList', ], ], ], 'ListDomainsForPackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainsForPackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListInstanceTypeDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'EngineVersion', ], 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'RetrieveAZs' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'retrieveAZs', ], 'InstanceType' => [ 'shape' => 'InstanceTypeString', 'location' => 'querystring', 'locationName' => 'instanceType', ], ], ], 'ListInstanceTypeDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceTypeDetails' => [ 'shape' => 'InstanceTypeDetailsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPackagesForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPackagesForDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListScheduledActionsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListScheduledActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledActions' => [ 'shape' => 'ScheduledActionsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'ListVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'Versions' => [ 'shape' => 'VersionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipalList', 'NextToken', ], 'members' => [ 'AuthorizedPrincipalList' => [ 'shape' => 'AuthorizedPrincipalList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsForDomainResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogPublishingOption' => [ 'type' => 'structure', 'members' => [ 'CloudWatchLogsLogGroupArn' => [ 'shape' => 'CloudWatchLogsLogGroupArn', ], 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'LogPublishingOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LogType', ], 'value' => [ 'shape' => 'LogPublishingOption', ], ], 'LogPublishingOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'LogPublishingOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'INDEX_SLOW_LOGS', 'SEARCH_SLOW_LOGS', 'ES_APPLICATION_LOGS', 'AUDIT_LOGS', ], ], 'Long' => [ 'type' => 'long', ], 'MaintenanceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'TIMED_OUT', ], ], 'MaintenanceStatusMessage' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^([\\s\\S]*)$', ], 'MaintenanceType' => [ 'type' => 'string', 'enum' => [ 'REBOOT_NODE', 'RESTART_SEARCH_PROCESS', 'RESTART_DASHBOARD', ], ], 'MasterNodeStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'UnAvailable', ], ], 'MasterUserOptions' => [ 'type' => 'structure', 'members' => [ 'MasterUserARN' => [ 'shape' => 'ARN', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterUserPassword' => [ 'shape' => 'Password', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'MaximumInstanceCount' => [ 'type' => 'integer', ], 'Message' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'MinimumInstanceCount' => [ 'type' => 'integer', ], 'ModifyingProperties' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ActiveValue' => [ 'shape' => 'String', ], 'PendingValue' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'PropertyValueType', ], ], ], 'ModifyingPropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModifyingProperties', ], ], 'NextToken' => [ 'type' => 'string', ], 'NodeId' => [ 'type' => 'string', 'max' => 40, 'min' => 10, ], 'NodeStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'StandBy', 'NotAvailable', ], ], 'NodeToNodeEncryptionOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'NodeType' => [ 'type' => 'string', 'enum' => [ 'Data', 'Ultrawarm', 'Master', ], ], 'NonEmptyString' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\-\\_\\.]+', ], 'NumberOfAZs' => [ 'type' => 'string', 'pattern' => '^((\\d+)|(NotAvailable))$', ], 'NumberOfNodes' => [ 'type' => 'string', 'pattern' => '^((\\d+)|(NotAvailable))$', ], 'NumberOfShards' => [ 'type' => 'string', 'pattern' => '^((\\d+)|(NotAvailable))$', ], 'OffPeakWindow' => [ 'type' => 'structure', 'members' => [ 'WindowStartTime' => [ 'shape' => 'WindowStartTime', ], ], ], 'OffPeakWindowOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'OffPeakWindow' => [ 'shape' => 'OffPeakWindow', ], ], ], 'OffPeakWindowOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'OffPeakWindowOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'OpenSearchPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'm3.medium.search', 'm3.large.search', 'm3.xlarge.search', 'm3.2xlarge.search', 'm4.large.search', 'm4.xlarge.search', 'm4.2xlarge.search', 'm4.4xlarge.search', 'm4.10xlarge.search', 'm5.large.search', 'm5.xlarge.search', 'm5.2xlarge.search', 'm5.4xlarge.search', 'm5.12xlarge.search', 'm5.24xlarge.search', 'r5.large.search', 'r5.xlarge.search', 'r5.2xlarge.search', 'r5.4xlarge.search', 'r5.12xlarge.search', 'r5.24xlarge.search', 'c5.large.search', 'c5.xlarge.search', 'c5.2xlarge.search', 'c5.4xlarge.search', 'c5.9xlarge.search', 'c5.18xlarge.search', 't3.nano.search', 't3.micro.search', 't3.small.search', 't3.medium.search', 't3.large.search', 't3.xlarge.search', 't3.2xlarge.search', 'or1.medium.search', 'or1.large.search', 'or1.xlarge.search', 'or1.2xlarge.search', 'or1.4xlarge.search', 'or1.8xlarge.search', 'or1.12xlarge.search', 'or1.16xlarge.search', 'ultrawarm1.medium.search', 'ultrawarm1.large.search', 'ultrawarm1.xlarge.search', 't2.micro.search', 't2.small.search', 't2.medium.search', 'r3.large.search', 'r3.xlarge.search', 'r3.2xlarge.search', 'r3.4xlarge.search', 'r3.8xlarge.search', 'i2.xlarge.search', 'i2.2xlarge.search', 'd2.xlarge.search', 'd2.2xlarge.search', 'd2.4xlarge.search', 'd2.8xlarge.search', 'c4.large.search', 'c4.xlarge.search', 'c4.2xlarge.search', 'c4.4xlarge.search', 'c4.8xlarge.search', 'r4.large.search', 'r4.xlarge.search', 'r4.2xlarge.search', 'r4.4xlarge.search', 'r4.8xlarge.search', 'r4.16xlarge.search', 'i3.large.search', 'i3.xlarge.search', 'i3.2xlarge.search', 'i3.4xlarge.search', 'i3.8xlarge.search', 'i3.16xlarge.search', 'r6g.large.search', 'r6g.xlarge.search', 'r6g.2xlarge.search', 'r6g.4xlarge.search', 'r6g.8xlarge.search', 'r6g.12xlarge.search', 'm6g.large.search', 'm6g.xlarge.search', 'm6g.2xlarge.search', 'm6g.4xlarge.search', 'm6g.8xlarge.search', 'm6g.12xlarge.search', 'c6g.large.search', 'c6g.xlarge.search', 'c6g.2xlarge.search', 'c6g.4xlarge.search', 'c6g.8xlarge.search', 'c6g.12xlarge.search', 'r6gd.large.search', 'r6gd.xlarge.search', 'r6gd.2xlarge.search', 'r6gd.4xlarge.search', 'r6gd.8xlarge.search', 'r6gd.12xlarge.search', 'r6gd.16xlarge.search', 't4g.small.search', 't4g.medium.search', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'ultrawarm1.medium.search', 'ultrawarm1.large.search', 'ultrawarm1.xlarge.search', ], ], 'OptionState' => [ 'type' => 'string', 'enum' => [ 'RequiresIndexDocuments', 'Processing', 'Active', ], ], 'OptionStatus' => [ 'type' => 'structure', 'required' => [ 'CreationDate', 'UpdateDate', 'State', ], 'members' => [ 'CreationDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateVersion' => [ 'shape' => 'UIntValue', ], 'State' => [ 'shape' => 'OptionState', ], 'PendingDeletion' => [ 'shape' => 'Boolean', ], ], ], 'OutboundConnection' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundConnectionStatus', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'OutboundConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'OutboundConnectionStatusCode', ], 'Message' => [ 'shape' => 'ConnectionStatusMessage', ], ], ], 'OutboundConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'VALIDATING', 'VALIDATION_FAILED', 'PENDING_ACCEPTANCE', 'APPROVED', 'PROVISIONING', 'ACTIVE', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'OutboundConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutboundConnection', ], ], 'OverallChangeStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PROCESSING', 'COMPLETED', 'FAILED', ], ], 'OwnerId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[0-9]+', ], 'PackageDescription' => [ 'type' => 'string', 'max' => 1024, ], 'PackageDetails' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'PackageStatus' => [ 'shape' => 'PackageStatus', ], 'CreatedAt' => [ 'shape' => 'CreatedAt', ], 'LastUpdatedAt' => [ 'shape' => 'LastUpdated', ], 'AvailablePackageVersion' => [ 'shape' => 'PackageVersion', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'EngineVersion' => [ 'shape' => 'EngineVersion', ], 'AvailablePluginProperties' => [ 'shape' => 'PluginProperties', ], ], ], 'PackageDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageDetails', ], ], 'PackageID' => [ 'type' => 'string', 'pattern' => '^([FG][0-9]+)$', ], 'PackageName' => [ 'type' => 'string', 'max' => 256, 'min' => 3, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'PackageSource' => [ 'type' => 'structure', 'members' => [ 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Key' => [ 'shape' => 'S3Key', ], ], ], 'PackageStatus' => [ 'type' => 'string', 'enum' => [ 'COPYING', 'COPY_FAILED', 'VALIDATING', 'VALIDATION_FAILED', 'AVAILABLE', 'DELETING', 'DELETED', 'DELETE_FAILED', ], ], 'PackageType' => [ 'type' => 'string', 'enum' => [ 'TXT-DICTIONARY', 'ZIP-PLUGIN', ], ], 'PackageVersion' => [ 'type' => 'string', ], 'PackageVersionHistory' => [ 'type' => 'structure', 'members' => [ 'PackageVersion' => [ 'shape' => 'PackageVersion', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], 'CreatedAt' => [ 'shape' => 'CreatedAt', ], 'PluginProperties' => [ 'shape' => 'PluginProperties', ], ], ], 'PackageVersionHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersionHistory', ], ], 'Password' => [ 'type' => 'string', 'max' => 128, 'min' => 8, 'pattern' => '.*', 'sensitive' => true, ], 'PluginClassName' => [ 'type' => 'string', 'max' => 1024, ], 'PluginDescription' => [ 'type' => 'string', 'max' => 1024, ], 'PluginName' => [ 'type' => 'string', 'max' => 1024, ], 'PluginProperties' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PluginName', ], 'Description' => [ 'shape' => 'PluginDescription', ], 'Version' => [ 'shape' => 'PluginVersion', ], 'ClassName' => [ 'shape' => 'PluginClassName', ], 'UncompressedSizeInBytes' => [ 'shape' => 'UncompressedPluginSizeInBytes', ], ], ], 'PluginVersion' => [ 'type' => 'string', 'max' => 1024, ], 'PolicyDocument' => [ 'type' => 'string', 'max' => 102400, 'min' => 0, 'pattern' => '.*', ], 'PrincipalType' => [ 'type' => 'string', 'enum' => [ 'AWS_ACCOUNT', 'AWS_SERVICE', ], ], 'PropertyValueType' => [ 'type' => 'string', 'enum' => [ 'PLAIN_TEXT', 'STRINGIFIED_JSON', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'type' => 'structure', 'required' => [ 'ReservedInstanceOfferingId', 'ReservationName', ], 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], ], ], 'PurchaseReservedInstanceOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', ], ], 'ReferencePath' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', 'max' => 30, 'min' => 5, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'RejectInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'RejectInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'RemoveTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagKeys', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'RequestId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^([\\s\\S]*)$', ], 'ReservationToken' => [ 'type' => 'string', 'max' => 64, 'min' => 5, 'pattern' => '.*', ], 'ReservedInstance' => [ 'type' => 'structure', 'members' => [ 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'BillingSubscriptionId' => [ 'shape' => 'Long', ], 'ReservedInstanceOfferingId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstance', ], ], 'ReservedInstanceOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstanceOffering', ], ], 'ReservedInstancePaymentOption' => [ 'type' => 'string', 'enum' => [ 'ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT', ], ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'RevokeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'RevokeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'members' => [], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*', ], 'RollbackOnDisable' => [ 'type' => 'string', 'enum' => [ 'NO_ROLLBACK', 'DEFAULT_ROLLBACK', ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3GlueDataCatalog' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SAMLEntityId' => [ 'type' => 'string', 'max' => 512, 'min' => 8, ], 'SAMLIdp' => [ 'type' => 'structure', 'required' => [ 'MetadataContent', 'EntityId', ], 'members' => [ 'MetadataContent' => [ 'shape' => 'SAMLMetadata', ], 'EntityId' => [ 'shape' => 'SAMLEntityId', ], ], ], 'SAMLMetadata' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, ], 'SAMLOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterBackendRole' => [ 'shape' => 'BackendRole', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'SAMLOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'ScheduleAt' => [ 'type' => 'string', 'enum' => [ 'NOW', 'TIMESTAMP', 'OFF_PEAK_WINDOW', ], ], 'ScheduledAction' => [ 'type' => 'structure', 'required' => [ 'Id', 'Type', 'Severity', 'ScheduledTime', ], 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'ActionType', ], 'Severity' => [ 'shape' => 'ActionSeverity', ], 'ScheduledTime' => [ 'shape' => 'Long', ], 'Description' => [ 'shape' => 'String', ], 'ScheduledBy' => [ 'shape' => 'ScheduledBy', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Mandatory' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], ], ], 'ScheduledActionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScheduledAction', ], ], 'ScheduledAutoTuneActionType' => [ 'type' => 'string', 'enum' => [ 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'ScheduledAutoTuneDescription' => [ 'type' => 'string', ], 'ScheduledAutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'AutoTuneDate', ], 'ActionType' => [ 'shape' => 'ScheduledAutoTuneActionType', ], 'Action' => [ 'shape' => 'ScheduledAutoTuneDescription', ], 'Severity' => [ 'shape' => 'ScheduledAutoTuneSeverityType', ], ], ], 'ScheduledAutoTuneSeverityType' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', ], ], 'ScheduledBy' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SYSTEM', ], ], 'ServiceSoftwareOptions' => [ 'type' => 'structure', 'members' => [ 'CurrentVersion' => [ 'shape' => 'String', ], 'NewVersion' => [ 'shape' => 'String', ], 'UpdateAvailable' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], 'UpdateStatus' => [ 'shape' => 'DeploymentStatus', ], 'Description' => [ 'shape' => 'String', ], 'AutomatedUpdateDate' => [ 'shape' => 'DeploymentCloseDateTimeStamp', ], 'OptionalDeployment' => [ 'shape' => 'Boolean', ], ], ], 'ServiceUrl' => [ 'type' => 'string', ], 'SkipUnavailableStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SlotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Long', ], ], 'SlotNotAvailableException' => [ 'type' => 'structure', 'members' => [ 'SlotSuggestions' => [ 'shape' => 'SlotList', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'SnapshotOptions' => [ 'type' => 'structure', 'members' => [ 'AutomatedSnapshotStartHour' => [ 'shape' => 'IntegerClass', ], ], ], 'SnapshotOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'SnapshotOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'SoftwareUpdateOptions' => [ 'type' => 'structure', 'members' => [ 'AutoSoftwareUpdateEnabled' => [ 'shape' => 'Boolean', ], ], ], 'SoftwareUpdateOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'SoftwareUpdateOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'StartAt' => [ 'type' => 'timestamp', ], 'StartDomainMaintenanceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Action', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'NodeId' => [ 'shape' => 'NodeId', ], ], ], 'StartDomainMaintenanceResponse' => [ 'type' => 'structure', 'members' => [ 'MaintenanceId' => [ 'shape' => 'RequestId', ], ], ], 'StartServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'StartServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'StartTimeHours' => [ 'type' => 'long', 'max' => 23, 'min' => 0, ], 'StartTimeMinutes' => [ 'type' => 'long', 'max' => 59, 'min' => 0, ], 'StartTimestamp' => [ 'type' => 'timestamp', ], 'StorageSubTypeName' => [ 'type' => 'string', ], 'StorageType' => [ 'type' => 'structure', 'members' => [ 'StorageTypeName' => [ 'shape' => 'StorageTypeName', ], 'StorageSubTypeName' => [ 'shape' => 'StorageSubTypeName', ], 'StorageTypeLimits' => [ 'shape' => 'StorageTypeLimitList', ], ], ], 'StorageTypeLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'StorageTypeLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageTypeLimit', ], ], 'StorageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageType', ], ], 'StorageTypeName' => [ 'type' => 'string', ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'TLSSecurityPolicy' => [ 'type' => 'string', 'enum' => [ 'Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07', 'Policy-Min-TLS-1-2-PFS-2023-10', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'TimeUnit' => [ 'type' => 'string', 'enum' => [ 'HOURS', ], ], 'TotalNumberOfStages' => [ 'type' => 'integer', ], 'UIntValue' => [ 'type' => 'integer', 'min' => 0, ], 'UncompressedPluginSizeInBytes' => [ 'type' => 'long', ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'UpdateDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptions', ], 'DryRun' => [ 'shape' => 'DryRun', ], 'DryRunMode' => [ 'shape' => 'DryRunMode', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'UpdateDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], ], ], 'UpdatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'PackageSource', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], ], ], 'UpdatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'UpdateScheduledActionRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'ActionID', 'ActionType', 'ScheduleAt', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ActionID' => [ 'shape' => 'String', ], 'ActionType' => [ 'shape' => 'ActionType', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'UpdateScheduledActionResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledAction' => [ 'shape' => 'ScheduledAction', ], ], ], 'UpdateTimestamp' => [ 'type' => 'timestamp', ], 'UpdateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', 'VpcOptions', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], ], ], 'UpdateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'UpgradeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'TargetVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], ], ], 'UpgradeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeId' => [ 'shape' => 'String', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], ], ], 'UpgradeHistory' => [ 'type' => 'structure', 'members' => [ 'UpgradeName' => [ 'shape' => 'UpgradeName', ], 'StartTimestamp' => [ 'shape' => 'StartTimestamp', ], 'UpgradeStatus' => [ 'shape' => 'UpgradeStatus', ], 'StepsList' => [ 'shape' => 'UpgradeStepsList', ], ], ], 'UpgradeHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeHistory', ], ], 'UpgradeName' => [ 'type' => 'string', ], 'UpgradeStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'SUCCEEDED', 'SUCCEEDED_WITH_ISSUES', 'FAILED', ], ], 'UpgradeStep' => [ 'type' => 'string', 'enum' => [ 'PRE_UPGRADE_CHECK', 'SNAPSHOT', 'UPGRADE', ], ], 'UpgradeStepItem' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'UpgradeStepStatus' => [ 'shape' => 'UpgradeStatus', ], 'Issues' => [ 'shape' => 'Issues', ], 'ProgressPercent' => [ 'shape' => 'Double', ], ], ], 'UpgradeStepsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeStepItem', ], ], 'UserPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'Username' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', 'sensitive' => true, ], 'VPCDerivedInfo' => [ 'type' => 'structure', 'members' => [ 'VPCId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'StringList', ], 'AvailabilityZones' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'VPCDerivedInfoStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VPCOptions' => [ 'type' => 'structure', 'members' => [ 'SubnetIds' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationFailure' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationFailures' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationFailure', ], ], 'ValueStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'min' => 1, ], 'VersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionString', ], ], 'VersionStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VersionString', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VersionString' => [ 'type' => 'string', 'max' => 18, 'min' => 14, 'pattern' => '^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$', ], 'VolumeSize' => [ 'type' => 'string', ], 'VolumeType' => [ 'type' => 'string', 'enum' => [ 'standard', 'gp2', 'io1', 'gp3', ], ], 'VpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'AWSAccount', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], ], ], 'VpcEndpointError' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'ErrorCode' => [ 'shape' => 'VpcEndpointErrorCode', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'VpcEndpointErrorCode' => [ 'type' => 'string', 'enum' => [ 'ENDPOINT_NOT_FOUND', 'SERVER_ERROR', ], ], 'VpcEndpointErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointError', ], ], 'VpcEndpointId' => [ 'type' => 'string', 'max' => 256, 'min' => 5, 'pattern' => '^aos-[a-zA-Z0-9]*$', ], 'VpcEndpointIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointId', ], ], 'VpcEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATE_FAILED', 'ACTIVE', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'VpcEndpointSummary' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'String', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], ], ], 'VpcEndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointSummary', ], ], 'VpcEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpoint', ], ], 'WindowStartTime' => [ 'type' => 'structure', 'required' => [ 'Hours', 'Minutes', ], 'members' => [ 'Hours' => [ 'shape' => 'StartTimeHours', ], 'Minutes' => [ 'shape' => 'StartTimeMinutes', ], ], ], 'ZoneAwarenessConfig' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneCount' => [ 'shape' => 'IntegerClass', ], ], ], 'ZoneStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'StandBy', 'NotAvailable', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2021-01-01', 'endpointPrefix' => 'es', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon OpenSearch Service', 'serviceId' => 'OpenSearch', 'signatureVersion' => 'v4', 'uid' => 'opensearch-2021-01-01', ], 'operations' => [ 'AcceptInboundConnection' => [ 'name' => 'AcceptInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept', ], 'input' => [ 'shape' => 'AcceptInboundConnectionRequest', ], 'output' => [ 'shape' => 'AcceptInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'AddDataSource' => [ 'name' => 'AddDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'AddDataSourceRequest', ], 'output' => [ 'shape' => 'AddDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags', ], 'input' => [ 'shape' => 'AddTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'AssociatePackage' => [ 'name' => 'AssociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/associate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'AssociatePackageRequest', ], 'output' => [ 'shape' => 'AssociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'AuthorizeVpcEndpointAccess' => [ 'name' => 'AuthorizeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess', ], 'input' => [ 'shape' => 'AuthorizeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'AuthorizeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'CancelDomainConfigChange' => [ 'name' => 'CancelDomainConfigChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config/cancel', ], 'input' => [ 'shape' => 'CancelDomainConfigChangeRequest', ], 'output' => [ 'shape' => 'CancelDomainConfigChangeResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CancelServiceSoftwareUpdate' => [ 'name' => 'CancelServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/cancel', ], 'input' => [ 'shape' => 'CancelServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'CancelServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateOutboundConnection' => [ 'name' => 'CreateOutboundConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection', ], 'input' => [ 'shape' => 'CreateOutboundConnectionRequest', ], 'output' => [ 'shape' => 'CreateOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CreatePackage' => [ 'name' => 'CreatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages', ], 'input' => [ 'shape' => 'CreatePackageRequest', ], 'output' => [ 'shape' => 'CreatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateVpcEndpoint' => [ 'name' => 'CreateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'CreateVpcEndpointRequest', ], 'output' => [ 'shape' => 'CreateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteInboundConnection' => [ 'name' => 'DeleteInboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteInboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeleteOutboundConnection' => [ 'name' => 'DeleteOutboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteOutboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/packages/{PackageID}', ], 'input' => [ 'shape' => 'DeletePackageRequest', ], 'output' => [ 'shape' => 'DeletePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteVpcEndpoint' => [ 'name' => 'DeleteVpcEndpoint', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}', ], 'input' => [ 'shape' => 'DeleteVpcEndpointRequest', ], 'output' => [ 'shape' => 'DeleteVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainAutoTunes' => [ 'name' => 'DescribeDomainAutoTunes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/autoTunes', ], 'input' => [ 'shape' => 'DescribeDomainAutoTunesRequest', ], 'output' => [ 'shape' => 'DescribeDomainAutoTunesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainChangeProgress' => [ 'name' => 'DescribeDomainChangeProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/progress', ], 'input' => [ 'shape' => 'DescribeDomainChangeProgressRequest', ], 'output' => [ 'shape' => 'DescribeDomainChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainConfig' => [ 'name' => 'DescribeDomainConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'DescribeDomainConfigRequest', ], 'output' => [ 'shape' => 'DescribeDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainHealth' => [ 'name' => 'DescribeDomainHealth', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/health', ], 'input' => [ 'shape' => 'DescribeDomainHealthRequest', ], 'output' => [ 'shape' => 'DescribeDomainHealthResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeDomainNodes' => [ 'name' => 'DescribeDomainNodes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/nodes', ], 'input' => [ 'shape' => 'DescribeDomainNodesRequest', ], 'output' => [ 'shape' => 'DescribeDomainNodesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DescribeDomains' => [ 'name' => 'DescribeDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain-info', ], 'input' => [ 'shape' => 'DescribeDomainsRequest', ], 'output' => [ 'shape' => 'DescribeDomainsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDryRunProgress' => [ 'name' => 'DescribeDryRunProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dryRun', ], 'input' => [ 'shape' => 'DescribeDryRunProgressRequest', ], 'output' => [ 'shape' => 'DescribeDryRunProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInboundConnections' => [ 'name' => 'DescribeInboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/search', ], 'input' => [ 'shape' => 'DescribeInboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeInboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInstanceTypeLimits' => [ 'name' => 'DescribeInstanceTypeLimits', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}', ], 'input' => [ 'shape' => 'DescribeInstanceTypeLimitsRequest', ], 'output' => [ 'shape' => 'DescribeInstanceTypeLimitsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeOutboundConnections' => [ 'name' => 'DescribeOutboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/search', ], 'input' => [ 'shape' => 'DescribeOutboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeOutboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribePackages' => [ 'name' => 'DescribePackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/describe', ], 'input' => [ 'shape' => 'DescribePackagesRequest', ], 'output' => [ 'shape' => 'DescribePackagesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeReservedInstanceOfferings' => [ 'name' => 'DescribeReservedInstanceOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstanceOfferings', ], 'input' => [ 'shape' => 'DescribeReservedInstanceOfferingsRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstanceOfferingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], ], ], 'DescribeReservedInstances' => [ 'name' => 'DescribeReservedInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstances', ], 'input' => [ 'shape' => 'DescribeReservedInstancesRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstancesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeVpcEndpoints' => [ 'name' => 'DescribeVpcEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/describe', ], 'input' => [ 'shape' => 'DescribeVpcEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DissociatePackage' => [ 'name' => 'DissociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/dissociate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'DissociatePackageRequest', ], 'output' => [ 'shape' => 'DissociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetCompatibleVersions' => [ 'name' => 'GetCompatibleVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/compatibleVersions', ], 'input' => [ 'shape' => 'GetCompatibleVersionsRequest', ], 'output' => [ 'shape' => 'GetCompatibleVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'GetDomainMaintenanceStatus' => [ 'name' => 'GetDomainMaintenanceStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'GetDomainMaintenanceStatusRequest', ], 'output' => [ 'shape' => 'GetDomainMaintenanceStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'GetPackageVersionHistory' => [ 'name' => 'GetPackageVersionHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/history', ], 'input' => [ 'shape' => 'GetPackageVersionHistoryRequest', ], 'output' => [ 'shape' => 'GetPackageVersionHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetUpgradeHistory' => [ 'name' => 'GetUpgradeHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/history', ], 'input' => [ 'shape' => 'GetUpgradeHistoryRequest', ], 'output' => [ 'shape' => 'GetUpgradeHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetUpgradeStatus' => [ 'name' => 'GetUpgradeStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/status', ], 'input' => [ 'shape' => 'GetUpgradeStatusRequest', ], 'output' => [ 'shape' => 'GetUpgradeStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'ListDomainMaintenances' => [ 'name' => 'ListDomainMaintenances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances', ], 'input' => [ 'shape' => 'ListDomainMaintenancesRequest', ], 'output' => [ 'shape' => 'ListDomainMaintenancesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'ListDomainNames' => [ 'name' => 'ListDomainNames', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain', ], 'input' => [ 'shape' => 'ListDomainNamesRequest', ], 'output' => [ 'shape' => 'ListDomainNamesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListDomainsForPackage' => [ 'name' => 'ListDomainsForPackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/domains', ], 'input' => [ 'shape' => 'ListDomainsForPackageRequest', ], 'output' => [ 'shape' => 'ListDomainsForPackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListInstanceTypeDetails' => [ 'name' => 'ListInstanceTypeDetails', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}', ], 'input' => [ 'shape' => 'ListInstanceTypeDetailsRequest', ], 'output' => [ 'shape' => 'ListInstanceTypeDetailsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackagesForDomain' => [ 'name' => 'ListPackagesForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain/{DomainName}/packages', ], 'input' => [ 'shape' => 'ListPackagesForDomainRequest', ], 'output' => [ 'shape' => 'ListPackagesForDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListScheduledActions' => [ 'name' => 'ListScheduledActions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledActions', ], 'input' => [ 'shape' => 'ListScheduledActionsRequest', ], 'output' => [ 'shape' => 'ListScheduledActionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/tags/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListVersions' => [ 'name' => 'ListVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/versions', ], 'input' => [ 'shape' => 'ListVersionsRequest', ], 'output' => [ 'shape' => 'ListVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListVpcEndpointAccess' => [ 'name' => 'ListVpcEndpointAccess', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess', ], 'input' => [ 'shape' => 'ListVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpoints' => [ 'name' => 'ListVpcEndpoints', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpointsForDomain' => [ 'name' => 'ListVpcEndpointsForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsForDomainRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsForDomainResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'BaseException', ], ], ], 'PurchaseReservedInstanceOffering' => [ 'name' => 'PurchaseReservedInstanceOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/purchaseReservedInstanceOffering', ], 'input' => [ 'shape' => 'PurchaseReservedInstanceOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseReservedInstanceOfferingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RejectInboundConnection' => [ 'name' => 'RejectInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject', ], 'input' => [ 'shape' => 'RejectInboundConnectionRequest', ], 'output' => [ 'shape' => 'RejectInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags-removal', ], 'input' => [ 'shape' => 'RemoveTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RevokeVpcEndpointAccess' => [ 'name' => 'RevokeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess', ], 'input' => [ 'shape' => 'RevokeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'RevokeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'StartDomainMaintenance' => [ 'name' => 'StartDomainMaintenance', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'StartDomainMaintenanceRequest', ], 'output' => [ 'shape' => 'StartDomainMaintenanceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'StartServiceSoftwareUpdate' => [ 'name' => 'StartServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/start', ], 'input' => [ 'shape' => 'StartServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'StartServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'UpdateDomainConfig' => [ 'name' => 'UpdateDomainConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'UpdateDomainConfigRequest', ], 'output' => [ 'shape' => 'UpdateDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackage' => [ 'name' => 'UpdatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/update', ], 'input' => [ 'shape' => 'UpdatePackageRequest', ], 'output' => [ 'shape' => 'UpdatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateScheduledAction' => [ 'name' => 'UpdateScheduledAction', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update', ], 'input' => [ 'shape' => 'UpdateScheduledActionRequest', ], 'output' => [ 'shape' => 'UpdateScheduledActionResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'SlotNotAvailableException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateVpcEndpoint' => [ 'name' => 'UpdateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/update', ], 'input' => [ 'shape' => 'UpdateVpcEndpointRequest', ], 'output' => [ 'shape' => 'UpdateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'BaseException', ], ], ], 'UpgradeDomain' => [ 'name' => 'UpgradeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain', ], 'input' => [ 'shape' => 'UpgradeDomainRequest', ], 'output' => [ 'shape' => 'UpgradeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*', ], 'AWSAccount' => [ 'type' => 'string', 'pattern' => '^[0-9]+$', ], 'AWSDomainInformation' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'OwnerId' => [ 'shape' => 'OwnerId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Region' => [ 'shape' => 'Region', ], ], ], 'AcceptInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'AcceptInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccessPoliciesStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'PolicyDocument', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ActionSeverity' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'MEDIUM', 'LOW', ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'FAILED', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'SERVICE_SOFTWARE_UPDATE', 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'AddDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'AddDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'AddTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagList', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'AdditionalLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'AdditionalLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalLimit', ], ], 'AdvancedOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'AdvancedOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AdvancedSecurityOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedSecurityOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AssociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'AssociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipal', ], 'members' => [ 'AuthorizedPrincipal' => [ 'shape' => 'AuthorizedPrincipal', ], ], ], 'AuthorizedPrincipal' => [ 'type' => 'structure', 'members' => [ 'PrincipalType' => [ 'shape' => 'PrincipalType', ], 'Principal' => [ 'shape' => 'String', ], ], ], 'AuthorizedPrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedPrincipal', ], ], 'AutoTune' => [ 'type' => 'structure', 'members' => [ 'AutoTuneType' => [ 'shape' => 'AutoTuneType', ], 'AutoTuneDetails' => [ 'shape' => 'AutoTuneDetails', ], ], ], 'AutoTuneDate' => [ 'type' => 'timestamp', ], 'AutoTuneDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'ScheduledAutoTuneDetails' => [ 'shape' => 'ScheduledAutoTuneDetails', ], ], ], 'AutoTuneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTune', ], ], 'AutoTuneMaintenanceSchedule' => [ 'type' => 'structure', 'members' => [ 'StartAt' => [ 'shape' => 'StartAt', ], 'Duration' => [ 'shape' => 'Duration', ], 'CronExpressionForRecurrence' => [ 'shape' => 'String', ], ], ], 'AutoTuneMaintenanceScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTuneMaintenanceSchedule', ], 'max' => 100, ], 'AutoTuneOptions' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'RollbackOnDisable' => [ 'shape' => 'RollbackOnDisable', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'AutoTuneOptions', ], 'Status' => [ 'shape' => 'AutoTuneStatus', ], ], ], 'AutoTuneState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'ENABLE_IN_PROGRESS', 'DISABLE_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_SCHEDULED', 'DISABLED_AND_ROLLBACK_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_COMPLETE', 'DISABLED_AND_ROLLBACK_ERROR', 'ERROR', ], ], 'AutoTuneStatus' => [ 'type' => 'structure', 'required' => [ 'CreationDate', 'UpdateDate', 'State', ], 'members' => [ 'CreationDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateVersion' => [ 'shape' => 'UIntValue', ], 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'PendingDeletion' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneType' => [ 'type' => 'string', 'enum' => [ 'SCHEDULED_ACTION', ], ], 'AvailabilityZone' => [ 'type' => 'string', 'max' => 15, 'min' => 1, ], 'AvailabilityZoneInfo' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneName' => [ 'shape' => 'AvailabilityZone', ], 'ZoneStatus' => [ 'shape' => 'ZoneStatus', ], 'ConfiguredDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'AvailableDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], ], ], 'AvailabilityZoneInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZoneInfo', ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'BackendRole' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BaseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CancelDomainConfigChangeRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'DryRun' => [ 'shape' => 'DryRun', ], ], ], 'CancelDomainConfigChangeResponse' => [ 'type' => 'structure', 'members' => [ 'CancelledChangeIds' => [ 'shape' => 'GUIDList', ], 'CancelledChangeProperties' => [ 'shape' => 'CancelledChangePropertyList', ], 'DryRun' => [ 'shape' => 'DryRun', ], ], ], 'CancelServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'CancelServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'CancelledChangeProperty' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'String', ], 'CancelledValue' => [ 'shape' => 'String', ], 'ActiveValue' => [ 'shape' => 'String', ], ], ], 'CancelledChangePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CancelledChangeProperty', ], ], 'ChangeProgressDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'Message' => [ 'shape' => 'Message', ], 'ConfigChangeStatus' => [ 'shape' => 'ConfigChangeStatus', ], 'InitiatedBy' => [ 'shape' => 'InitiatedBy', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'LastUpdatedTime' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'ChangeProgressStage' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ChangeProgressStageName', ], 'Status' => [ 'shape' => 'ChangeProgressStageStatus', ], 'Description' => [ 'shape' => 'Description', ], 'LastUpdated' => [ 'shape' => 'LastUpdated', ], ], ], 'ChangeProgressStageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChangeProgressStage', ], ], 'ChangeProgressStageName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ChangeProgressStageStatus' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ChangeProgressStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Status' => [ 'shape' => 'OverallChangeStatus', ], 'PendingProperties' => [ 'shape' => 'StringList', ], 'CompletedProperties' => [ 'shape' => 'StringList', ], 'TotalNumberOfStages' => [ 'shape' => 'TotalNumberOfStages', ], 'ChangeProgressStages' => [ 'shape' => 'ChangeProgressStageList', ], 'LastUpdatedTime' => [ 'shape' => 'UpdateTimestamp', ], 'ConfigChangeStatus' => [ 'shape' => 'ConfigChangeStatus', ], 'InitiatedBy' => [ 'shape' => 'InitiatedBy', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CloudWatchLogsLogGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*', ], 'ClusterConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'InstanceCount' => [ 'shape' => 'IntegerClass', ], 'DedicatedMasterEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessConfig' => [ 'shape' => 'ZoneAwarenessConfig', ], 'DedicatedMasterType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'DedicatedMasterCount' => [ 'shape' => 'IntegerClass', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'WarmType' => [ 'shape' => 'OpenSearchWarmPartitionInstanceType', ], 'WarmCount' => [ 'shape' => 'IntegerClass', ], 'ColdStorageOptions' => [ 'shape' => 'ColdStorageOptions', ], 'MultiAZWithStandbyEnabled' => [ 'shape' => 'Boolean', ], ], ], 'ClusterConfigStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'ClusterConfig', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'CognitoOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'UserPoolId' => [ 'shape' => 'UserPoolId', ], 'IdentityPoolId' => [ 'shape' => 'IdentityPoolId', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'CognitoOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'CognitoOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ColdStorageOptions' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'CommitMessage' => [ 'type' => 'string', 'max' => 160, ], 'CompatibleVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompatibleVersionsMap', ], ], 'CompatibleVersionsMap' => [ 'type' => 'structure', 'members' => [ 'SourceVersion' => [ 'shape' => 'VersionString', ], 'TargetVersions' => [ 'shape' => 'VersionList', ], ], ], 'ConfigChangeStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Initializing', 'Validating', 'ValidationFailed', 'ApplyingChanges', 'Completed', 'PendingUserInput', 'Cancelled', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionAlias' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-\\_]+', ], 'ConnectionId' => [ 'type' => 'string', 'max' => 256, 'min' => 10, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'ConnectionMode' => [ 'type' => 'string', 'enum' => [ 'DIRECT', 'VPC_ENDPOINT', ], ], 'ConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'Endpoint' => [ 'shape' => 'Endpoint', ], 'CrossClusterSearch' => [ 'shape' => 'CrossClusterSearchConnectionProperties', ], ], ], 'ConnectionStatusMessage' => [ 'type' => 'string', ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'TagList' => [ 'shape' => 'TagList', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsInput', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'CreateOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'LocalDomainInfo', 'RemoteDomainInfo', 'ConnectionAlias', ], 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreateOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundConnectionStatus', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageName', 'PackageType', 'PackageSource', ], 'members' => [ 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], ], ], 'CreatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'CreateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DomainArn', 'VpcOptions', ], 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'CreatedAt' => [ 'type' => 'timestamp', ], 'CrossClusterSearchConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'SkipUnavailable' => [ 'shape' => 'SkipUnavailableStatus', ], ], ], 'DataSourceDescription' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$', ], 'DataSourceDetails' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceDetails', ], ], 'DataSourceName' => [ 'type' => 'string', 'max' => 80, 'min' => 3, 'pattern' => '[a-z][a-z0-9_]+', ], 'DataSourceType' => [ 'type' => 'structure', 'members' => [ 'S3GlueDataCatalog' => [ 'shape' => 'S3GlueDataCatalog', ], ], 'union' => true, ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DeleteDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DeleteInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'DeleteOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'OutboundConnection', ], ], ], 'DeletePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], ], ], 'DeletePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'DeleteVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', 'location' => 'uri', 'locationName' => 'VpcEndpointId', ], ], ], 'DeleteVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummary', ], 'members' => [ 'VpcEndpointSummary' => [ 'shape' => 'VpcEndpointSummary', ], ], ], 'DependencyFailureException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 424, ], 'exception' => true, ], 'DeploymentCloseDateTimeStamp' => [ 'type' => 'timestamp', ], 'DeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'DeploymentType' => [ 'type' => 'string', 'max' => 128, 'min' => 2, ], 'DescribeDomainAutoTunesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainAutoTunesResponse' => [ 'type' => 'structure', 'members' => [ 'AutoTunes' => [ 'shape' => 'AutoTuneList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainChangeProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ChangeId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'changeid', ], ], ], 'DescribeDomainChangeProgressResponse' => [ 'type' => 'structure', 'members' => [ 'ChangeProgressStatus' => [ 'shape' => 'ChangeProgressStatusDetails', ], ], ], 'DescribeDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], ], ], 'DescribeDomainHealthRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainHealthResponse' => [ 'type' => 'structure', 'members' => [ 'DomainState' => [ 'shape' => 'DomainState', ], 'AvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'ActiveAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'StandByAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'DataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'DedicatedMaster' => [ 'shape' => 'Boolean', ], 'MasterEligibleNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'WarmNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'MasterNode' => [ 'shape' => 'MasterNodeStatus', ], 'ClusterHealth' => [ 'shape' => 'DomainHealth', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], 'EnvironmentInformation' => [ 'shape' => 'EnvironmentInfoList', ], ], ], 'DescribeDomainNodesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainNodesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNodesStatusList' => [ 'shape' => 'DomainNodesStatusList', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatus', ], 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DescribeDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainNames', ], 'members' => [ 'DomainNames' => [ 'shape' => 'DomainNameList', ], ], ], 'DescribeDomainsResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatusList', ], 'members' => [ 'DomainStatusList' => [ 'shape' => 'DomainStatusList', ], ], ], 'DescribeDryRunProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'DryRunId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'dryRunId', ], 'LoadDryRunConfig' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'loadDryRunConfig', ], ], ], 'DescribeDryRunProgressResponse' => [ 'type' => 'structure', 'members' => [ 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], 'DryRunConfig' => [ 'shape' => 'DomainStatus', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], ], ], 'DescribeInboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'InboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInstanceTypeLimitsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'EngineVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', 'location' => 'uri', 'locationName' => 'InstanceType', ], 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], ], ], 'DescribeInstanceTypeLimitsResponse' => [ 'type' => 'structure', 'members' => [ 'LimitsByRole' => [ 'shape' => 'LimitsByRole', ], ], ], 'DescribeOutboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'OutboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesFilter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'DescribePackagesFilterName', ], 'Value' => [ 'shape' => 'DescribePackagesFilterValues', ], ], ], 'DescribePackagesFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilter', ], ], 'DescribePackagesFilterName' => [ 'type' => 'string', 'enum' => [ 'PackageID', 'PackageName', 'PackageStatus', 'PackageType', 'EngineVersion', ], ], 'DescribePackagesFilterValue' => [ 'type' => 'string', 'pattern' => '^[0-9a-zA-Z\\*\\.\\_\\\\\\/\\?-]+$', ], 'DescribePackagesFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilterValue', ], 'min' => 1, ], 'DescribePackagesRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'DescribePackagesFilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetailsList' => [ 'shape' => 'PackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeReservedInstanceOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'offeringId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstanceOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ReservedInstanceOfferings' => [ 'shape' => 'ReservedInstanceOfferingList', ], ], ], 'DescribeReservedInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'reservationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ReservedInstances' => [ 'shape' => 'ReservedInstanceList', ], ], ], 'DescribeVpcEndpointsRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointIds', ], 'members' => [ 'VpcEndpointIds' => [ 'shape' => 'VpcEndpointIdList', ], ], ], 'DescribeVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoints', 'VpcEndpointErrors', ], 'members' => [ 'VpcEndpoints' => [ 'shape' => 'VpcEndpoints', ], 'VpcEndpointErrors' => [ 'shape' => 'VpcEndpointErrorList', ], ], ], 'Description' => [ 'type' => 'string', ], 'DisableTimestamp' => [ 'type' => 'timestamp', ], 'DisabledOperationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DissociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DissociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'DomainArn' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]+:[0-9]+:domain\\/[a-z0-9\\-]+', ], 'DomainConfig' => [ 'type' => 'structure', 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionStatus', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfigStatus', ], 'EBSOptions' => [ 'shape' => 'EBSOptionsStatus', ], 'AccessPolicies' => [ 'shape' => 'AccessPoliciesStatus', ], 'IPAddressType' => [ 'shape' => 'IPAddressTypeStatus', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptionsStatus', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfoStatus', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptionsStatus', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptionsStatus', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptionsStatus', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptionsStatus', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptionsStatus', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptionsStatus', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsStatus', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsStatus', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptionsStatus', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptionsStatus', ], 'ModifyingProperties' => [ 'shape' => 'ModifyingPropertiesList', ], ], ], 'DomainEndpointOptions' => [ 'type' => 'structure', 'members' => [ 'EnforceHTTPS' => [ 'shape' => 'Boolean', ], 'TLSSecurityPolicy' => [ 'shape' => 'TLSSecurityPolicy', ], 'CustomEndpointEnabled' => [ 'shape' => 'Boolean', ], 'CustomEndpoint' => [ 'shape' => 'DomainNameFqdn', ], 'CustomEndpointCertificateArn' => [ 'shape' => 'ARN', ], ], ], 'DomainEndpointOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'DomainEndpointOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'DomainHealth' => [ 'type' => 'string', 'enum' => [ 'Red', 'Yellow', 'Green', 'NotAvailable', ], ], 'DomainId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DomainInfo' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineType' => [ 'shape' => 'EngineType', ], ], ], 'DomainInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainInfo', ], ], 'DomainInformationContainer' => [ 'type' => 'structure', 'members' => [ 'AWSDomainInformation' => [ 'shape' => 'AWSDomainInformation', ], ], ], 'DomainMaintenanceDetails' => [ 'type' => 'structure', 'members' => [ 'MaintenanceId' => [ 'shape' => 'RequestId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'NodeId' => [ 'shape' => 'NodeId', ], 'Status' => [ 'shape' => 'MaintenanceStatus', ], 'StatusMessage' => [ 'shape' => 'MaintenanceStatusMessage', ], 'CreatedAt' => [ 'shape' => 'UpdateTimestamp', ], 'UpdatedAt' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'DomainMaintenanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainMaintenanceDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 28, 'min' => 3, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'DomainNameFqdn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$', ], 'DomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'DomainNodesStatus' => [ 'type' => 'structure', 'members' => [ 'NodeId' => [ 'shape' => 'NodeId', ], 'NodeType' => [ 'shape' => 'NodeType', ], 'AvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'NodeStatus' => [ 'shape' => 'NodeStatus', ], 'StorageType' => [ 'shape' => 'StorageTypeName', ], 'StorageVolumeType' => [ 'shape' => 'VolumeType', ], 'StorageSize' => [ 'shape' => 'VolumeSize', ], ], ], 'DomainNodesStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainNodesStatus', ], ], 'DomainPackageDetails' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'LastUpdated' => [ 'shape' => 'LastUpdated', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'DomainPackageStatus' => [ 'shape' => 'DomainPackageStatus', ], 'PackageVersion' => [ 'shape' => 'PackageVersion', ], 'ReferencePath' => [ 'shape' => 'ReferencePath', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], ], ], 'DomainPackageDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainPackageDetails', ], ], 'DomainPackageStatus' => [ 'type' => 'string', 'enum' => [ 'ASSOCIATING', 'ASSOCIATION_FAILED', 'ACTIVE', 'DISSOCIATING', 'DISSOCIATION_FAILED', ], ], 'DomainProcessingStatusType' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Active', 'Modifying', 'UpgradingEngineVersion', 'UpdatingServiceSoftware', 'Isolated', 'Deleting', ], ], 'DomainState' => [ 'type' => 'string', 'enum' => [ 'Active', 'Processing', 'NotAvailable', ], ], 'DomainStatus' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'DomainName', 'ARN', 'ClusterConfig', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'ARN' => [ 'shape' => 'ARN', ], 'Created' => [ 'shape' => 'Boolean', ], 'Deleted' => [ 'shape' => 'Boolean', ], 'Endpoint' => [ 'shape' => 'ServiceUrl', ], 'EndpointV2' => [ 'shape' => 'ServiceUrl', ], 'Endpoints' => [ 'shape' => 'EndpointsMap', ], 'DomainEndpointV2HostedZoneId' => [ 'shape' => 'HostedZoneId', ], 'Processing' => [ 'shape' => 'Boolean', ], 'UpgradeProcessing' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptions', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsOutput', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], 'DomainProcessingStatus' => [ 'shape' => 'DomainProcessingStatusType', ], 'ModifyingProperties' => [ 'shape' => 'ModifyingPropertiesList', ], ], ], 'DomainStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainStatus', ], ], 'Double' => [ 'type' => 'double', ], 'DryRun' => [ 'type' => 'boolean', ], 'DryRunMode' => [ 'type' => 'string', 'enum' => [ 'Basic', 'Verbose', ], ], 'DryRunProgressStatus' => [ 'type' => 'structure', 'required' => [ 'DryRunId', 'DryRunStatus', 'CreationDate', 'UpdateDate', ], 'members' => [ 'DryRunId' => [ 'shape' => 'GUID', ], 'DryRunStatus' => [ 'shape' => 'String', ], 'CreationDate' => [ 'shape' => 'String', ], 'UpdateDate' => [ 'shape' => 'String', ], 'ValidationFailures' => [ 'shape' => 'ValidationFailures', ], ], ], 'DryRunResults' => [ 'type' => 'structure', 'members' => [ 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'Message' => [ 'shape' => 'Message', ], ], ], 'Duration' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'DurationValue', ], 'Unit' => [ 'shape' => 'TimeUnit', ], ], ], 'DurationValue' => [ 'type' => 'long', 'max' => 24, 'min' => 1, ], 'EBSOptions' => [ 'type' => 'structure', 'members' => [ 'EBSEnabled' => [ 'shape' => 'Boolean', ], 'VolumeType' => [ 'shape' => 'VolumeType', ], 'VolumeSize' => [ 'shape' => 'IntegerClass', ], 'Iops' => [ 'shape' => 'IntegerClass', ], 'Throughput' => [ 'shape' => 'IntegerClass', ], ], ], 'EBSOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'EBSOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'EncryptionAtRestOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'EncryptionAtRestOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'EncryptionAtRestOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'Endpoint' => [ 'type' => 'string', 'pattern' => '^[A-Za-z0-9\\-\\.]+$', ], 'EndpointsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'ServiceUrl', ], ], 'EngineType' => [ 'type' => 'string', 'enum' => [ 'OpenSearch', 'Elasticsearch', ], ], 'EngineVersion' => [ 'type' => 'string', 'pattern' => '^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$', ], 'EnvironmentInfo' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneInformation' => [ 'shape' => 'AvailabilityZoneInfoList', ], ], ], 'EnvironmentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentInfo', ], ], 'ErrorDetails' => [ 'type' => 'structure', 'members' => [ 'ErrorType' => [ 'shape' => 'ErrorType', ], 'ErrorMessage' => [ 'shape' => 'ErrorMessage', ], ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorType' => [ 'type' => 'string', ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'ValueStringList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'GUID' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}', ], 'GUIDList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GUID', ], ], 'GetCompatibleVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], ], ], 'GetCompatibleVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CompatibleVersions' => [ 'shape' => 'CompatibleVersionsList', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'GetDomainMaintenanceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'MaintenanceId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaintenanceId' => [ 'shape' => 'RequestId', 'location' => 'querystring', 'locationName' => 'maintenanceId', ], ], ], 'GetDomainMaintenanceStatusResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'MaintenanceStatus', ], 'StatusMessage' => [ 'shape' => 'MaintenanceStatusMessage', ], 'NodeId' => [ 'shape' => 'NodeId', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'CreatedAt' => [ 'shape' => 'UpdateTimestamp', ], 'UpdatedAt' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'GetPackageVersionHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetPackageVersionHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageVersionHistoryList' => [ 'shape' => 'PackageVersionHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetUpgradeHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeHistories' => [ 'shape' => 'UpgradeHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'GetUpgradeStatusResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'StepStatus' => [ 'shape' => 'UpgradeStatus', ], 'UpgradeName' => [ 'shape' => 'UpgradeName', ], ], ], 'HostedZoneId' => [ 'type' => 'string', ], 'IPAddressType' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'dualstack', ], ], 'IPAddressTypeStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'IPAddressType', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'IdentityPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+:[0-9a-f-]+', ], 'InboundConnection' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionStatus' => [ 'shape' => 'InboundConnectionStatus', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], ], ], 'InboundConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'InboundConnectionStatusCode', ], 'Message' => [ 'shape' => 'ConnectionStatusMessage', ], ], ], 'InboundConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'APPROVED', 'PROVISIONING', 'ACTIVE', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'InboundConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'InboundConnection', ], ], 'InitiatedBy' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SERVICE', ], ], 'InstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InstanceCountLimits' => [ 'type' => 'structure', 'members' => [ 'MinimumInstanceCount' => [ 'shape' => 'MinimumInstanceCount', ], 'MaximumInstanceCount' => [ 'shape' => 'MaximumInstanceCount', ], ], ], 'InstanceLimits' => [ 'type' => 'structure', 'members' => [ 'InstanceCountLimits' => [ 'shape' => 'InstanceCountLimits', ], ], ], 'InstanceRole' => [ 'type' => 'string', ], 'InstanceRoleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceRole', ], ], 'InstanceTypeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'EncryptionEnabled' => [ 'shape' => 'Boolean', ], 'CognitoEnabled' => [ 'shape' => 'Boolean', ], 'AppLogsEnabled' => [ 'shape' => 'Boolean', ], 'AdvancedSecurityEnabled' => [ 'shape' => 'Boolean', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleList', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'InstanceTypeDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeDetails', ], ], 'InstanceTypeString' => [ 'type' => 'string', 'max' => 40, 'min' => 10, 'pattern' => '^.*\\..*\\.search$', ], 'Integer' => [ 'type' => 'integer', ], 'IntegerClass' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Issue' => [ 'type' => 'string', ], 'Issues' => [ 'type' => 'list', 'member' => [ 'shape' => 'Issue', ], ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.*', ], 'LastUpdated' => [ 'type' => 'timestamp', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'LimitName' => [ 'type' => 'string', ], 'LimitValue' => [ 'type' => 'string', ], 'LimitValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LimitValue', ], ], 'Limits' => [ 'type' => 'structure', 'members' => [ 'StorageTypes' => [ 'shape' => 'StorageTypeList', ], 'InstanceLimits' => [ 'shape' => 'InstanceLimits', ], 'AdditionalLimits' => [ 'shape' => 'AdditionalLimitList', ], ], ], 'LimitsByRole' => [ 'type' => 'map', 'key' => [ 'shape' => 'InstanceRole', ], 'value' => [ 'shape' => 'Limits', ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'DataSourceList', ], ], ], 'ListDomainMaintenancesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', 'location' => 'querystring', 'locationName' => 'action', ], 'Status' => [ 'shape' => 'MaintenanceStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainMaintenancesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainMaintenances' => [ 'shape' => 'DomainMaintenanceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainNamesRequest' => [ 'type' => 'structure', 'members' => [ 'EngineType' => [ 'shape' => 'EngineType', 'location' => 'querystring', 'locationName' => 'engineType', ], ], ], 'ListDomainNamesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNames' => [ 'shape' => 'DomainInfoList', ], ], ], 'ListDomainsForPackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainsForPackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListInstanceTypeDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'EngineVersion', ], 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'RetrieveAZs' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'retrieveAZs', ], 'InstanceType' => [ 'shape' => 'InstanceTypeString', 'location' => 'querystring', 'locationName' => 'instanceType', ], ], ], 'ListInstanceTypeDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceTypeDetails' => [ 'shape' => 'InstanceTypeDetailsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPackagesForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPackagesForDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListScheduledActionsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListScheduledActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledActions' => [ 'shape' => 'ScheduledActionsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'ListVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'Versions' => [ 'shape' => 'VersionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipalList', 'NextToken', ], 'members' => [ 'AuthorizedPrincipalList' => [ 'shape' => 'AuthorizedPrincipalList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsForDomainResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogPublishingOption' => [ 'type' => 'structure', 'members' => [ 'CloudWatchLogsLogGroupArn' => [ 'shape' => 'CloudWatchLogsLogGroupArn', ], 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'LogPublishingOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LogType', ], 'value' => [ 'shape' => 'LogPublishingOption', ], ], 'LogPublishingOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'LogPublishingOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'INDEX_SLOW_LOGS', 'SEARCH_SLOW_LOGS', 'ES_APPLICATION_LOGS', 'AUDIT_LOGS', ], ], 'Long' => [ 'type' => 'long', ], 'MaintenanceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'TIMED_OUT', ], ], 'MaintenanceStatusMessage' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^([\\s\\S]*)$', ], 'MaintenanceType' => [ 'type' => 'string', 'enum' => [ 'REBOOT_NODE', 'RESTART_SEARCH_PROCESS', 'RESTART_DASHBOARD', ], ], 'MasterNodeStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'UnAvailable', ], ], 'MasterUserOptions' => [ 'type' => 'structure', 'members' => [ 'MasterUserARN' => [ 'shape' => 'ARN', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterUserPassword' => [ 'shape' => 'Password', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'MaximumInstanceCount' => [ 'type' => 'integer', ], 'Message' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'MinimumInstanceCount' => [ 'type' => 'integer', ], 'ModifyingProperties' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ActiveValue' => [ 'shape' => 'String', ], 'PendingValue' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'PropertyValueType', ], ], ], 'ModifyingPropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModifyingProperties', ], ], 'NextToken' => [ 'type' => 'string', ], 'NodeId' => [ 'type' => 'string', 'max' => 40, 'min' => 10, ], 'NodeStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'StandBy', 'NotAvailable', ], ], 'NodeToNodeEncryptionOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'NodeType' => [ 'type' => 'string', 'enum' => [ 'Data', 'Ultrawarm', 'Master', ], ], 'NonEmptyString' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\-\\_\\.]+', ], 'NumberOfAZs' => [ 'type' => 'string', 'pattern' => '^((\\d+)|(NotAvailable))$', ], 'NumberOfNodes' => [ 'type' => 'string', 'pattern' => '^((\\d+)|(NotAvailable))$', ], 'NumberOfShards' => [ 'type' => 'string', 'pattern' => '^((\\d+)|(NotAvailable))$', ], 'OffPeakWindow' => [ 'type' => 'structure', 'members' => [ 'WindowStartTime' => [ 'shape' => 'WindowStartTime', ], ], ], 'OffPeakWindowOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'OffPeakWindow' => [ 'shape' => 'OffPeakWindow', ], ], ], 'OffPeakWindowOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'OffPeakWindowOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'OpenSearchPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'm3.medium.search', 'm3.large.search', 'm3.xlarge.search', 'm3.2xlarge.search', 'm4.large.search', 'm4.xlarge.search', 'm4.2xlarge.search', 'm4.4xlarge.search', 'm4.10xlarge.search', 'm5.large.search', 'm5.xlarge.search', 'm5.2xlarge.search', 'm5.4xlarge.search', 'm5.12xlarge.search', 'm5.24xlarge.search', 'r5.large.search', 'r5.xlarge.search', 'r5.2xlarge.search', 'r5.4xlarge.search', 'r5.12xlarge.search', 'r5.24xlarge.search', 'c5.large.search', 'c5.xlarge.search', 'c5.2xlarge.search', 'c5.4xlarge.search', 'c5.9xlarge.search', 'c5.18xlarge.search', 't3.nano.search', 't3.micro.search', 't3.small.search', 't3.medium.search', 't3.large.search', 't3.xlarge.search', 't3.2xlarge.search', 'or1.medium.search', 'or1.large.search', 'or1.xlarge.search', 'or1.2xlarge.search', 'or1.4xlarge.search', 'or1.8xlarge.search', 'or1.12xlarge.search', 'or1.16xlarge.search', 'ultrawarm1.medium.search', 'ultrawarm1.large.search', 'ultrawarm1.xlarge.search', 't2.micro.search', 't2.small.search', 't2.medium.search', 'r3.large.search', 'r3.xlarge.search', 'r3.2xlarge.search', 'r3.4xlarge.search', 'r3.8xlarge.search', 'i2.xlarge.search', 'i2.2xlarge.search', 'd2.xlarge.search', 'd2.2xlarge.search', 'd2.4xlarge.search', 'd2.8xlarge.search', 'c4.large.search', 'c4.xlarge.search', 'c4.2xlarge.search', 'c4.4xlarge.search', 'c4.8xlarge.search', 'r4.large.search', 'r4.xlarge.search', 'r4.2xlarge.search', 'r4.4xlarge.search', 'r4.8xlarge.search', 'r4.16xlarge.search', 'i3.large.search', 'i3.xlarge.search', 'i3.2xlarge.search', 'i3.4xlarge.search', 'i3.8xlarge.search', 'i3.16xlarge.search', 'r6g.large.search', 'r6g.xlarge.search', 'r6g.2xlarge.search', 'r6g.4xlarge.search', 'r6g.8xlarge.search', 'r6g.12xlarge.search', 'm6g.large.search', 'm6g.xlarge.search', 'm6g.2xlarge.search', 'm6g.4xlarge.search', 'm6g.8xlarge.search', 'm6g.12xlarge.search', 'c6g.large.search', 'c6g.xlarge.search', 'c6g.2xlarge.search', 'c6g.4xlarge.search', 'c6g.8xlarge.search', 'c6g.12xlarge.search', 'r6gd.large.search', 'r6gd.xlarge.search', 'r6gd.2xlarge.search', 'r6gd.4xlarge.search', 'r6gd.8xlarge.search', 'r6gd.12xlarge.search', 'r6gd.16xlarge.search', 't4g.small.search', 't4g.medium.search', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'ultrawarm1.medium.search', 'ultrawarm1.large.search', 'ultrawarm1.xlarge.search', ], ], 'OptionState' => [ 'type' => 'string', 'enum' => [ 'RequiresIndexDocuments', 'Processing', 'Active', ], ], 'OptionStatus' => [ 'type' => 'structure', 'required' => [ 'CreationDate', 'UpdateDate', 'State', ], 'members' => [ 'CreationDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateVersion' => [ 'shape' => 'UIntValue', ], 'State' => [ 'shape' => 'OptionState', ], 'PendingDeletion' => [ 'shape' => 'Boolean', ], ], ], 'OutboundConnection' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundConnectionStatus', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'OutboundConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'OutboundConnectionStatusCode', ], 'Message' => [ 'shape' => 'ConnectionStatusMessage', ], ], ], 'OutboundConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'VALIDATING', 'VALIDATION_FAILED', 'PENDING_ACCEPTANCE', 'APPROVED', 'PROVISIONING', 'ACTIVE', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'OutboundConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutboundConnection', ], ], 'OverallChangeStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PROCESSING', 'COMPLETED', 'FAILED', ], ], 'OwnerId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[0-9]+', ], 'PackageDescription' => [ 'type' => 'string', 'max' => 1024, ], 'PackageDetails' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'PackageStatus' => [ 'shape' => 'PackageStatus', ], 'CreatedAt' => [ 'shape' => 'CreatedAt', ], 'LastUpdatedAt' => [ 'shape' => 'LastUpdated', ], 'AvailablePackageVersion' => [ 'shape' => 'PackageVersion', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'EngineVersion' => [ 'shape' => 'EngineVersion', ], 'AvailablePluginProperties' => [ 'shape' => 'PluginProperties', ], ], ], 'PackageDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageDetails', ], ], 'PackageID' => [ 'type' => 'string', 'pattern' => '^([FG][0-9]+)$', ], 'PackageName' => [ 'type' => 'string', 'max' => 256, 'min' => 3, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'PackageSource' => [ 'type' => 'structure', 'members' => [ 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Key' => [ 'shape' => 'S3Key', ], ], ], 'PackageStatus' => [ 'type' => 'string', 'enum' => [ 'COPYING', 'COPY_FAILED', 'VALIDATING', 'VALIDATION_FAILED', 'AVAILABLE', 'DELETING', 'DELETED', 'DELETE_FAILED', ], ], 'PackageType' => [ 'type' => 'string', 'enum' => [ 'TXT-DICTIONARY', 'ZIP-PLUGIN', ], ], 'PackageVersion' => [ 'type' => 'string', ], 'PackageVersionHistory' => [ 'type' => 'structure', 'members' => [ 'PackageVersion' => [ 'shape' => 'PackageVersion', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], 'CreatedAt' => [ 'shape' => 'CreatedAt', ], 'PluginProperties' => [ 'shape' => 'PluginProperties', ], ], ], 'PackageVersionHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersionHistory', ], ], 'Password' => [ 'type' => 'string', 'max' => 128, 'min' => 8, 'pattern' => '.*', 'sensitive' => true, ], 'PluginClassName' => [ 'type' => 'string', 'max' => 1024, ], 'PluginDescription' => [ 'type' => 'string', 'max' => 1024, ], 'PluginName' => [ 'type' => 'string', 'max' => 1024, ], 'PluginProperties' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PluginName', ], 'Description' => [ 'shape' => 'PluginDescription', ], 'Version' => [ 'shape' => 'PluginVersion', ], 'ClassName' => [ 'shape' => 'PluginClassName', ], 'UncompressedSizeInBytes' => [ 'shape' => 'UncompressedPluginSizeInBytes', ], ], ], 'PluginVersion' => [ 'type' => 'string', 'max' => 1024, ], 'PolicyDocument' => [ 'type' => 'string', 'max' => 102400, 'min' => 0, 'pattern' => '.*', ], 'PrincipalType' => [ 'type' => 'string', 'enum' => [ 'AWS_ACCOUNT', 'AWS_SERVICE', ], ], 'PropertyValueType' => [ 'type' => 'string', 'enum' => [ 'PLAIN_TEXT', 'STRINGIFIED_JSON', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'type' => 'structure', 'required' => [ 'ReservedInstanceOfferingId', 'ReservationName', ], 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], ], ], 'PurchaseReservedInstanceOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', ], ], 'ReferencePath' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', 'max' => 30, 'min' => 5, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'RejectInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'RejectInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'RemoveTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagKeys', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'RequestId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^([\\s\\S]*)$', ], 'ReservationToken' => [ 'type' => 'string', 'max' => 64, 'min' => 5, 'pattern' => '.*', ], 'ReservedInstance' => [ 'type' => 'structure', 'members' => [ 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'BillingSubscriptionId' => [ 'shape' => 'Long', ], 'ReservedInstanceOfferingId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstance', ], ], 'ReservedInstanceOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstanceOffering', ], ], 'ReservedInstancePaymentOption' => [ 'type' => 'string', 'enum' => [ 'ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT', ], ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'RevokeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'RevokeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'members' => [], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*', ], 'RollbackOnDisable' => [ 'type' => 'string', 'enum' => [ 'NO_ROLLBACK', 'DEFAULT_ROLLBACK', ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3GlueDataCatalog' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SAMLEntityId' => [ 'type' => 'string', 'max' => 512, 'min' => 8, ], 'SAMLIdp' => [ 'type' => 'structure', 'required' => [ 'MetadataContent', 'EntityId', ], 'members' => [ 'MetadataContent' => [ 'shape' => 'SAMLMetadata', ], 'EntityId' => [ 'shape' => 'SAMLEntityId', ], ], ], 'SAMLMetadata' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, ], 'SAMLOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterBackendRole' => [ 'shape' => 'BackendRole', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'SAMLOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'ScheduleAt' => [ 'type' => 'string', 'enum' => [ 'NOW', 'TIMESTAMP', 'OFF_PEAK_WINDOW', ], ], 'ScheduledAction' => [ 'type' => 'structure', 'required' => [ 'Id', 'Type', 'Severity', 'ScheduledTime', ], 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'ActionType', ], 'Severity' => [ 'shape' => 'ActionSeverity', ], 'ScheduledTime' => [ 'shape' => 'Long', ], 'Description' => [ 'shape' => 'String', ], 'ScheduledBy' => [ 'shape' => 'ScheduledBy', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Mandatory' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], ], ], 'ScheduledActionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScheduledAction', ], ], 'ScheduledAutoTuneActionType' => [ 'type' => 'string', 'enum' => [ 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'ScheduledAutoTuneDescription' => [ 'type' => 'string', ], 'ScheduledAutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'AutoTuneDate', ], 'ActionType' => [ 'shape' => 'ScheduledAutoTuneActionType', ], 'Action' => [ 'shape' => 'ScheduledAutoTuneDescription', ], 'Severity' => [ 'shape' => 'ScheduledAutoTuneSeverityType', ], ], ], 'ScheduledAutoTuneSeverityType' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', ], ], 'ScheduledBy' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SYSTEM', ], ], 'ServiceSoftwareOptions' => [ 'type' => 'structure', 'members' => [ 'CurrentVersion' => [ 'shape' => 'String', ], 'NewVersion' => [ 'shape' => 'String', ], 'UpdateAvailable' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], 'UpdateStatus' => [ 'shape' => 'DeploymentStatus', ], 'Description' => [ 'shape' => 'String', ], 'AutomatedUpdateDate' => [ 'shape' => 'DeploymentCloseDateTimeStamp', ], 'OptionalDeployment' => [ 'shape' => 'Boolean', ], ], ], 'ServiceUrl' => [ 'type' => 'string', ], 'SkipUnavailableStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SlotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Long', ], ], 'SlotNotAvailableException' => [ 'type' => 'structure', 'members' => [ 'SlotSuggestions' => [ 'shape' => 'SlotList', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'SnapshotOptions' => [ 'type' => 'structure', 'members' => [ 'AutomatedSnapshotStartHour' => [ 'shape' => 'IntegerClass', ], ], ], 'SnapshotOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'SnapshotOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'SoftwareUpdateOptions' => [ 'type' => 'structure', 'members' => [ 'AutoSoftwareUpdateEnabled' => [ 'shape' => 'Boolean', ], ], ], 'SoftwareUpdateOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'SoftwareUpdateOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'StartAt' => [ 'type' => 'timestamp', ], 'StartDomainMaintenanceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Action', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'NodeId' => [ 'shape' => 'NodeId', ], ], ], 'StartDomainMaintenanceResponse' => [ 'type' => 'structure', 'members' => [ 'MaintenanceId' => [ 'shape' => 'RequestId', ], ], ], 'StartServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'StartServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'StartTimeHours' => [ 'type' => 'long', 'max' => 23, 'min' => 0, ], 'StartTimeMinutes' => [ 'type' => 'long', 'max' => 59, 'min' => 0, ], 'StartTimestamp' => [ 'type' => 'timestamp', ], 'StorageSubTypeName' => [ 'type' => 'string', ], 'StorageType' => [ 'type' => 'structure', 'members' => [ 'StorageTypeName' => [ 'shape' => 'StorageTypeName', ], 'StorageSubTypeName' => [ 'shape' => 'StorageSubTypeName', ], 'StorageTypeLimits' => [ 'shape' => 'StorageTypeLimitList', ], ], ], 'StorageTypeLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'StorageTypeLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageTypeLimit', ], ], 'StorageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageType', ], ], 'StorageTypeName' => [ 'type' => 'string', ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'TLSSecurityPolicy' => [ 'type' => 'string', 'enum' => [ 'Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07', 'Policy-Min-TLS-1-2-PFS-2023-10', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'TimeUnit' => [ 'type' => 'string', 'enum' => [ 'HOURS', ], ], 'TotalNumberOfStages' => [ 'type' => 'integer', ], 'UIntValue' => [ 'type' => 'integer', 'min' => 0, ], 'UncompressedPluginSizeInBytes' => [ 'type' => 'long', ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'UpdateDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptions', ], 'DryRun' => [ 'shape' => 'DryRun', ], 'DryRunMode' => [ 'shape' => 'DryRunMode', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'UpdateDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], ], ], 'UpdatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'PackageSource', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], ], ], 'UpdatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'UpdateScheduledActionRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'ActionID', 'ActionType', 'ScheduleAt', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ActionID' => [ 'shape' => 'String', ], 'ActionType' => [ 'shape' => 'ActionType', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'UpdateScheduledActionResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledAction' => [ 'shape' => 'ScheduledAction', ], ], ], 'UpdateTimestamp' => [ 'type' => 'timestamp', ], 'UpdateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', 'VpcOptions', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], ], ], 'UpdateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'UpgradeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'TargetVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], ], ], 'UpgradeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeId' => [ 'shape' => 'String', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], ], ], 'UpgradeHistory' => [ 'type' => 'structure', 'members' => [ 'UpgradeName' => [ 'shape' => 'UpgradeName', ], 'StartTimestamp' => [ 'shape' => 'StartTimestamp', ], 'UpgradeStatus' => [ 'shape' => 'UpgradeStatus', ], 'StepsList' => [ 'shape' => 'UpgradeStepsList', ], ], ], 'UpgradeHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeHistory', ], ], 'UpgradeName' => [ 'type' => 'string', ], 'UpgradeStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'SUCCEEDED', 'SUCCEEDED_WITH_ISSUES', 'FAILED', ], ], 'UpgradeStep' => [ 'type' => 'string', 'enum' => [ 'PRE_UPGRADE_CHECK', 'SNAPSHOT', 'UPGRADE', ], ], 'UpgradeStepItem' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'UpgradeStepStatus' => [ 'shape' => 'UpgradeStatus', ], 'Issues' => [ 'shape' => 'Issues', ], 'ProgressPercent' => [ 'shape' => 'Double', ], ], ], 'UpgradeStepsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeStepItem', ], ], 'UserPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'Username' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', 'sensitive' => true, ], 'VPCDerivedInfo' => [ 'type' => 'structure', 'members' => [ 'VPCId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'StringList', ], 'AvailabilityZones' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'VPCDerivedInfoStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VPCOptions' => [ 'type' => 'structure', 'members' => [ 'SubnetIds' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationFailure' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationFailures' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationFailure', ], ], 'ValueStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'min' => 1, ], 'VersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionString', ], ], 'VersionStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VersionString', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VersionString' => [ 'type' => 'string', 'max' => 18, 'min' => 14, 'pattern' => '^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$', ], 'VolumeSize' => [ 'type' => 'string', ], 'VolumeType' => [ 'type' => 'string', 'enum' => [ 'standard', 'gp2', 'io1', 'gp3', ], ], 'VpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'AWSAccount', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], ], ], 'VpcEndpointError' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'ErrorCode' => [ 'shape' => 'VpcEndpointErrorCode', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'VpcEndpointErrorCode' => [ 'type' => 'string', 'enum' => [ 'ENDPOINT_NOT_FOUND', 'SERVER_ERROR', ], ], 'VpcEndpointErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointError', ], ], 'VpcEndpointId' => [ 'type' => 'string', 'max' => 256, 'min' => 5, 'pattern' => '^aos-[a-zA-Z0-9]*$', ], 'VpcEndpointIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointId', ], ], 'VpcEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATE_FAILED', 'ACTIVE', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'VpcEndpointSummary' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'String', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], ], ], 'VpcEndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointSummary', ], ], 'VpcEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpoint', ], ], 'WindowStartTime' => [ 'type' => 'structure', 'required' => [ 'Hours', 'Minutes', ], 'members' => [ 'Hours' => [ 'shape' => 'StartTimeHours', ], 'Minutes' => [ 'shape' => 'StartTimeMinutes', ], ], ], 'ZoneAwarenessConfig' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneCount' => [ 'shape' => 'IntegerClass', ], ], ], 'ZoneStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'StandBy', 'NotAvailable', ], ], ],]; diff --git a/src/data/opensearch/2021-01-01/docs-2.json b/src/data/opensearch/2021-01-01/docs-2.json index 652b89685f..f29c6c5974 100644 --- a/src/data/opensearch/2021-01-01/docs-2.json +++ b/src/data/opensearch/2021-01-01/docs-2.json @@ -4,7 +4,7 @@ "operations": { "AcceptInboundConnection": "

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

", "AddDataSource": "

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

", - "AddTags": "

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

", + "AddTags": "

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

", "AssociatePackage": "

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

", "AuthorizeVpcEndpointAccess": "

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

", "CancelDomainConfigChange": "

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

", @@ -1273,7 +1273,7 @@ "EndpointsMap": { "base": null, "refs": { - "DomainStatus$Endpoints": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" + "DomainStatus$Endpoints": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

" } }, "EngineType": { @@ -1417,6 +1417,12 @@ "refs": { } }, + "HostedZoneId": { + "base": null, + "refs": { + "DomainStatus$DomainEndpointV2HostedZoneId": "

The DualStack Hosted Zone Id for the domain.

" + } + }, "IPAddressType": { "base": null, "refs": { diff --git a/src/data/opensearch/2021-01-01/docs-2.json.php b/src/data/opensearch/2021-01-01/docs-2.json.php index 0239ed6e7d..0a0d2dc5fe 100644 --- a/src/data/opensearch/2021-01-01/docs-2.json.php +++ b/src/data/opensearch/2021-01-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

', 'operations' => [ 'AcceptInboundConnection' => '

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'AddDataSource' => '

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

', 'AddTags' => '

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

', 'AssociatePackage' => '

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'AuthorizeVpcEndpointAccess' => '

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'CancelDomainConfigChange' => '

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

', 'CancelServiceSoftwareUpdate' => '

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain\'s UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

', 'CreateDomain' => '

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'CreateOutboundConnection' => '

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'CreatePackage' => '

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteDataSource' => '

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

', 'DeleteDomain' => '

Deletes an Amazon OpenSearch Service domain and all of its data. You can\'t recover a domain after you delete it.

', 'DeleteInboundConnection' => '

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeleteOutboundConnection' => '

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeletePackage' => '

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomain' => '

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

', 'DescribeDomainAutoTunes' => '

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

', 'DescribeDomainConfig' => '

Returns the configuration of an Amazon OpenSearch Service domain.

', 'DescribeDomainHealth' => '

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

', 'DescribeDomainNodes' => '

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

', 'DescribeDomains' => '

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

', 'DescribeDryRunProgress' => '

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

', 'DescribeInboundConnections' => '

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribeInstanceTypeLimits' => '

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

', 'DescribeOutboundConnections' => '

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribePackages' => '

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DescribeReservedInstanceOfferings' => '

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeReservedInstances' => '

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Removes a package from the specified Amazon OpenSearch Service domain. The package can\'t be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetCompatibleVersions' => '

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'GetDataSource' => '

Retrieves information about a direct query data source.

', 'GetDomainMaintenanceStatus' => '

The status of the maintenance action.

', 'GetPackageVersionHistory' => '

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

', 'GetUpgradeStatus' => '

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

', 'ListDataSources' => '

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

', 'ListDomainMaintenances' => '

A list of maintenance actions for the domain.

', 'ListDomainNames' => '

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

', 'ListDomainsForPackage' => '

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListInstanceTypeDetails' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'ListPackagesForDomain' => '

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListScheduledActions' => '

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

', 'ListTags' => '

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'ListVersions' => '

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', 'ListVpcEndpointAccess' => '

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'ListVpcEndpoints' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedInstanceOffering' => '

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

', 'RejectInboundConnection' => '

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

', 'RemoveTags' => '

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'RevokeVpcEndpointAccess' => '

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

', 'StartDomainMaintenance' => '

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

', 'StartServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'UpdateDataSource' => '

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

', 'UpdateDomainConfig' => '

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

', 'UpdatePackage' => '

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'UpdateScheduledAction' => '

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeDomain' => '

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

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

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

', 'refs' => [ 'AddTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

', 'DomainStatus$ARN' => '

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

', 'ListTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the domain to view tags for.

', 'MasterUserOptions$MasterUserARN' => '

Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

', 'RemoveTagsRequest$ARN' => '

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The Amazon Web Services account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AWSDomainInformation' => [ 'base' => '

Information about an Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainInformationContainer$AWSDomainInformation' => '

Information about an Amazon OpenSearch Service domain.

', ], ], 'AcceptInboundConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundConnection operation.

', 'refs' => [], ], 'AcceptInboundConnectionResponse' => [ 'base' => '

Contains details about the accepted inbound connection.

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

An error occurred because you don\'t have permissions to access the resource.

', 'refs' => [], ], 'AccessPoliciesStatus' => [ 'base' => '

The configured access rules for the domain\'s search endpoint, and the current status of those rules.

', 'refs' => [ 'DomainConfig$AccessPolicies' => '

Specifies the access policies for the domain.

', ], ], 'ActionSeverity' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Severity' => '

The severity of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Status' => '

The current status of the scheduled action.

', ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Type' => '

The type of action that will be taken on the domain.

', 'UpdateScheduledActionRequest$ActionType' => '

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

', ], ], 'AddDataSourceRequest' => [ 'base' => '

Container for the parameters to the AddDataSource operation.

', 'refs' => [], ], 'AddDataSourceResponse' => [ 'base' => '

The result of an AddDataSource operation.

', 'refs' => [], ], 'AddTagsRequest' => [ 'base' => '

Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

', 'refs' => [], ], 'AdditionalLimit' => [ 'base' => '

List of limits that are specific to a given instance type.

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

List of additional limits that are specific to a given instance type for each of its instance roles.

', ], ], 'AdvancedOptions' => [ 'base' => '

Exposes native OpenSearch configuration values from opensearch.yml. The following advanced options are available:

For more information, see Advanced cluster parameters.

', 'refs' => [ 'AdvancedOptionsStatus$Options' => '

The status of advanced options for the specified domain.

', 'CreateDomainRequest$AdvancedOptions' => '

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

For more information, see Advanced cluster parameters.

', 'DomainStatus$AdvancedOptions' => '

Key-value pairs that specify advanced configuration options.

', 'UpdateDomainConfigRequest$AdvancedOptions' => '

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

For more information, see Advanced cluster parameters.

', 'UpgradeDomainRequest$AdvancedOptions' => '

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

', 'UpgradeDomainResponse$AdvancedOptions' => '

The advanced options configuration for the domain.

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

Status of the advanced options for the specified domain. The following options are available:

For more information, see Advanced cluster parameters.

', 'refs' => [ 'DomainConfig$AdvancedOptions' => '

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

', ], ], 'AdvancedSecurityOptions' => [ 'base' => '

Container for fine-grained access control settings.

', 'refs' => [ 'AdvancedSecurityOptionsStatus$Options' => '

Container for fine-grained access control settings.

', 'DomainStatus$AdvancedSecurityOptions' => '

Settings for fine-grained access control.

', ], ], 'AdvancedSecurityOptionsInput' => [ 'base' => '

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.

', 'refs' => [ 'CreateDomainRequest$AdvancedSecurityOptions' => '

Options for fine-grained access control.

', 'UpdateDomainConfigRequest$AdvancedSecurityOptions' => '

Options for fine-grained access control.

', ], ], 'AdvancedSecurityOptionsStatus' => [ 'base' => '

The status of fine-grained access control settings for a domain.

', 'refs' => [ 'DomainConfig$AdvancedSecurityOptions' => '

Container for fine-grained access control settings for the domain.

', ], ], 'AssociatePackageRequest' => [ 'base' => '

Container for the request parameters to the AssociatePackage operation.

', 'refs' => [], ], 'AssociatePackageResponse' => [ 'base' => '

Container for the response returned by the AssociatePackage operation.

', 'refs' => [], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizedPrincipal' => [ 'base' => '

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'refs' => [ 'AuthorizeVpcEndpointAccessResponse$AuthorizedPrincipal' => '

Information about the Amazon Web Services account or service that was provided access to the domain.

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

A list of IAM principals that can currently access the domain.

', ], ], 'AutoTune' => [ 'base' => '

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

The timestamp of the Auto-Tune action scheduled for the domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

The date and time when the Auto-Tune action is scheduled for the domain.

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', 'AutoTuneOptionsInput$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', ], ], 'AutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

Details about an Auto-Tune action.

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

The list of setting adjustments that Auto-Tune has made to the domain.

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

This object is deprecated. Use the domain\'s off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

', ], ], 'AutoTuneOptions' => [ 'base' => '

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Auto-Tune settings for updating a domain.

', 'UpdateDomainConfigRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

', 'refs' => [ 'CreateDomainRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

', 'refs' => [ 'DomainStatus$AutoTuneOptions' => '

Auto-Tune settings for the domain.

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

The Auto-Tune status for the domain.

', 'refs' => [ 'DomainConfig$AutoTuneOptions' => '

Container for Auto-Tune settings for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

The current state of Auto-Tune on the domain.

', 'AutoTuneStatus$State' => '

The current state of Auto-Tune on the domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

The current status of Auto-Tune for a domain.

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

The type of Auto-Tune action.

', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$AvailabilityZoneName' => '

The name of the Availability Zone.

', 'AvailabilityZoneList$member' => NULL, 'DomainNodesStatus$AvailabilityZone' => '

The Availability Zone of the node.

', ], ], 'AvailabilityZoneInfo' => [ 'base' => '

Information about an Availability Zone on a domain.

', 'refs' => [ 'AvailabilityZoneInfoList$member' => NULL, ], ], 'AvailabilityZoneInfoList' => [ 'base' => NULL, 'refs' => [ 'EnvironmentInfo$AvailabilityZoneInformation' => '

A list of AvailabilityZoneInfo for the domain.

', ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$AvailabilityZones' => '

The supported Availability Zones for the instance type.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

The backend role that the SAML master user is mapped to.

', ], ], 'BaseException' => [ 'base' => '

An error occurred while processing the request.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$Enabled' => '

True if fine-grained access control is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AdvancedSecurityOptionsInput$Enabled' => '

True to enable fine-grained access control.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True to enable the internal user database.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AutoTuneOptions$UseOffPeakWindow' => '

Whether to use the domain\'s off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

', 'AutoTuneOptionsInput$UseOffPeakWindow' => '

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain\'s configured daily off-peak window.

', 'AutoTuneOptionsOutput$UseOffPeakWindow' => '

Whether the domain\'s off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the domain is being deleted.

', 'ClusterConfig$DedicatedMasterEnabled' => '

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

', 'ClusterConfig$ZoneAwarenessEnabled' => '

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'ClusterConfig$WarmEnabled' => '

Whether to enable warm storage for the cluster.

', 'ClusterConfig$MultiAZWithStandbyEnabled' => '

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'CognitoOptions$Enabled' => '

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

', 'ColdStorageOptions$Enabled' => '

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.

', 'DescribeDomainHealthResponse$DedicatedMaster' => '

A boolean that indicates if dedicated master nodes are activated for the domain.

', 'DescribeDryRunProgressRequest$LoadDryRunConfig' => '

Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you\'re planning to make on the domain.

', 'DomainEndpointOptions$EnforceHTTPS' => '

True to require that all traffic to the domain arrive over HTTPS.

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

Whether to enable a custom endpoint for the domain.

', 'DomainStatus$Created' => '

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

', 'DomainStatus$Deleted' => '

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

', 'DomainStatus$Processing' => '

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

', 'DomainStatus$UpgradeProcessing' => '

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

', 'EBSOptions$EBSEnabled' => '

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

', 'EncryptionAtRestOptions$Enabled' => '

True to enable encryption at rest.

', 'InstanceTypeDetails$EncryptionEnabled' => '

Whether encryption at rest and node-to-node encryption are supported for the instance type.

', 'InstanceTypeDetails$CognitoEnabled' => '

Whether Amazon Cognito access is supported for the instance type.

', 'InstanceTypeDetails$AppLogsEnabled' => '

Whether logging is supported for the instance type.

', 'InstanceTypeDetails$AdvancedSecurityEnabled' => '

Whether fine-grained access control is supported for the instance type.

', 'InstanceTypeDetails$WarmEnabled' => '

Whether UltraWarm is supported for the instance type.

', 'ListInstanceTypeDetailsRequest$RetrieveAZs' => '

An optional parameter that specifies the Availability Zones for the domain.

', 'LogPublishingOption$Enabled' => '

Whether the log should be published.

', 'NodeToNodeEncryptionOptions$Enabled' => '

True to enable node-to-node encryption.

', 'OffPeakWindowOptions$Enabled' => '

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can\'t disable the off-peak window after it\'s enabled for a domain.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the entity is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True to enable SAML authentication for a domain.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ScheduledAction$Mandatory' => '

Whether the action is required or optional.

', 'ScheduledAction$Cancellable' => '

Whether or not the scheduled action is cancellable.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you\'re able to update your service software version. False if you can\'t update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you\'re able to cancel your service software version update. False if you can\'t cancel your service software update.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

', 'SoftwareUpdateOptions$AutoSoftwareUpdateEnabled' => '

Whether automatic service software updates are enabled for the domain.

', 'UpgradeDomainRequest$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

', 'UpgradeDomainResponse$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check was performed.

', ], ], 'CancelDomainConfigChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDomainConfigChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the request parameters to cancel a service software update.

', 'refs' => [], ], 'CancelServiceSoftwareUpdateResponse' => [ 'base' => '

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'CancelledChangeProperty' => [ 'base' => '

A property change that was cancelled for an Amazon OpenSearch Service domain.

', 'refs' => [ 'CancelledChangePropertyList$member' => NULL, ], ], 'CancelledChangePropertyList' => [ 'base' => NULL, 'refs' => [ 'CancelDomainConfigChangeResponse$CancelledChangeProperties' => '

The domain change properties that were cancelled.

', ], ], 'ChangeProgressDetails' => [ 'base' => '

Container for information about a configuration change happening on a domain.

', 'refs' => [ 'DomainConfig$ChangeProgressDetails' => '

Container for information about the progress of an existing configuration change.

', 'DomainStatus$ChangeProgressDetails' => '

Information about a configuration change happening on the domain.

', 'UpgradeDomainResponse$ChangeProgressDetails' => '

Container for information about a configuration change happening on a domain.

', ], ], 'ChangeProgressStage' => [ 'base' => '

Progress details for each stage of a domain update.

', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => '

The list of progress stages of a specific domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$ChangeProgressStages' => '

The specific stages that the domain is going through to perform the configuration change.

', ], ], 'ChangeProgressStageName' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => '

The name of the stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The status of the stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

Container for information about the stages of a configuration change happening on a domain.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$ClientToken' => '

Unique, case-sensitive identifier to ensure idempotency of the request.

', ], ], 'CloudWatchLogsLogGroupArn' => [ 'base' => '

ARN of the Cloudwatch log group to publish logs to.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => '

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

', ], ], 'ClusterConfig' => [ 'base' => '

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'refs' => [ 'ClusterConfigStatus$Options' => '

Cluster configuration options for the specified domain.

', 'CreateDomainRequest$ClusterConfig' => '

Container for the cluster configuration of a domain.

', 'DomainStatus$ClusterConfig' => '

Container for the cluster configuration of the domain.

', 'UpdateDomainConfigRequest$ClusterConfig' => '

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

', ], ], 'ClusterConfigStatus' => [ 'base' => '

The cluster configuration status for a domain.

', 'refs' => [ 'DomainConfig$ClusterConfig' => '

Container for the cluster configuration of a the domain.

', ], ], 'CognitoOptions' => [ 'base' => '

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Cognito options for the specified domain.

', 'CreateDomainRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'DomainStatus$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', 'UpdateDomainConfigRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

The status of the Cognito options for the specified domain.

', 'refs' => [ 'DomainConfig$CognitoOptions' => '

Container for Amazon Cognito options for the domain.

', ], ], 'ColdStorageOptions' => [ 'base' => '

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

', 'refs' => [ 'ClusterConfig$ColdStorageOptions' => '

Container for cold storage configuration options.

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the package version when it was uploaded.

', 'UpdatePackageRequest$CommitMessage' => '

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleVersionsResponse$CompatibleVersions' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'refs' => [ 'CompatibleVersionsList$member' => NULL, ], ], 'ConfigChangeStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ConfigChangeStatus' => '

The current status of the configuration change.

', 'ChangeProgressStatusDetails$ConfigChangeStatus' => '

The current status of the configuration change.

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

An error occurred because the client attempts to remove a resource that is currently in use.

', 'refs' => [], ], 'ConnectionAlias' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionAlias' => '

Name of the connection.

', 'CreateOutboundConnectionResponse$ConnectionAlias' => '

Name of the connection.

', 'OutboundConnection$ConnectionAlias' => '

Name of the connection.

', ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'AcceptInboundConnectionRequest$ConnectionId' => '

The ID of the inbound connection to accept.

', 'CreateOutboundConnectionResponse$ConnectionId' => '

The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

', 'DeleteInboundConnectionRequest$ConnectionId' => '

The ID of the inbound connection to permanently delete.

', 'DeleteOutboundConnectionRequest$ConnectionId' => '

The ID of the outbound connection you want to permanently delete.

', 'InboundConnection$ConnectionId' => '

The unique identifier of the connection.

', 'OutboundConnection$ConnectionId' => '

Unique identifier of the connection.

', 'RejectInboundConnectionRequest$ConnectionId' => '

The unique identifier of the inbound connection to reject.

', ], ], 'ConnectionMode' => [ 'base' => '

The connection mode for the cross-cluster connection.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionMode' => '

The connection mode.

', 'CreateOutboundConnectionResponse$ConnectionMode' => '

The connection mode.

', 'InboundConnection$ConnectionMode' => '

The connection mode.

', 'OutboundConnection$ConnectionMode' => '

The connection mode.

', ], ], 'ConnectionProperties' => [ 'base' => '

The connection properties of an outbound connection.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionProperties' => '

The ConnectionProperties for the outbound connection.

', 'CreateOutboundConnectionResponse$ConnectionProperties' => '

The ConnectionProperties for the newly created connection.

', 'OutboundConnection$ConnectionProperties' => '

Properties for the outbound connection.

', ], ], 'ConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$Message' => '

Information about the connection.

', 'OutboundConnectionStatus$Message' => '

Verbose information for the outbound connection.

', ], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => '

The result of a CreateDomain operation. Contains the status of the newly created domain.

', 'refs' => [], ], 'CreateOutboundConnectionRequest' => [ 'base' => '

Container for the parameters to the CreateOutboundConnection operation.

', 'refs' => [], ], 'CreateOutboundConnectionResponse' => [ 'base' => '

The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.

', 'refs' => [], ], 'CreatePackageRequest' => [ 'base' => '

Container for request parameters to the CreatePackage operation.

', 'refs' => [], ], 'CreatePackageResponse' => [ 'base' => '

Container for the response returned by the CreatePackage operation.

', 'refs' => [], ], 'CreateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

The timestamp when the package was created.

', 'PackageVersionHistory$CreatedAt' => '

The date and time when the package was created.

', ], ], 'CrossClusterSearchConnectionProperties' => [ 'base' => '

Cross-cluster search specific connection properties.

', 'refs' => [ 'ConnectionProperties$CrossClusterSearch' => '

The connection properties for cross cluster search.

', ], ], 'DataSourceDescription' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Description' => '

A description of the data source.

', 'DataSourceDetails$Description' => '

A description of the data source.

', 'GetDataSourceResponse$Description' => '

A description of the data source.

', 'UpdateDataSourceRequest$Description' => '

A new description of the data source.

', ], ], 'DataSourceDetails' => [ 'base' => '

Details about a direct-query data source.

', 'refs' => [ 'DataSourceList$member' => NULL, ], ], 'DataSourceList' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$DataSources' => '

A list of data sources associated with specified domain.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Name' => '

A name for the data source.

', 'DataSourceDetails$Name' => '

The name of the data source.

', 'DeleteDataSourceRequest$Name' => '

The name of the data source to delete.

', 'GetDataSourceRequest$Name' => '

The name of the data source to get information about.

', 'GetDataSourceResponse$Name' => '

The name of the data source.

', 'UpdateDataSourceRequest$Name' => '

The name of the data source to modify.

', ], ], 'DataSourceType' => [ 'base' => '

The type of data source.

', 'refs' => [ 'AddDataSourceRequest$DataSourceType' => '

The type of data source.

', 'DataSourceDetails$DataSourceType' => '

The type of data source.

', 'GetDataSourceResponse$DataSourceType' => '

The type of data source.

', 'UpdateDataSourceRequest$DataSourceType' => '

The type of data source.

', ], ], 'DeleteDataSourceRequest' => [ 'base' => '

Container for the parameters to the DeleteDataSource operation.

', 'refs' => [], ], 'DeleteDataSourceResponse' => [ 'base' => '

The result of a GetDataSource operation.

', 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => '

Container for the parameters to the DeleteDomain operation.

', 'refs' => [], ], 'DeleteDomainResponse' => [ 'base' => '

The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

', 'refs' => [], ], 'DeleteInboundConnectionRequest' => [ 'base' => '

Container for the parameters to the DeleteInboundConnection operation.

', 'refs' => [], ], 'DeleteInboundConnectionResponse' => [ 'base' => '

The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

', 'refs' => [], ], 'DeleteOutboundConnectionRequest' => [ 'base' => '

Container for the parameters to the DeleteOutboundConnection operation.

', 'refs' => [], ], 'DeleteOutboundConnectionResponse' => [ 'base' => '

Details about the deleted outbound connection.

', 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => '

Deletes a package from OpenSearch Service. The package can\'t be associated with any OpenSearch Service domain.

', 'refs' => [], ], 'DeletePackageResponse' => [ 'base' => '

Container for the response parameters to the DeletePackage operation.

', 'refs' => [], ], 'DeleteVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyFailureException' => [ 'base' => '

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$UpdateStatus' => '

The status of your service software update.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

Specifies the way in which OpenSearch Service will apply an update. Possible values are:

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

', 'refs' => [], ], 'DescribeDomainAutoTunesResponse' => [ 'base' => '

The result of a DescribeDomainAutoTunes request.

', 'refs' => [], ], 'DescribeDomainChangeProgressRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainChangeProgress operation.

', 'refs' => [], ], 'DescribeDomainChangeProgressResponse' => [ 'base' => '

The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

', 'refs' => [], ], 'DescribeDomainConfigRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainConfig operation.

', 'refs' => [], ], 'DescribeDomainConfigResponse' => [ 'base' => '

Contains the configuration information of the requested domain.

', 'refs' => [], ], 'DescribeDomainHealthRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainHealth operation.

', 'refs' => [], ], 'DescribeDomainHealthResponse' => [ 'base' => '

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

', 'refs' => [], ], 'DescribeDomainNodesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainNodes operation.

', 'refs' => [], ], 'DescribeDomainNodesResponse' => [ 'base' => '

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

', 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => '

Container for the parameters to the DescribeDomain operation.

', 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => '

Contains the status of the domain specified in the request.

', 'refs' => [], ], 'DescribeDomainsRequest' => [ 'base' => '

Container for the parameters to the DescribeDomains operation.

', 'refs' => [], ], 'DescribeDomainsResponse' => [ 'base' => '

Contains the status of the specified domains or all domains owned by the account.

', 'refs' => [], ], 'DescribeDryRunProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDryRunProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeInboundConnections operation.

', 'refs' => [], ], 'DescribeInboundConnectionsResponse' => [ 'base' => '

Contains a list of connections matching the filter criteria.

', 'refs' => [], ], 'DescribeInstanceTypeLimitsRequest' => [ 'base' => '

Container for the parameters to the DescribeInstanceTypeLimits operation.

', 'refs' => [], ], 'DescribeInstanceTypeLimitsResponse' => [ 'base' => '

Container for the parameters received from the DescribeInstanceTypeLimits operation.

', 'refs' => [], ], 'DescribeOutboundConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeOutboundConnections operation.

', 'refs' => [], ], 'DescribeOutboundConnectionsResponse' => [ 'base' => '

Contains a list of connections matching the filter criteria.

', 'refs' => [], ], 'DescribePackagesFilter' => [ 'base' => '

A filter to apply to the DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified filter field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for the request parameters to the DescribePackage operation.

', 'refs' => [], ], 'DescribePackagesResponse' => [ 'base' => '

Container for the response returned by the DescribePackages operation.

', 'refs' => [], ], 'DescribeReservedInstanceOfferingsRequest' => [ 'base' => '

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

', 'refs' => [], ], 'DescribeReservedInstanceOfferingsResponse' => [ 'base' => '

Container for results of a DescribeReservedInstanceOfferings request.

', 'refs' => [], ], 'DescribeReservedInstancesRequest' => [ 'base' => '

Container for the request parameters to the DescribeReservedInstances operation.

', 'refs' => [], ], 'DescribeReservedInstancesResponse' => [ 'base' => '

Container for results from DescribeReservedInstances

', 'refs' => [], ], 'DescribeVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

', ], ], 'DisabledOperationException' => [ 'base' => '

An error occured because the client wanted to access an unsupported operation.

', 'refs' => [], ], 'DissociatePackageRequest' => [ 'base' => '

Container for the request parameters to the DissociatePackage operation.

', 'refs' => [], ], 'DissociatePackageResponse' => [ 'base' => '

Container for the response returned by an DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

', 'VpcEndpoint$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', 'VpcEndpointSummary$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', ], ], 'DomainConfig' => [ 'base' => '

Container for the configuration of an OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainConfigResponse$DomainConfig' => '

Container for the configuration of the OpenSearch Service domain.

', 'UpdateDomainConfigResponse$DomainConfig' => '

The status of the updated domain.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure a custom endpoint for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure the endpoint for a domain.

', 'DomainStatus$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'UpdateDomainConfigRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

The configured endpoint options for a domain and their current status.

', 'refs' => [ 'DomainConfig$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainHealth' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$ClusterHealth' => '

The current health status of your cluster.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an OpenSearch Service domain.

', 'refs' => [ 'DomainStatus$DomainId' => '

Unique identifier for the domain.

', ], ], 'DomainInfo' => [ 'base' => '

Information about an OpenSearch Service domain.

', 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains a list of information about a domain.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

', ], ], 'DomainInformationContainer' => [ 'base' => '

Container for information about an OpenSearch Service domain.

', 'refs' => [ 'CreateOutboundConnectionRequest$LocalDomainInfo' => '

Name and Region of the source (local) domain.

', 'CreateOutboundConnectionRequest$RemoteDomainInfo' => '

Name and Region of the destination (remote) domain.

', 'CreateOutboundConnectionResponse$LocalDomainInfo' => '

Information about the source (local) domain.

', 'CreateOutboundConnectionResponse$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'InboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'InboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'OutboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'OutboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', ], ], 'DomainMaintenanceDetails' => [ 'base' => '

Container for the domain maintenance details.

', 'refs' => [ 'DomainMaintenanceList$member' => NULL, ], ], 'DomainMaintenanceList' => [ 'base' => NULL, 'refs' => [ 'ListDomainMaintenancesResponse$DomainMaintenances' => '

A list of the submitted maintenance actions.

', ], ], 'DomainName' => [ 'base' => '

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'refs' => [ 'AWSDomainInformation$DomainName' => '

Name of the domain.

', 'AddDataSourceRequest$DomainName' => '

The name of the domain to add the data source to.

', 'AssociatePackageRequest$DomainName' => '

Name of the domain to associate the package with.

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelDomainConfigChangeRequest$DomainName' => NULL, 'CancelServiceSoftwareUpdateRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to cancel the service software update on.

', 'CreateDomainRequest$DomainName' => '

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'DeleteDataSourceRequest$DomainName' => '

The name of the domain.

', 'DeleteDomainRequest$DomainName' => '

The name of the domain you want to permanently delete.

', 'DescribeDomainAutoTunesRequest$DomainName' => '

Name of the domain that you want Auto-Tune details about.

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The name of the domain to get progress information for.

', 'DescribeDomainConfigRequest$DomainName' => '

Name of the OpenSearch Service domain configuration that you want to describe.

', 'DescribeDomainHealthRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainNodesRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainRequest$DomainName' => '

The name of the domain that you want information about.

', 'DescribeDryRunProgressRequest$DomainName' => '

The name of the domain.

', 'DescribeInstanceTypeLimitsRequest$DomainName' => '

The name of the domain. Only specify if you need the limits for an existing domain.

', 'DissociatePackageRequest$DomainName' => '

Name of the domain to dissociate the package from.

', 'DomainInfo$DomainName' => '

Name of the domain.

', 'DomainMaintenanceDetails$DomainName' => '

The name of the domain.

', 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

Name of the domain that the package is associated with.

', 'DomainStatus$DomainName' => '

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

', 'GetCompatibleVersionsRequest$DomainName' => '

The name of an existing domain. Provide this parameter to limit the results to a single domain.

', 'GetDataSourceRequest$DomainName' => '

The name of the domain.

', 'GetDomainMaintenanceStatusRequest$DomainName' => '

The name of the domain.

', 'GetUpgradeHistoryRequest$DomainName' => '

The name of an existing domain.

', 'GetUpgradeStatusRequest$DomainName' => '

The domain of the domain to get upgrade status information for.

', 'ListDataSourcesRequest$DomainName' => '

The name of the domain.

', 'ListDomainMaintenancesRequest$DomainName' => '

The name of the domain.

', 'ListInstanceTypeDetailsRequest$DomainName' => '

The name of the domain.

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListScheduledActionsRequest$DomainName' => '

The name of the domain.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

The name of the domain to list associated VPC endpoints for.

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartDomainMaintenanceRequest$DomainName' => '

The name of the domain.

', 'StartServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to update to the latest service software.

', 'UpdateDataSourceRequest$DomainName' => '

The name of the domain.

', 'UpdateDomainConfigRequest$DomainName' => '

The name of the domain that you\'re updating.

', 'UpdateScheduledActionRequest$DomainName' => '

The name of the domain to reschedule an action for.

', 'UpgradeDomainRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to upgrade.

', 'UpgradeDomainResponse$DomainName' => '

The name of the domain that was upgraded.

', ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

The fully qualified URL for the custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of OpenSearch Service domain names.

', 'refs' => [ 'DescribeDomainsRequest$DomainNames' => '

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

', ], ], 'DomainNodesStatus' => [ 'base' => '

Container for information about nodes on the domain.

', 'refs' => [ 'DomainNodesStatusList$member' => NULL, ], ], 'DomainNodesStatusList' => [ 'base' => '

List of DomainNodesStatus with details about nodes on the requested domain.

', 'refs' => [ 'DescribeDomainNodesResponse$DomainNodesStatusList' => '

Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

Information about a package that is associated with a domain.

', 'DissociatePackageResponse$DomainPackageDetails' => '

Information about a package that has been dissociated from the domain.

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

Information about all domains associated with a package.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of all packages associated with a domain.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

State of the association.

', ], ], 'DomainProcessingStatusType' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$DomainProcessingStatus' => '

The status of any changes that are currently in progress for the domain.

', ], ], 'DomainState' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$DomainState' => '

The current state of the domain.

', ], ], 'DomainStatus' => [ 'base' => '

The current status of an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainResponse$DomainStatus' => '

The status of the newly created domain.

', 'DeleteDomainResponse$DomainStatus' => '

The status of the domain being deleted.

', 'DescribeDomainResponse$DomainStatus' => '

List that contains the status of each specified OpenSearch Service domain.

', 'DescribeDryRunProgressResponse$DryRunConfig' => '

Details about the changes you\'re planning to make on the domain.

', 'DomainStatusList$member' => NULL, ], ], 'DomainStatusList' => [ 'base' => '

List that contains the status of each specified OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainsResponse$DomainStatusList' => '

The status of the requested domains.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedInstance$FixedPrice' => '

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

', 'ReservedInstance$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'ReservedInstanceOffering$FixedPrice' => '

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

', 'ReservedInstanceOffering$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'UpgradeStepItem$ProgressPercent' => '

The floating point value representing the progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'CancelDomainConfigChangeRequest$DryRun' => '

When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

', 'CancelDomainConfigChangeResponse$DryRun' => '

Whether or not the request was a dry run. If True, the changes were not actually cancelled.

', 'UpdateDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

', ], ], 'DryRunMode' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRunMode' => '

The type of dry run to perform.

', ], ], 'DryRunProgressStatus' => [ 'base' => '

Information about the progress of a pre-upgrade dry run analysis.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunProgressStatus' => '

The current status of the dry run, including any validation errors.

', 'UpdateDomainConfigResponse$DryRunProgressStatus' => '

The status of the dry run being performed on the domain, if any.

', ], ], 'DryRunResults' => [ 'base' => '

Results of a dry run performed in an update domain request.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunResults' => '

The results of the dry run.

', 'UpdateDomainConfigResponse$DryRunResults' => '

Results of the dry run performed in the update domain request.

', ], ], 'Duration' => [ 'base' => '

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

', ], ], 'DurationValue' => [ 'base' => '

Integer that specifies the value of a maintenance schedule duration.

', 'refs' => [ 'Duration$Value' => '

Integer to specify the value of a maintenance schedule duration.

', ], ], 'EBSOptions' => [ 'base' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$EBSOptions' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'DomainStatus$EBSOptions' => '

Container for EBS-based storage settings for the domain.

', 'EBSOptionsStatus$Options' => '

The configured EBS options for the specified domain.

', 'UpdateDomainConfigRequest$EBSOptions' => '

The type and size of the EBS volume to attach to instances in the domain.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

The status of the EBS options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EBSOptions' => '

Container for EBS options configured for the domain.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can\'t modify this parameter after it\'s already been specified.

', 'refs' => [ 'CreateDomainRequest$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', 'DomainStatus$EncryptionAtRestOptions' => '

Encryption at rest settings for the domain.

', 'EncryptionAtRestOptionsStatus$Options' => '

Encryption at rest options for the specified domain.

', 'UpdateDomainConfigRequest$EncryptionAtRestOptions' => '

Encryption at rest options for the domain.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

Status of the encryption at rest options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$Endpoint' => '

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

', 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$Endpoints' => '

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example key, value: \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'.

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

', 'ListDomainNamesRequest$EngineType' => '

Filters the output by domain engine type.

', ], ], 'EngineVersion' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', ], ], 'EnvironmentInfo' => [ 'base' => '

Information about the active domain environment.

', 'refs' => [ 'EnvironmentInfoList$member' => NULL, ], ], 'EnvironmentInfoList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$EnvironmentInformation' => '

A list of EnvironmentInfo for the domain.

', ], ], 'ErrorDetails' => [ 'base' => '

Additional information if the package is in an error state. Null otherwise.

', 'refs' => [ 'DomainPackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', 'PackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BaseException$message' => '

A description of the error.

', 'ErrorDetails$ErrorMessage' => '

A message describing the error.

', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => '

The type of error that occurred.

', ], ], 'Filter' => [ 'base' => '

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsRequest$Filters' => '

A list of filters used to match properties for inbound cross-cluster connections.

', 'DescribeOutboundConnectionsRequest$Filters' => '

List of filter names and values that you can use for requests.

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

The ID of the configuration change.

', 'ChangeProgressStatusDetails$ChangeId' => '

The unique change identifier associated with a specific domain configuration change.

', 'DescribeDomainChangeProgressRequest$ChangeId' => '

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

', 'DescribeDryRunProgressRequest$DryRunId' => '

The unique identifier of the dry run.

', 'DescribeReservedInstanceOfferingsRequest$ReservedInstanceOfferingId' => '

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

', 'DescribeReservedInstancesRequest$ReservedInstanceId' => '

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

', 'DryRunProgressStatus$DryRunId' => '

The unique identifier of the dry run.

', 'GUIDList$member' => NULL, 'PurchaseReservedInstanceOfferingRequest$ReservedInstanceOfferingId' => '

The ID of the Reserved Instance offering to purchase.

', 'PurchaseReservedInstanceOfferingResponse$ReservedInstanceId' => '

The ID of the Reserved Instance offering that was purchased.

', 'ReservedInstance$ReservedInstanceId' => '

The unique identifier for the reservation.

', 'ReservedInstanceOffering$ReservedInstanceOfferingId' => '

The unique identifier of the Reserved Instance offering.

', ], ], 'GUIDList' => [ 'base' => NULL, 'refs' => [ 'CancelDomainConfigChangeResponse$CancelledChangeIds' => '

The unique identifiers of the changes that were cancelled.

', ], ], 'GetCompatibleVersionsRequest' => [ 'base' => '

Container for the request parameters to GetCompatibleVersions operation.

', 'refs' => [], ], 'GetCompatibleVersionsResponse' => [ 'base' => '

Container for the response returned by the GetCompatibleVersions operation.

', 'refs' => [], ], 'GetDataSourceRequest' => [ 'base' => '

Container for the parameters to the GetDataSource operation.

', 'refs' => [], ], 'GetDataSourceResponse' => [ 'base' => '

The result of a GetDataSource operation.

', 'refs' => [], ], 'GetDomainMaintenanceStatusRequest' => [ 'base' => '

Container for the parameters to the GetDomainMaintenanceStatus operation.

', 'refs' => [], ], 'GetDomainMaintenanceStatusResponse' => [ 'base' => '

The result of a GetDomainMaintenanceStatus request that information about the requested action.

', 'refs' => [], ], 'GetPackageVersionHistoryRequest' => [ 'base' => '

Container for the request parameters to the GetPackageVersionHistory operation.

', 'refs' => [], ], 'GetPackageVersionHistoryResponse' => [ 'base' => '

Container for response returned by GetPackageVersionHistory operation.

', 'refs' => [], ], 'GetUpgradeHistoryRequest' => [ 'base' => '

Container for the request parameters to the GetUpgradeHistory operation.

', 'refs' => [], ], 'GetUpgradeHistoryResponse' => [ 'base' => '

Container for the response returned by the GetUpgradeHistory operation.

', 'refs' => [], ], 'GetUpgradeStatusRequest' => [ 'base' => '

Container for the request parameters to the GetUpgradeStatus operation.

', 'refs' => [], ], 'GetUpgradeStatusResponse' => [ 'base' => '

Container for the response returned by the GetUpgradeStatus operation.

', 'refs' => [], ], 'IPAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$IPAddressType' => '

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can\'t change your address type later.

', 'DomainStatus$IPAddressType' => '

The type of IP addresses supported by the endpoint for the domain.

', 'IPAddressTypeStatus$Options' => '

The IP address options for the domain.

', 'UpdateDomainConfigRequest$IPAddressType' => '

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can\'t change it.

', ], ], 'IPAddressTypeStatus' => [ 'base' => '

The IP address type status for the domain.

', 'refs' => [ 'DomainConfig$IPAddressType' => '

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can\'t change your address type later.

', ], ], 'IdentityPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$IdentityPoolId' => '

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'InboundConnection' => [ 'base' => '

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'refs' => [ 'AcceptInboundConnectionResponse$Connection' => '

Information about the accepted inbound connection.

', 'DeleteInboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'InboundConnections$member' => NULL, 'RejectInboundConnectionResponse$Connection' => '

Contains details about the rejected inbound connection.

', ], ], 'InboundConnectionStatus' => [ 'base' => '

The status of an inbound cross-cluster connection for OpenSearch Service.

', 'refs' => [ 'InboundConnection$ConnectionStatus' => '

The current status of the connection.

', ], ], 'InboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$StatusCode' => '

The status code for the connection. Can be one of the following:

', ], ], 'InboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsResponse$Connections' => '

List of inbound connections.

', ], ], 'InitiatedBy' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$InitiatedBy' => '

The IAM principal who initiated the configuration change.

', 'ChangeProgressStatusDetails$InitiatedBy' => '

The IAM principal who initiated the configuration change.

', ], ], 'InstanceCount' => [ 'base' => '

Number of instances in an OpenSearch Service cluster.

', 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$InstanceCount' => '

The number of OpenSearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => '

Limits on the number of instances that can be created for a given instance type.

', ], ], 'InstanceLimits' => [ 'base' => '

Instance-related attributes that are available for a given instance type.

', 'refs' => [ 'Limits$InstanceLimits' => '

The limits for a given instance type.

', ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'InstanceRoleList$member' => NULL, 'LimitsByRole$key' => NULL, ], ], 'InstanceRoleList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$InstanceRole' => '

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

', ], ], 'InstanceTypeDetails' => [ 'base' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'refs' => [ 'InstanceTypeDetailsList$member' => NULL, ], ], 'InstanceTypeDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsResponse$InstanceTypeDetails' => '

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

', ], ], 'InstanceTypeString' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsRequest$InstanceType' => '

An optional parameter that lists information for a given instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$Duration' => '

The duration, in seconds, for which the OpenSearch instance is reserved.

', 'ReservedInstance$InstanceCount' => '

The number of OpenSearch instances that have been reserved.

', 'ReservedInstanceOffering$Duration' => '

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceCount' => '

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

', 'ClusterConfig$DedicatedMasterCount' => '

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

', 'ClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'EBSOptions$VolumeSize' => '

Specifies the size (in GiB) of EBS volumes attached to data nodes.

', 'EBSOptions$Iops' => '

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

', 'EBSOptions$Throughput' => '

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

', ], ], 'InternalException' => [ 'base' => '

Request processing failed because of an unknown error, exception, or internal failure.

', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => '

Request processing failed because you provided an invalid pagination token.

', 'refs' => [], ], 'InvalidTypeException' => [ 'base' => '

An exception for trying to create or access a sub-resource that\'s either invalid or not supported.

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The most recent updated timestamp of the stage.

', 'DomainPackageDetails$LastUpdated' => '

Timestamp of the most recent update to the package association status.

', 'PackageDetails$LastUpdatedAt' => '

Date and time when the package was last updated.

', ], ], 'LimitExceededException' => [ 'base' => '

An exception for trying to create more than the allowed number of resources or sub-resources.

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '', 'StorageTypeLimit$LimitName' => '

Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

The values of the additional instance type limits.

', 'StorageTypeLimit$LimitValues' => '

The limit values.

', ], ], 'Limits' => [ 'base' => '

Limits for a given instance type and for each of its roles.

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

', 'refs' => [ 'DescribeInstanceTypeLimitsResponse$LimitsByRole' => '

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

', ], ], 'ListDataSourcesRequest' => [ 'base' => '

Container for the parameters to the ListDataSources operation.

', 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => '

The result of a ListDataSources operation.

', 'refs' => [], ], 'ListDomainMaintenancesRequest' => [ 'base' => '

Container for the parameters to the ListDomainMaintenances operation.

', 'refs' => [], ], 'ListDomainMaintenancesResponse' => [ 'base' => '

The result of a ListDomainMaintenances request that contains information about the requested actions.

', 'refs' => [], ], 'ListDomainNamesRequest' => [ 'base' => '

Container for the parameters to the ListDomainNames operation.

', 'refs' => [], ], 'ListDomainNamesResponse' => [ 'base' => '

The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

', 'refs' => [], ], 'ListDomainsForPackageRequest' => [ 'base' => '

Container for the request parameters to the ListDomainsForPackage operation.

', 'refs' => [], ], 'ListDomainsForPackageResponse' => [ 'base' => '

Container for the response parameters to the ListDomainsForPackage operation.

', 'refs' => [], ], 'ListInstanceTypeDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceTypeDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesForDomainRequest' => [ 'base' => '

Container for the request parameters to the ListPackagesForDomain operation.

', 'refs' => [], ], 'ListPackagesForDomainResponse' => [ 'base' => '

Container for the response parameters to the ListPackagesForDomain operation.

', 'refs' => [], ], 'ListScheduledActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListScheduledActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsRequest' => [ 'base' => '

Container for the parameters to the ListTags operation.

', 'refs' => [], ], 'ListTagsResponse' => [ 'base' => '

The results of a ListTags operation.

', 'refs' => [], ], 'ListVersionsRequest' => [ 'base' => '

Container for the request parameters to the ListVersions operation.

', 'refs' => [], ], 'ListVersionsResponse' => [ 'base' => '

Container for the parameters for response received from the ListVersions operation.

', 'refs' => [], ], 'ListVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogPublishingOption' => [ 'base' => '

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', 'DomainStatus$LogPublishingOptions' => '

Log publishing options for the domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the domain.

', 'UpdateDomainConfigRequest$LogPublishingOptions' => '

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

The configured log publishing options for the domain and their current status.

', 'refs' => [ 'DomainConfig$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', ], ], 'LogType' => [ 'base' => '

The type of log file. Can be one of the following:

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$BillingSubscriptionId' => '

The unique identifier of the billing subscription.

', 'ScheduledAction$ScheduledTime' => '

The time when the change is scheduled to happen.

', 'SlotList$member' => NULL, 'StartServiceSoftwareUpdateRequest$DesiredStartTime' => '

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

', 'UpdateScheduledActionRequest$DesiredStartTime' => '

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

', ], ], 'MaintenanceStatus' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Status' => '

The status of the action.

', 'GetDomainMaintenanceStatusResponse$Status' => '

The status of the maintenance action.

', 'ListDomainMaintenancesRequest$Status' => '

The status of the action.

', ], ], 'MaintenanceStatusMessage' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$StatusMessage' => '

The status message for the action.

', 'GetDomainMaintenanceStatusResponse$StatusMessage' => '

The status message of the maintenance action.

', ], ], 'MaintenanceType' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Action' => '

The name of the action.

', 'GetDomainMaintenanceStatusResponse$Action' => '

The action name.

', 'ListDomainMaintenancesRequest$Action' => '

The name of the action.

', 'StartDomainMaintenanceRequest$Action' => '

The name of the action.

', ], ], 'MasterNodeStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$MasterNode' => '

Indicates whether the domain has an elected master node.

', ], ], 'MasterUserOptions' => [ 'base' => '

Credentials for the master user for a domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

Container for information about the master user.

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

An optional parameter that specifies the maximum number of results to return for a given request.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeInboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeOutboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribePackagesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstanceOfferingsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetPackageVersionHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetUpgradeHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainMaintenancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainsForPackageRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListInstanceTypeDetailsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListPackagesForDomainRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListScheduledActionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListVersionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

Maximum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => '

The minimum allowed number of instances.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

A message corresponding to the status of the configuration change.

', 'DryRunResults$Message' => '

A message corresponding to the deployment type.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

Minimum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => '

The maximum allowed number of instances.

', ], ], 'ModifyingProperties' => [ 'base' => '

Information about the domain properties that are currently being modified.

', 'refs' => [ 'ModifyingPropertiesList$member' => NULL, ], ], 'ModifyingPropertiesList' => [ 'base' => NULL, 'refs' => [ 'DomainConfig$ModifyingProperties' => '

Information about the domain properties that are currently being modified.

', 'DomainStatus$ModifyingProperties' => '

Information about the domain properties that are currently being modified.

', ], ], 'NextToken' => [ 'base' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

', 'DescribeDomainAutoTunesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeInboundConnectionsRequest$NextToken' => '

If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

', 'DescribeInboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeOutboundConnectionsRequest$NextToken' => '

If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

', 'DescribeOutboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribePackagesRequest$NextToken' => '

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsRequest$NextToken' => '

If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesRequest$NextToken' => '

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

', 'GetPackageVersionHistoryRequest$NextToken' => '

If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

', 'GetUpgradeHistoryRequest$NextToken' => '

If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

', 'ListDomainMaintenancesRequest$NextToken' => '

If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

', 'ListDomainMaintenancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListDomainsForPackageRequest$NextToken' => '

If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

', 'ListInstanceTypeDetailsRequest$NextToken' => '

If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

', 'ListInstanceTypeDetailsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListPackagesForDomainRequest$NextToken' => '

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

', 'ListScheduledActionsRequest$NextToken' => '

If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

', 'ListScheduledActionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVersionsRequest$NextToken' => '

If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

', 'ListVersionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVpcEndpointAccessRequest$NextToken' => '

If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

', 'ListVpcEndpointAccessResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVpcEndpointsRequest$NextToken' => '

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

', 'ListVpcEndpointsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$NodeId' => '

The ID of the data node.

', 'DomainNodesStatus$NodeId' => '

The ID of the node.

', 'GetDomainMaintenanceStatusResponse$NodeId' => '

The node ID of the maintenance action.

', 'StartDomainMaintenanceRequest$NodeId' => '

The ID of the data node.

', ], ], 'NodeStatus' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeStatus' => '

Indicates if the node is active or in standby.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

', 'refs' => [ 'CreateDomainRequest$NodeToNodeEncryptionOptions' => '

Enables node-to-node encryption.

', 'DomainStatus$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

The node-to-node encryption options for the specified domain.

', 'UpdateDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Node-to-node encryption options for the domain.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

Status of the node-to-node encryption options for the specified domain.

', 'refs' => [ 'DomainConfig$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeType' => '

Indicates whether the nodes is a data, master, or ultrawarm node.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

The name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'NumberOfAZs' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$AvailabilityZoneCount' => '

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$ActiveAvailabilityZoneCount' => '

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$StandByAvailabilityZoneCount' => '

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', ], ], 'NumberOfNodes' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ConfiguredDataNodeCount' => '

The total number of data nodes configured in the Availability Zone.

', 'AvailabilityZoneInfo$AvailableDataNodeCount' => '

The number of data nodes active in the Availability Zone.

', 'DescribeDomainHealthResponse$DataNodeCount' => '

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$MasterEligibleNodeCount' => '

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$WarmNodeCount' => '

The number of warm nodes configured for the domain.

', ], ], 'NumberOfShards' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$TotalShards' => '

The total number of primary and replica shards in the Availability Zone.

', 'AvailabilityZoneInfo$TotalUnAssignedShards' => '

The total number of primary and replica shards that aren\'t allocated to any of the nodes in the Availability Zone.

', 'DescribeDomainHealthResponse$TotalShards' => '

The total number of primary and replica shards for the domain.

', 'DescribeDomainHealthResponse$TotalUnAssignedShards' => '

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

', ], ], 'OffPeakWindow' => [ 'base' => '

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don\'t specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

', 'refs' => [ 'OffPeakWindowOptions$OffPeakWindow' => '

Off-peak window settings for the domain.

', ], ], 'OffPeakWindowOptions' => [ 'base' => '

Options for a domain\'s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

', 'refs' => [ 'CreateDomainRequest$OffPeakWindowOptions' => '

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

', 'DomainStatus$OffPeakWindowOptions' => '

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

', 'OffPeakWindowOptionsStatus$Options' => '

The domain\'s off-peak window configuration.

', 'UpdateDomainConfigRequest$OffPeakWindowOptions' => '

Off-peak window options for the domain.

', ], ], 'OffPeakWindowOptionsStatus' => [ 'base' => '

The status of off-peak window options for a domain.

', 'refs' => [ 'DomainConfig$OffPeakWindowOptions' => '

Container for off-peak window options for the domain.

', ], ], 'OpenSearchPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceType' => '

Instance type of data nodes in the cluster.

', 'ClusterConfig$DedicatedMasterType' => '

OpenSearch Service instance type of the dedicated master nodes in the cluster.

', 'DescribeInstanceTypeLimitsRequest$InstanceType' => '

The OpenSearch Service instance type for which you need limit information.

', 'DomainNodesStatus$InstanceType' => '

The instance type information of the node.

', 'InstanceTypeDetails$InstanceType' => '

The instance type.

', 'ReservedInstance$InstanceType' => '

The OpenSearch instance type offered by theReserved Instance offering.

', 'ReservedInstanceOffering$InstanceType' => '

The OpenSearch instance type offered by the Reserved Instance offering.

', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$WarmType' => '

The instance type for the cluster\'s warm nodes.

', ], ], 'OptionState' => [ 'base' => '

The state of a requested domain configuration change. Can be one of the following:

', 'refs' => [ 'OptionStatus$State' => '

The state of the entity.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of an entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

The status of the access policy for the domain.

', 'AdvancedOptionsStatus$Status' => '

The status of advanced options for the specified domain.

', 'AdvancedSecurityOptionsStatus$Status' => '

Status of the fine-grained access control settings for a domain.

', 'ClusterConfigStatus$Status' => '

The status of cluster configuration options for the specified domain.

', 'CognitoOptionsStatus$Status' => '

The status of the Cognito options for the specified domain.

', 'DomainEndpointOptionsStatus$Status' => '

The status of the endpoint options for a domain.

', 'EBSOptionsStatus$Status' => '

The status of the EBS options for the specified domain.

', 'EncryptionAtRestOptionsStatus$Status' => '

The status of the encryption at rest options for the specified domain.

', 'IPAddressTypeStatus$Status' => NULL, 'LogPublishingOptionsStatus$Status' => '

The status of the log publishing options for the domain.

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

The status of the node-to-node encryption options for the specified domain.

', 'OffPeakWindowOptionsStatus$Status' => '

The current status of off-peak window options.

', 'SnapshotOptionsStatus$Status' => '

The status of a daily automated snapshot.

', 'SoftwareUpdateOptionsStatus$Status' => '

The status of service software update options, including creation date and last updated date.

', 'VPCDerivedInfoStatus$Status' => '

The status of the VPC options for the specified domain.

', 'VersionStatus$Status' => '

The status of the version options for the specified domain.

', ], ], 'OutboundConnection' => [ 'base' => '

Specifies details about an outbound cross-cluster connection.

', 'refs' => [ 'DeleteOutboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'OutboundConnections$member' => NULL, ], ], 'OutboundConnectionStatus' => [ 'base' => '

The status of an outbound cross-cluster connection.

', 'refs' => [ 'CreateOutboundConnectionResponse$ConnectionStatus' => '

The status of the connection.

', 'OutboundConnection$ConnectionStatus' => '

Status of the connection.

', ], ], 'OutboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundConnectionStatus$StatusCode' => '

The status code for the outbound connection. Can be one of the following:

', ], ], 'OutboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundConnectionsResponse$Connections' => '

List of outbound connections that match the filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change.

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$OwnerId' => '

The Amazon Web Services account ID of the domain owner.

', ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

A new description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Basic information about an OpenSearch Service package.

', 'DeletePackageResponse$PackageDetails' => '

Information about the deleted package.

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about a package.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

Basic information about a package.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

', 'DeletePackageRequest$PackageID' => '

The internal ID of the package you want to delete. Use DescribePackages to find this value.

', 'DissociatePackageRequest$PackageID' => '

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

The unique identifier of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => '

The unique identifier of the package.

', 'ListDomainsForPackageRequest$PackageID' => '

The unique identifier of the package for which to list associated domains.

', 'PackageDetails$PackageID' => '

The unique identifier of the package.

', 'UpdatePackageRequest$PackageID' => '

The unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique name for the package.

', 'DomainPackageDetails$PackageName' => '

User-specified name of the package.

', 'PackageDetails$PackageName' => '

The user-specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

The Amazon S3 location to import the package from.

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The Amazon S3 location from which to import the package.

', 'UpdatePackageRequest$PackageSource' => '

Amazon S3 bucket and key for the package.

', ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

The type of package.

', 'DomainPackageDetails$PackageType' => '

The type of package.

', 'PackageDetails$PackageType' => '

The type of package.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => '

The current version of the package.

', 'PackageDetails$AvailablePackageVersion' => '

The package version.

', 'PackageVersionHistory$PackageVersion' => '

The package version.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details about a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

A list of package versions, along with their creation time and commit message.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

', ], ], 'PluginClassName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$ClassName' => '

The name of the class to load.

', ], ], 'PluginDescription' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Description' => '

The description of the plugin.

', ], ], 'PluginName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Name' => '

The name of the plugin.

', ], ], 'PluginProperties' => [ 'base' => '

Basic information about the plugin.

', 'refs' => [ 'PackageDetails$AvailablePluginProperties' => '

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

', 'PackageVersionHistory$PluginProperties' => '

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

', ], ], 'PluginVersion' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Version' => '

The version of the plugin.

', ], ], 'PolicyDocument' => [ 'base' => '

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

', 'CreateDomainRequest$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

', 'DomainStatus$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

', 'UpdateDomainConfigRequest$AccessPolicies' => '

Identity and Access Management (IAM) access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PropertyValueType' => [ 'base' => NULL, 'refs' => [ 'ModifyingProperties$ValueType' => '

The type of value that is currently being modified. Properties can have two types:

', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'base' => '

Container for request parameters to the PurchaseReservedInstanceOffering operation.

', 'refs' => [], ], 'PurchaseReservedInstanceOfferingResponse' => [ 'base' => '

Represents the output of a PurchaseReservedInstanceOffering operation.

', 'refs' => [], ], 'RecurringCharge' => [ 'base' => '

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$RecurringCharges' => '

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

', 'ReservedInstanceOffering$RecurringCharges' => '

The recurring charge to your account, regardless of whether you creates any domains using the offering.

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$Region' => '

The Amazon Web Services Region in which the domain is located.

', ], ], 'RejectInboundConnectionRequest' => [ 'base' => '

Container for the request parameters to the RejectInboundConnection operation.

', 'refs' => [], ], 'RejectInboundConnectionResponse' => [ 'base' => '

Represents the output of a RejectInboundConnection operation.

', 'refs' => [], ], 'RemoveTagsRequest' => [ 'base' => '

Container for the request parameters to the RemoveTags operation.

', 'refs' => [], ], 'RequestId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$MaintenanceId' => '

The ID of the requested action.

', 'GetDomainMaintenanceStatusRequest$MaintenanceId' => '

The request ID of the maintenance action.

', 'StartDomainMaintenanceResponse$MaintenanceId' => '

The request ID of requested action.

', ], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedInstance' => [ 'base' => '

Details of an OpenSearch Reserved Instance.

', 'refs' => [ 'ReservedInstanceList$member' => NULL, ], ], 'ReservedInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstancesResponse$ReservedInstances' => '

List of Reserved Instances in the current Region.

', ], ], 'ReservedInstanceOffering' => [ 'base' => '

Details of an OpenSearch Reserved Instance offering.

', 'refs' => [ 'ReservedInstanceOfferingList$member' => NULL, ], ], 'ReservedInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings' => '

List of Reserved Instance offerings.

', ], ], 'ReservedInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$PaymentOption' => '

The payment option as defined in the Reserved Instance offering.

', 'ReservedInstanceOffering$PaymentOption' => '

Payment option for the Reserved Instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

An exception for creating a resource that already exists.

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

An exception for accessing or deleting a resource that doesn\'t exist.

', 'refs' => [], ], 'RevokeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

', 'S3GlueDataCatalog$RoleArn' => '

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

', ], ], 'RollbackOnDisable' => [ 'base' => '

The rollback state while disabling Auto-Tune for the domain.

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

The name of the Amazon S3 bucket containing the package.

', ], ], 'S3GlueDataCatalog' => [ 'base' => '

Information about the Amazon S3 Glue Data Catalog.

', 'refs' => [ 'DataSourceType$S3GlueDataCatalog' => '

An Amazon S3 data source.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3Key' => '

Key (file name) of the package.

', ], ], 'SAMLEntityId' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$EntityId' => '

The unique entity ID of the application in the SAML identity provider.

', ], ], 'SAMLIdp' => [ 'base' => '

The SAML identity povider information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

The SAML Identity Provider\'s information.

', 'SAMLOptionsOutput$Idp' => '

Describes the SAML identity provider\'s information.

', ], ], 'SAMLMetadata' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$MetadataContent' => '

The metadata of the SAML application, in XML format.

', ], ], 'SAMLOptionsInput' => [ 'base' => '

The SAML authentication configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'ScheduleAt' => [ 'base' => NULL, 'refs' => [ 'StartServiceSoftwareUpdateRequest$ScheduleAt' => '

When to start the service software update.

Default: NOW if you don\'t specify a value for DesiredStartTime, and TIMESTAMP if you do.

', 'UpdateScheduledActionRequest$ScheduleAt' => '

When to schedule the action.

', ], ], 'ScheduledAction' => [ 'base' => '

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

', 'refs' => [ 'ScheduledActionsList$member' => NULL, 'UpdateScheduledActionResponse$ScheduledAction' => '

Information about the rescheduled action.

', ], ], 'ScheduledActionsList' => [ 'base' => NULL, 'refs' => [ 'ListScheduledActionsResponse$ScheduledActions' => '

A list of actions that are scheduled for the domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

The Auto-Tune action type.

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

The type of Auto-Tune action.

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

The description of an Auto-Tune maintenance action that occurs on a domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

A description of the Auto-Tune action.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => '

Container for details about a scheduled Auto-Tune action.

', ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

The Auto-Tune action severity.

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.

', ], ], 'ScheduledBy' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$ScheduledBy' => '

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'refs' => [ 'CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

Container for the state of your domain relative to the latest service software.

', 'DomainStatus$ServiceSoftwareOptions' => '

The current status of the domain\'s service software.

', 'StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the OpenSearch Service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

', 'refs' => [ 'DomainStatus$Endpoint' => '

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

', 'DomainStatus$EndpointV2' => '

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

', 'EndpointsMap$value' => NULL, ], ], 'SkipUnavailableStatus' => [ 'base' => '

The status of SkipUnavailable setting for the outbound connection.

', 'refs' => [ 'CrossClusterSearchConnectionProperties$SkipUnavailable' => '

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

', ], ], 'SlotList' => [ 'base' => NULL, 'refs' => [ 'SlotNotAvailableException$SlotSuggestions' => '

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

', ], ], 'SlotNotAvailableException' => [ 'base' => '

An exception for attempting to schedule a domain action during an unavailable time slot.

', 'refs' => [], ], 'SnapshotOptions' => [ 'base' => '

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'refs' => [ 'CreateDomainRequest$SnapshotOptions' => '

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

', 'DomainStatus$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', 'SnapshotOptionsStatus$Options' => '

The daily snapshot options specified for the domain.

', 'UpdateDomainConfigRequest$SnapshotOptions' => '

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Container for information about a daily automated snapshot for an OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', ], ], 'SoftwareUpdateOptions' => [ 'base' => '

Options for configuring service software updates for a domain.

', 'refs' => [ 'CreateDomainRequest$SoftwareUpdateOptions' => '

Software update options for the domain.

', 'DomainStatus$SoftwareUpdateOptions' => '

Service software update options for the domain.

', 'SoftwareUpdateOptionsStatus$Options' => '

The service software update options for a domain.

', 'UpdateDomainConfigRequest$SoftwareUpdateOptions' => '

Service software update options for the domain.

', ], ], 'SoftwareUpdateOptionsStatus' => [ 'base' => '

The status of the service software options for a domain.

', 'refs' => [ 'DomainConfig$SoftwareUpdateOptions' => '

Software update options for the domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

', ], ], 'StartDomainMaintenanceRequest' => [ 'base' => '

Container for the parameters to the StartDomainMaintenance operation.

', 'refs' => [], ], 'StartDomainMaintenanceResponse' => [ 'base' => '

The result of a StartDomainMaintenance request that information about the requested action.

', 'refs' => [], ], 'StartServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the request parameters to the StartServiceSoftwareUpdate operation.

', 'refs' => [], ], 'StartServiceSoftwareUpdateResponse' => [ 'base' => '

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimeHours' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Hours' => '

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

', ], ], 'StartTimeMinutes' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Minutes' => '

The start minute of the window, in UTC.

', ], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

', ], ], 'StorageSubTypeName' => [ 'base' => '

Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types:

', 'refs' => [ 'StorageType$StorageSubTypeName' => '

The storage sub-type, such as gp3 or io1.

', ], ], 'StorageType' => [ 'base' => '

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for the given Amazon OpenSearch Service storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

Limits that are applicable for the given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

Storage-related attributes that are available for a given instance type.

', ], ], 'StorageTypeName' => [ 'base' => '

The type of storage that the domain uses. Can be one of the following:

instance

Built-in storage available for the instance.

ebs

Elastic Block Storage (EBS) attached to the instance.

', 'refs' => [ 'DomainNodesStatus$StorageType' => '

Indicates if the node has EBS or instance storage.

', 'StorageType$StorageTypeName' => '

The name of the storage type.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceResponse$Message' => '

A message associated with creation of the data source.

', 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsOutput$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', 'AutoTuneStatus$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', 'CancelledChangeProperty$PropertyName' => '

The name of the property whose change was cancelled.

', 'CancelledChangeProperty$CancelledValue' => '

The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

', 'CancelledChangeProperty$ActiveValue' => '

The current value of the property, after the change was cancelled.

', 'DeleteDataSourceResponse$Message' => '

A message associated with deletion of the data source.

', 'DescribePackagesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DryRunProgressStatus$DryRunStatus' => '

The current status of the dry run.

', 'DryRunProgressStatus$CreationDate' => '

The timestamp when the dry run was initiated.

', 'DryRunProgressStatus$UpdateDate' => '

The timestamp when the dry run was last updated.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'GetUpgradeHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListDomainsForPackageResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListPackagesForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ModifyingProperties$Name' => '

The name of the property that is currently being modified.

', 'ModifyingProperties$ActiveValue' => '

The current value of the domain property that is being modified.

', 'ModifyingProperties$PendingValue' => '

The value that the property that is currently being modified will eventually have.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedInstance$ReservedInstanceOfferingId' => '

The unique identifier of the Reserved Instance offering.

', 'ReservedInstance$CurrencyCode' => '

The currency code for the offering.

', 'ReservedInstance$State' => '

The state of the Reserved Instance.

', 'ReservedInstanceOffering$CurrencyCode' => '

The currency code for the Reserved Instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

Element of the SAML assertion to use for the user name. Default is NameID.

', 'SAMLOptionsInput$RolesKey' => '

Element of the SAML assertion to use for backend roles. Default is roles.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML roles attribute.

', 'ScheduledAction$Id' => '

The unique identifier of the scheduled action.

', 'ScheduledAction$Description' => '

A description of the action to be taken.

', 'ServiceSoftwareOptions$CurrentVersion' => '

The current service software version present on the domain.

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version, if one is available.

', 'ServiceSoftwareOptions$Description' => '

A description of the service software update status.

', 'StringList$member' => NULL, 'UpdateDataSourceResponse$Message' => '

A message associated with the updated data source.

', 'UpdateScheduledActionRequest$ActionID' => '

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

', 'UpgradeDomainResponse$UpgradeId' => '

The unique identifier of the domain upgrade.

', 'VPCDerivedInfo$VPCId' => '

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

', 'ValidationFailure$Code' => '

The error code of the failure.

', 'ValidationFailure$Message' => '

A message corresponding to the failure.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

The list of properties in the domain configuration change that are still pending.

', 'ChangeProgressStatusDetails$CompletedProperties' => '

The list of properties in the domain configuration change that have completed.

', 'RemoveTagsRequest$TagKeys' => '

The list of tag keys to remove from the domain.

', 'VPCDerivedInfo$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain.

', 'VPCDerivedInfo$AvailabilityZones' => '

The list of Availability Zones associated with the VPC subnets.

', 'VPCDerivedInfo$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain.

', 'VPCOptions$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

', 'VPCOptions$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

', ], ], 'Tag' => [ 'base' => '

A tag (key-value pair) for an Amazon OpenSearch Service resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => '

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they\'re attached.

', 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique for the domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of tags attached to a domain.

', 'refs' => [ 'AddTagsRequest$TagList' => '

List of resource tags.

', 'CreateDomainRequest$TagList' => '

List of tags to add to the domain upon creation.

', 'ListTagsResponse$TagList' => '

List of resource tags associated with the specified domain.

', ], ], 'TagValue' => [ 'base' => '

A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don\'t have to be unique in a tag set.

', 'refs' => [ 'Tag$Value' => '

The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

The unit of a maintenance schedule duration. Valid value is HOUR.

', 'refs' => [ 'Duration$Unit' => '

The unit of measurement for the duration of a maintenance schedule.

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

The latest version of the Auto-Tune options.

', 'OptionStatus$UpdateVersion' => '

The latest version of the entity.

', ], ], 'UncompressedPluginSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$UncompressedSizeInBytes' => '

The uncompressed size of the plugin.

', ], ], 'UpdateDataSourceRequest' => [ 'base' => '

Container for the parameters to the UpdateDataSource operation.

', 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => '

The result of an UpdateDataSource operation.

', 'refs' => [], ], 'UpdateDomainConfigRequest' => [ 'base' => '

Container for the request parameters to the UpdateDomain operation.

', 'refs' => [], ], 'UpdateDomainConfigResponse' => [ 'base' => '

The results of an UpdateDomain request. Contains the status of the domain being updated.

', 'refs' => [], ], 'UpdatePackageRequest' => [ 'base' => '

Container for request parameters to the UpdatePackage operation.

', 'refs' => [], ], 'UpdatePackageResponse' => [ 'base' => '

Container for the response returned by the UpdatePackage operation.

', 'refs' => [], ], 'UpdateScheduledActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateScheduledActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Date and time when Auto-Tune was enabled for the domain.

', 'AutoTuneStatus$UpdateDate' => '

Date and time when the Auto-Tune options were last updated for the domain.

', 'ChangeProgressDetails$StartTime' => '

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

', 'ChangeProgressDetails$LastUpdatedTime' => '

The last time that the configuration change was updated.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'ChangeProgressStatusDetails$LastUpdatedTime' => '

The last time that the status of the configuration change was updated.

', 'DomainMaintenanceDetails$CreatedAt' => '

The time at which the action was created.

', 'DomainMaintenanceDetails$UpdatedAt' => '

The time at which the action was updated.

', 'GetDomainMaintenanceStatusResponse$CreatedAt' => '

The time at which the action was created.

', 'GetDomainMaintenanceStatusResponse$UpdatedAt' => '

The time at which the action was updated.

', 'OptionStatus$CreationDate' => '

The timestamp when the entity was created.

', 'OptionStatus$UpdateDate' => '

The timestamp of the last time the entity was updated.

', 'ReservedInstance$StartTime' => '

The date and time when the reservation was purchased.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeDomainRequest' => [ 'base' => '

Container for the request parameters to the UpgradeDomain operation.

', 'refs' => [], ], 'UpgradeDomainResponse' => [ 'base' => '

Container for the response returned by UpgradeDomain operation.

', 'refs' => [], ], 'UpgradeHistory' => [ 'base' => '

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update.

', 'UpgradeHistory$UpgradeName' => '

A string that describes the upgrade.

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

The status of the current step that an upgrade is on.

', 'UpgradeHistory$UpgradeStatus' => '

The current status of the upgrade. The status can take one of the following values:

', 'UpgradeStepItem$UpgradeStepStatus' => '

The current status of the upgrade. The status can take one of the following values:

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through.

', 'UpgradeStepItem$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through:

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of an upgrade or upgrade eligibility check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

', 'SAMLOptionsInput$MasterUserName' => '

The SAML master user name, which is stored in the domain\'s internal user database.

', ], ], 'VPCDerivedInfo' => [ 'base' => '

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.

', 'refs' => [ 'DomainStatus$VPCOptions' => '

The VPC configuration for the domain.

', 'VPCDerivedInfoStatus$Options' => '

The VPC options for the specified domain.

', 'VpcEndpoint$VpcOptions' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

', ], ], 'VPCDerivedInfoStatus' => [ 'base' => '

Status of the VPC options for a specified domain.

', 'refs' => [ 'DomainConfig$VPCOptions' => '

The current VPC options for the domain and the status of any updates to their configuration.

', ], ], 'VPCOptions' => [ 'base' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'refs' => [ 'CreateDomainRequest$VPCOptions' => '

Container for the values required to configure VPC access domains. If you don\'t specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateDomainConfigRequest$VPCOptions' => '

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

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

An exception for accessing or deleting a resource that doesn\'t exist.

', 'refs' => [], ], 'ValidationFailure' => [ 'base' => '

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

', 'refs' => [ 'ValidationFailures$member' => NULL, ], ], 'ValidationFailures' => [ 'base' => NULL, 'refs' => [ 'DryRunProgressStatus$ValidationFailures' => '

Any validation failures that occurred as a result of the dry run.

', ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more values for the filter.

', ], ], 'VersionList' => [ 'base' => '

List of supported OpenSearch versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => '

The possible versions that you can upgrade the domain to.

', 'ListVersionsResponse$Versions' => '

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', ], ], 'VersionStatus' => [ 'base' => '

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EngineVersion' => '

The OpenSearch or Elasticsearch version that the domain is running.

', ], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version that the OpenSearch Service domain is running.

', 'CreateDomainRequest$EngineVersion' => '

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'DescribeInstanceTypeLimitsRequest$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'DomainStatus$EngineVersion' => '

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

', 'ListInstanceTypeDetailsRequest$EngineVersion' => '

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'UpgradeDomainRequest$TargetVersion' => '

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

', 'UpgradeDomainResponse$TargetVersion' => '

OpenSearch or Elasticsearch version that the domain was upgraded to.

', 'VersionList$member' => NULL, 'VersionStatus$Options' => '

The OpenSearch or Elasticsearch version for the specified domain.

', ], ], 'VolumeSize' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$StorageSize' => '

The storage size of the node, in GiB.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.

', 'refs' => [ 'DomainNodesStatus$StorageVolumeType' => '

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

', 'EBSOptions$VolumeType' => '

Specifies the type of EBS volumes attached to data nodes.

', ], ], 'VpcEndpoint' => [ 'base' => '

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

', 'refs' => [ 'CreateVpcEndpointResponse$VpcEndpoint' => '

Information about the newly created VPC endpoint.

', 'UpdateVpcEndpointResponse$VpcEndpoint' => '

The endpoint to be updated.

', 'VpcEndpoints$member' => NULL, ], ], 'VpcEndpointError' => [ 'base' => '

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'VpcEndpointErrorList$member' => NULL, ], ], 'VpcEndpointErrorCode' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointError$ErrorCode' => '

The code associated with the error.

', ], ], 'VpcEndpointErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpointErrors' => '

Any errors associated with the request.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'DeleteVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpoint$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointError$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointIdList$member' => NULL, 'VpcEndpointSummary$VpcEndpointId' => '

The unique identifier of the endpoint.

', ], ], 'VpcEndpointIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsRequest$VpcEndpointIds' => '

The unique identifiers of the endpoints to get information about.

', ], ], 'VpcEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'WindowStartTime' => [ 'base' => '

The desired start time for an off-peak maintenance window.

', 'refs' => [ 'OffPeakWindow$WindowStartTime' => '

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can\'t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

The zone awareness configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'ClusterConfig$ZoneAwarenessConfig' => '

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

', ], ], 'ZoneStatus' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ZoneStatus' => '

The current state of the Availability Zone. Current options are Active and StandBy.

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

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

', 'operations' => [ 'AcceptInboundConnection' => '

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'AddDataSource' => '

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

', 'AddTags' => '

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

', 'AssociatePackage' => '

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'AuthorizeVpcEndpointAccess' => '

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'CancelDomainConfigChange' => '

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

', 'CancelServiceSoftwareUpdate' => '

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain\'s UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

', 'CreateDomain' => '

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'CreateOutboundConnection' => '

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'CreatePackage' => '

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteDataSource' => '

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

', 'DeleteDomain' => '

Deletes an Amazon OpenSearch Service domain and all of its data. You can\'t recover a domain after you delete it.

', 'DeleteInboundConnection' => '

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeleteOutboundConnection' => '

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeletePackage' => '

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomain' => '

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

', 'DescribeDomainAutoTunes' => '

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

', 'DescribeDomainConfig' => '

Returns the configuration of an Amazon OpenSearch Service domain.

', 'DescribeDomainHealth' => '

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

', 'DescribeDomainNodes' => '

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

', 'DescribeDomains' => '

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

', 'DescribeDryRunProgress' => '

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

', 'DescribeInboundConnections' => '

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribeInstanceTypeLimits' => '

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

', 'DescribeOutboundConnections' => '

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribePackages' => '

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DescribeReservedInstanceOfferings' => '

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeReservedInstances' => '

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Removes a package from the specified Amazon OpenSearch Service domain. The package can\'t be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetCompatibleVersions' => '

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'GetDataSource' => '

Retrieves information about a direct query data source.

', 'GetDomainMaintenanceStatus' => '

The status of the maintenance action.

', 'GetPackageVersionHistory' => '

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

', 'GetUpgradeStatus' => '

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

', 'ListDataSources' => '

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

', 'ListDomainMaintenances' => '

A list of maintenance actions for the domain.

', 'ListDomainNames' => '

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

', 'ListDomainsForPackage' => '

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListInstanceTypeDetails' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'ListPackagesForDomain' => '

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListScheduledActions' => '

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

', 'ListTags' => '

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'ListVersions' => '

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', 'ListVpcEndpointAccess' => '

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'ListVpcEndpoints' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedInstanceOffering' => '

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

', 'RejectInboundConnection' => '

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

', 'RemoveTags' => '

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'RevokeVpcEndpointAccess' => '

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

', 'StartDomainMaintenance' => '

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

', 'StartServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'UpdateDataSource' => '

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

', 'UpdateDomainConfig' => '

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

', 'UpdatePackage' => '

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'UpdateScheduledAction' => '

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeDomain' => '

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

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

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

', 'refs' => [ 'AddTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

', 'DomainStatus$ARN' => '

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

', 'ListTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the domain to view tags for.

', 'MasterUserOptions$MasterUserARN' => '

Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

', 'RemoveTagsRequest$ARN' => '

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The Amazon Web Services account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AWSDomainInformation' => [ 'base' => '

Information about an Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainInformationContainer$AWSDomainInformation' => '

Information about an Amazon OpenSearch Service domain.

', ], ], 'AcceptInboundConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundConnection operation.

', 'refs' => [], ], 'AcceptInboundConnectionResponse' => [ 'base' => '

Contains details about the accepted inbound connection.

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

An error occurred because you don\'t have permissions to access the resource.

', 'refs' => [], ], 'AccessPoliciesStatus' => [ 'base' => '

The configured access rules for the domain\'s search endpoint, and the current status of those rules.

', 'refs' => [ 'DomainConfig$AccessPolicies' => '

Specifies the access policies for the domain.

', ], ], 'ActionSeverity' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Severity' => '

The severity of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Status' => '

The current status of the scheduled action.

', ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Type' => '

The type of action that will be taken on the domain.

', 'UpdateScheduledActionRequest$ActionType' => '

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

', ], ], 'AddDataSourceRequest' => [ 'base' => '

Container for the parameters to the AddDataSource operation.

', 'refs' => [], ], 'AddDataSourceResponse' => [ 'base' => '

The result of an AddDataSource operation.

', 'refs' => [], ], 'AddTagsRequest' => [ 'base' => '

Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

', 'refs' => [], ], 'AdditionalLimit' => [ 'base' => '

List of limits that are specific to a given instance type.

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

List of additional limits that are specific to a given instance type for each of its instance roles.

', ], ], 'AdvancedOptions' => [ 'base' => '

Exposes native OpenSearch configuration values from opensearch.yml. The following advanced options are available:

For more information, see Advanced cluster parameters.

', 'refs' => [ 'AdvancedOptionsStatus$Options' => '

The status of advanced options for the specified domain.

', 'CreateDomainRequest$AdvancedOptions' => '

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

For more information, see Advanced cluster parameters.

', 'DomainStatus$AdvancedOptions' => '

Key-value pairs that specify advanced configuration options.

', 'UpdateDomainConfigRequest$AdvancedOptions' => '

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

For more information, see Advanced cluster parameters.

', 'UpgradeDomainRequest$AdvancedOptions' => '

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

', 'UpgradeDomainResponse$AdvancedOptions' => '

The advanced options configuration for the domain.

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

Status of the advanced options for the specified domain. The following options are available:

For more information, see Advanced cluster parameters.

', 'refs' => [ 'DomainConfig$AdvancedOptions' => '

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

', ], ], 'AdvancedSecurityOptions' => [ 'base' => '

Container for fine-grained access control settings.

', 'refs' => [ 'AdvancedSecurityOptionsStatus$Options' => '

Container for fine-grained access control settings.

', 'DomainStatus$AdvancedSecurityOptions' => '

Settings for fine-grained access control.

', ], ], 'AdvancedSecurityOptionsInput' => [ 'base' => '

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.

', 'refs' => [ 'CreateDomainRequest$AdvancedSecurityOptions' => '

Options for fine-grained access control.

', 'UpdateDomainConfigRequest$AdvancedSecurityOptions' => '

Options for fine-grained access control.

', ], ], 'AdvancedSecurityOptionsStatus' => [ 'base' => '

The status of fine-grained access control settings for a domain.

', 'refs' => [ 'DomainConfig$AdvancedSecurityOptions' => '

Container for fine-grained access control settings for the domain.

', ], ], 'AssociatePackageRequest' => [ 'base' => '

Container for the request parameters to the AssociatePackage operation.

', 'refs' => [], ], 'AssociatePackageResponse' => [ 'base' => '

Container for the response returned by the AssociatePackage operation.

', 'refs' => [], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizedPrincipal' => [ 'base' => '

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'refs' => [ 'AuthorizeVpcEndpointAccessResponse$AuthorizedPrincipal' => '

Information about the Amazon Web Services account or service that was provided access to the domain.

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

A list of IAM principals that can currently access the domain.

', ], ], 'AutoTune' => [ 'base' => '

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

The timestamp of the Auto-Tune action scheduled for the domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

The date and time when the Auto-Tune action is scheduled for the domain.

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', 'AutoTuneOptionsInput$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', ], ], 'AutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

Details about an Auto-Tune action.

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

The list of setting adjustments that Auto-Tune has made to the domain.

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

This object is deprecated. Use the domain\'s off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

', ], ], 'AutoTuneOptions' => [ 'base' => '

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Auto-Tune settings for updating a domain.

', 'UpdateDomainConfigRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

', 'refs' => [ 'CreateDomainRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

', 'refs' => [ 'DomainStatus$AutoTuneOptions' => '

Auto-Tune settings for the domain.

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

The Auto-Tune status for the domain.

', 'refs' => [ 'DomainConfig$AutoTuneOptions' => '

Container for Auto-Tune settings for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

The current state of Auto-Tune on the domain.

', 'AutoTuneStatus$State' => '

The current state of Auto-Tune on the domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

The current status of Auto-Tune for a domain.

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

The type of Auto-Tune action.

', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$AvailabilityZoneName' => '

The name of the Availability Zone.

', 'AvailabilityZoneList$member' => NULL, 'DomainNodesStatus$AvailabilityZone' => '

The Availability Zone of the node.

', ], ], 'AvailabilityZoneInfo' => [ 'base' => '

Information about an Availability Zone on a domain.

', 'refs' => [ 'AvailabilityZoneInfoList$member' => NULL, ], ], 'AvailabilityZoneInfoList' => [ 'base' => NULL, 'refs' => [ 'EnvironmentInfo$AvailabilityZoneInformation' => '

A list of AvailabilityZoneInfo for the domain.

', ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$AvailabilityZones' => '

The supported Availability Zones for the instance type.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

The backend role that the SAML master user is mapped to.

', ], ], 'BaseException' => [ 'base' => '

An error occurred while processing the request.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$Enabled' => '

True if fine-grained access control is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AdvancedSecurityOptionsInput$Enabled' => '

True to enable fine-grained access control.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True to enable the internal user database.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AutoTuneOptions$UseOffPeakWindow' => '

Whether to use the domain\'s off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

', 'AutoTuneOptionsInput$UseOffPeakWindow' => '

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain\'s configured daily off-peak window.

', 'AutoTuneOptionsOutput$UseOffPeakWindow' => '

Whether the domain\'s off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the domain is being deleted.

', 'ClusterConfig$DedicatedMasterEnabled' => '

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

', 'ClusterConfig$ZoneAwarenessEnabled' => '

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'ClusterConfig$WarmEnabled' => '

Whether to enable warm storage for the cluster.

', 'ClusterConfig$MultiAZWithStandbyEnabled' => '

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'CognitoOptions$Enabled' => '

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

', 'ColdStorageOptions$Enabled' => '

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.

', 'DescribeDomainHealthResponse$DedicatedMaster' => '

A boolean that indicates if dedicated master nodes are activated for the domain.

', 'DescribeDryRunProgressRequest$LoadDryRunConfig' => '

Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you\'re planning to make on the domain.

', 'DomainEndpointOptions$EnforceHTTPS' => '

True to require that all traffic to the domain arrive over HTTPS.

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

Whether to enable a custom endpoint for the domain.

', 'DomainStatus$Created' => '

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

', 'DomainStatus$Deleted' => '

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

', 'DomainStatus$Processing' => '

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

', 'DomainStatus$UpgradeProcessing' => '

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

', 'EBSOptions$EBSEnabled' => '

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

', 'EncryptionAtRestOptions$Enabled' => '

True to enable encryption at rest.

', 'InstanceTypeDetails$EncryptionEnabled' => '

Whether encryption at rest and node-to-node encryption are supported for the instance type.

', 'InstanceTypeDetails$CognitoEnabled' => '

Whether Amazon Cognito access is supported for the instance type.

', 'InstanceTypeDetails$AppLogsEnabled' => '

Whether logging is supported for the instance type.

', 'InstanceTypeDetails$AdvancedSecurityEnabled' => '

Whether fine-grained access control is supported for the instance type.

', 'InstanceTypeDetails$WarmEnabled' => '

Whether UltraWarm is supported for the instance type.

', 'ListInstanceTypeDetailsRequest$RetrieveAZs' => '

An optional parameter that specifies the Availability Zones for the domain.

', 'LogPublishingOption$Enabled' => '

Whether the log should be published.

', 'NodeToNodeEncryptionOptions$Enabled' => '

True to enable node-to-node encryption.

', 'OffPeakWindowOptions$Enabled' => '

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can\'t disable the off-peak window after it\'s enabled for a domain.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the entity is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True to enable SAML authentication for a domain.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ScheduledAction$Mandatory' => '

Whether the action is required or optional.

', 'ScheduledAction$Cancellable' => '

Whether or not the scheduled action is cancellable.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you\'re able to update your service software version. False if you can\'t update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you\'re able to cancel your service software version update. False if you can\'t cancel your service software update.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

', 'SoftwareUpdateOptions$AutoSoftwareUpdateEnabled' => '

Whether automatic service software updates are enabled for the domain.

', 'UpgradeDomainRequest$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

', 'UpgradeDomainResponse$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check was performed.

', ], ], 'CancelDomainConfigChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDomainConfigChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the request parameters to cancel a service software update.

', 'refs' => [], ], 'CancelServiceSoftwareUpdateResponse' => [ 'base' => '

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'CancelledChangeProperty' => [ 'base' => '

A property change that was cancelled for an Amazon OpenSearch Service domain.

', 'refs' => [ 'CancelledChangePropertyList$member' => NULL, ], ], 'CancelledChangePropertyList' => [ 'base' => NULL, 'refs' => [ 'CancelDomainConfigChangeResponse$CancelledChangeProperties' => '

The domain change properties that were cancelled.

', ], ], 'ChangeProgressDetails' => [ 'base' => '

Container for information about a configuration change happening on a domain.

', 'refs' => [ 'DomainConfig$ChangeProgressDetails' => '

Container for information about the progress of an existing configuration change.

', 'DomainStatus$ChangeProgressDetails' => '

Information about a configuration change happening on the domain.

', 'UpgradeDomainResponse$ChangeProgressDetails' => '

Container for information about a configuration change happening on a domain.

', ], ], 'ChangeProgressStage' => [ 'base' => '

Progress details for each stage of a domain update.

', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => '

The list of progress stages of a specific domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$ChangeProgressStages' => '

The specific stages that the domain is going through to perform the configuration change.

', ], ], 'ChangeProgressStageName' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => '

The name of the stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The status of the stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

Container for information about the stages of a configuration change happening on a domain.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$ClientToken' => '

Unique, case-sensitive identifier to ensure idempotency of the request.

', ], ], 'CloudWatchLogsLogGroupArn' => [ 'base' => '

ARN of the Cloudwatch log group to publish logs to.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => '

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

', ], ], 'ClusterConfig' => [ 'base' => '

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'refs' => [ 'ClusterConfigStatus$Options' => '

Cluster configuration options for the specified domain.

', 'CreateDomainRequest$ClusterConfig' => '

Container for the cluster configuration of a domain.

', 'DomainStatus$ClusterConfig' => '

Container for the cluster configuration of the domain.

', 'UpdateDomainConfigRequest$ClusterConfig' => '

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

', ], ], 'ClusterConfigStatus' => [ 'base' => '

The cluster configuration status for a domain.

', 'refs' => [ 'DomainConfig$ClusterConfig' => '

Container for the cluster configuration of a the domain.

', ], ], 'CognitoOptions' => [ 'base' => '

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Cognito options for the specified domain.

', 'CreateDomainRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'DomainStatus$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', 'UpdateDomainConfigRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

The status of the Cognito options for the specified domain.

', 'refs' => [ 'DomainConfig$CognitoOptions' => '

Container for Amazon Cognito options for the domain.

', ], ], 'ColdStorageOptions' => [ 'base' => '

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

', 'refs' => [ 'ClusterConfig$ColdStorageOptions' => '

Container for cold storage configuration options.

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the package version when it was uploaded.

', 'UpdatePackageRequest$CommitMessage' => '

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleVersionsResponse$CompatibleVersions' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'refs' => [ 'CompatibleVersionsList$member' => NULL, ], ], 'ConfigChangeStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ConfigChangeStatus' => '

The current status of the configuration change.

', 'ChangeProgressStatusDetails$ConfigChangeStatus' => '

The current status of the configuration change.

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

An error occurred because the client attempts to remove a resource that is currently in use.

', 'refs' => [], ], 'ConnectionAlias' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionAlias' => '

Name of the connection.

', 'CreateOutboundConnectionResponse$ConnectionAlias' => '

Name of the connection.

', 'OutboundConnection$ConnectionAlias' => '

Name of the connection.

', ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'AcceptInboundConnectionRequest$ConnectionId' => '

The ID of the inbound connection to accept.

', 'CreateOutboundConnectionResponse$ConnectionId' => '

The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

', 'DeleteInboundConnectionRequest$ConnectionId' => '

The ID of the inbound connection to permanently delete.

', 'DeleteOutboundConnectionRequest$ConnectionId' => '

The ID of the outbound connection you want to permanently delete.

', 'InboundConnection$ConnectionId' => '

The unique identifier of the connection.

', 'OutboundConnection$ConnectionId' => '

Unique identifier of the connection.

', 'RejectInboundConnectionRequest$ConnectionId' => '

The unique identifier of the inbound connection to reject.

', ], ], 'ConnectionMode' => [ 'base' => '

The connection mode for the cross-cluster connection.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionMode' => '

The connection mode.

', 'CreateOutboundConnectionResponse$ConnectionMode' => '

The connection mode.

', 'InboundConnection$ConnectionMode' => '

The connection mode.

', 'OutboundConnection$ConnectionMode' => '

The connection mode.

', ], ], 'ConnectionProperties' => [ 'base' => '

The connection properties of an outbound connection.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionProperties' => '

The ConnectionProperties for the outbound connection.

', 'CreateOutboundConnectionResponse$ConnectionProperties' => '

The ConnectionProperties for the newly created connection.

', 'OutboundConnection$ConnectionProperties' => '

Properties for the outbound connection.

', ], ], 'ConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$Message' => '

Information about the connection.

', 'OutboundConnectionStatus$Message' => '

Verbose information for the outbound connection.

', ], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => '

The result of a CreateDomain operation. Contains the status of the newly created domain.

', 'refs' => [], ], 'CreateOutboundConnectionRequest' => [ 'base' => '

Container for the parameters to the CreateOutboundConnection operation.

', 'refs' => [], ], 'CreateOutboundConnectionResponse' => [ 'base' => '

The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.

', 'refs' => [], ], 'CreatePackageRequest' => [ 'base' => '

Container for request parameters to the CreatePackage operation.

', 'refs' => [], ], 'CreatePackageResponse' => [ 'base' => '

Container for the response returned by the CreatePackage operation.

', 'refs' => [], ], 'CreateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

The timestamp when the package was created.

', 'PackageVersionHistory$CreatedAt' => '

The date and time when the package was created.

', ], ], 'CrossClusterSearchConnectionProperties' => [ 'base' => '

Cross-cluster search specific connection properties.

', 'refs' => [ 'ConnectionProperties$CrossClusterSearch' => '

The connection properties for cross cluster search.

', ], ], 'DataSourceDescription' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Description' => '

A description of the data source.

', 'DataSourceDetails$Description' => '

A description of the data source.

', 'GetDataSourceResponse$Description' => '

A description of the data source.

', 'UpdateDataSourceRequest$Description' => '

A new description of the data source.

', ], ], 'DataSourceDetails' => [ 'base' => '

Details about a direct-query data source.

', 'refs' => [ 'DataSourceList$member' => NULL, ], ], 'DataSourceList' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$DataSources' => '

A list of data sources associated with specified domain.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Name' => '

A name for the data source.

', 'DataSourceDetails$Name' => '

The name of the data source.

', 'DeleteDataSourceRequest$Name' => '

The name of the data source to delete.

', 'GetDataSourceRequest$Name' => '

The name of the data source to get information about.

', 'GetDataSourceResponse$Name' => '

The name of the data source.

', 'UpdateDataSourceRequest$Name' => '

The name of the data source to modify.

', ], ], 'DataSourceType' => [ 'base' => '

The type of data source.

', 'refs' => [ 'AddDataSourceRequest$DataSourceType' => '

The type of data source.

', 'DataSourceDetails$DataSourceType' => '

The type of data source.

', 'GetDataSourceResponse$DataSourceType' => '

The type of data source.

', 'UpdateDataSourceRequest$DataSourceType' => '

The type of data source.

', ], ], 'DeleteDataSourceRequest' => [ 'base' => '

Container for the parameters to the DeleteDataSource operation.

', 'refs' => [], ], 'DeleteDataSourceResponse' => [ 'base' => '

The result of a GetDataSource operation.

', 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => '

Container for the parameters to the DeleteDomain operation.

', 'refs' => [], ], 'DeleteDomainResponse' => [ 'base' => '

The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

', 'refs' => [], ], 'DeleteInboundConnectionRequest' => [ 'base' => '

Container for the parameters to the DeleteInboundConnection operation.

', 'refs' => [], ], 'DeleteInboundConnectionResponse' => [ 'base' => '

The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

', 'refs' => [], ], 'DeleteOutboundConnectionRequest' => [ 'base' => '

Container for the parameters to the DeleteOutboundConnection operation.

', 'refs' => [], ], 'DeleteOutboundConnectionResponse' => [ 'base' => '

Details about the deleted outbound connection.

', 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => '

Deletes a package from OpenSearch Service. The package can\'t be associated with any OpenSearch Service domain.

', 'refs' => [], ], 'DeletePackageResponse' => [ 'base' => '

Container for the response parameters to the DeletePackage operation.

', 'refs' => [], ], 'DeleteVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyFailureException' => [ 'base' => '

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$UpdateStatus' => '

The status of your service software update.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

Specifies the way in which OpenSearch Service will apply an update. Possible values are:

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

', 'refs' => [], ], 'DescribeDomainAutoTunesResponse' => [ 'base' => '

The result of a DescribeDomainAutoTunes request.

', 'refs' => [], ], 'DescribeDomainChangeProgressRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainChangeProgress operation.

', 'refs' => [], ], 'DescribeDomainChangeProgressResponse' => [ 'base' => '

The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

', 'refs' => [], ], 'DescribeDomainConfigRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainConfig operation.

', 'refs' => [], ], 'DescribeDomainConfigResponse' => [ 'base' => '

Contains the configuration information of the requested domain.

', 'refs' => [], ], 'DescribeDomainHealthRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainHealth operation.

', 'refs' => [], ], 'DescribeDomainHealthResponse' => [ 'base' => '

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

', 'refs' => [], ], 'DescribeDomainNodesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainNodes operation.

', 'refs' => [], ], 'DescribeDomainNodesResponse' => [ 'base' => '

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

', 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => '

Container for the parameters to the DescribeDomain operation.

', 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => '

Contains the status of the domain specified in the request.

', 'refs' => [], ], 'DescribeDomainsRequest' => [ 'base' => '

Container for the parameters to the DescribeDomains operation.

', 'refs' => [], ], 'DescribeDomainsResponse' => [ 'base' => '

Contains the status of the specified domains or all domains owned by the account.

', 'refs' => [], ], 'DescribeDryRunProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDryRunProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeInboundConnections operation.

', 'refs' => [], ], 'DescribeInboundConnectionsResponse' => [ 'base' => '

Contains a list of connections matching the filter criteria.

', 'refs' => [], ], 'DescribeInstanceTypeLimitsRequest' => [ 'base' => '

Container for the parameters to the DescribeInstanceTypeLimits operation.

', 'refs' => [], ], 'DescribeInstanceTypeLimitsResponse' => [ 'base' => '

Container for the parameters received from the DescribeInstanceTypeLimits operation.

', 'refs' => [], ], 'DescribeOutboundConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeOutboundConnections operation.

', 'refs' => [], ], 'DescribeOutboundConnectionsResponse' => [ 'base' => '

Contains a list of connections matching the filter criteria.

', 'refs' => [], ], 'DescribePackagesFilter' => [ 'base' => '

A filter to apply to the DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified filter field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for the request parameters to the DescribePackage operation.

', 'refs' => [], ], 'DescribePackagesResponse' => [ 'base' => '

Container for the response returned by the DescribePackages operation.

', 'refs' => [], ], 'DescribeReservedInstanceOfferingsRequest' => [ 'base' => '

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

', 'refs' => [], ], 'DescribeReservedInstanceOfferingsResponse' => [ 'base' => '

Container for results of a DescribeReservedInstanceOfferings request.

', 'refs' => [], ], 'DescribeReservedInstancesRequest' => [ 'base' => '

Container for the request parameters to the DescribeReservedInstances operation.

', 'refs' => [], ], 'DescribeReservedInstancesResponse' => [ 'base' => '

Container for results from DescribeReservedInstances

', 'refs' => [], ], 'DescribeVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

', ], ], 'DisabledOperationException' => [ 'base' => '

An error occured because the client wanted to access an unsupported operation.

', 'refs' => [], ], 'DissociatePackageRequest' => [ 'base' => '

Container for the request parameters to the DissociatePackage operation.

', 'refs' => [], ], 'DissociatePackageResponse' => [ 'base' => '

Container for the response returned by an DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

', 'VpcEndpoint$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', 'VpcEndpointSummary$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', ], ], 'DomainConfig' => [ 'base' => '

Container for the configuration of an OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainConfigResponse$DomainConfig' => '

Container for the configuration of the OpenSearch Service domain.

', 'UpdateDomainConfigResponse$DomainConfig' => '

The status of the updated domain.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure a custom endpoint for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure the endpoint for a domain.

', 'DomainStatus$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'UpdateDomainConfigRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

The configured endpoint options for a domain and their current status.

', 'refs' => [ 'DomainConfig$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainHealth' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$ClusterHealth' => '

The current health status of your cluster.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an OpenSearch Service domain.

', 'refs' => [ 'DomainStatus$DomainId' => '

Unique identifier for the domain.

', ], ], 'DomainInfo' => [ 'base' => '

Information about an OpenSearch Service domain.

', 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains a list of information about a domain.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

', ], ], 'DomainInformationContainer' => [ 'base' => '

Container for information about an OpenSearch Service domain.

', 'refs' => [ 'CreateOutboundConnectionRequest$LocalDomainInfo' => '

Name and Region of the source (local) domain.

', 'CreateOutboundConnectionRequest$RemoteDomainInfo' => '

Name and Region of the destination (remote) domain.

', 'CreateOutboundConnectionResponse$LocalDomainInfo' => '

Information about the source (local) domain.

', 'CreateOutboundConnectionResponse$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'InboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'InboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'OutboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'OutboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', ], ], 'DomainMaintenanceDetails' => [ 'base' => '

Container for the domain maintenance details.

', 'refs' => [ 'DomainMaintenanceList$member' => NULL, ], ], 'DomainMaintenanceList' => [ 'base' => NULL, 'refs' => [ 'ListDomainMaintenancesResponse$DomainMaintenances' => '

A list of the submitted maintenance actions.

', ], ], 'DomainName' => [ 'base' => '

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'refs' => [ 'AWSDomainInformation$DomainName' => '

Name of the domain.

', 'AddDataSourceRequest$DomainName' => '

The name of the domain to add the data source to.

', 'AssociatePackageRequest$DomainName' => '

Name of the domain to associate the package with.

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelDomainConfigChangeRequest$DomainName' => NULL, 'CancelServiceSoftwareUpdateRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to cancel the service software update on.

', 'CreateDomainRequest$DomainName' => '

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'DeleteDataSourceRequest$DomainName' => '

The name of the domain.

', 'DeleteDomainRequest$DomainName' => '

The name of the domain you want to permanently delete.

', 'DescribeDomainAutoTunesRequest$DomainName' => '

Name of the domain that you want Auto-Tune details about.

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The name of the domain to get progress information for.

', 'DescribeDomainConfigRequest$DomainName' => '

Name of the OpenSearch Service domain configuration that you want to describe.

', 'DescribeDomainHealthRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainNodesRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainRequest$DomainName' => '

The name of the domain that you want information about.

', 'DescribeDryRunProgressRequest$DomainName' => '

The name of the domain.

', 'DescribeInstanceTypeLimitsRequest$DomainName' => '

The name of the domain. Only specify if you need the limits for an existing domain.

', 'DissociatePackageRequest$DomainName' => '

Name of the domain to dissociate the package from.

', 'DomainInfo$DomainName' => '

Name of the domain.

', 'DomainMaintenanceDetails$DomainName' => '

The name of the domain.

', 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

Name of the domain that the package is associated with.

', 'DomainStatus$DomainName' => '

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

', 'GetCompatibleVersionsRequest$DomainName' => '

The name of an existing domain. Provide this parameter to limit the results to a single domain.

', 'GetDataSourceRequest$DomainName' => '

The name of the domain.

', 'GetDomainMaintenanceStatusRequest$DomainName' => '

The name of the domain.

', 'GetUpgradeHistoryRequest$DomainName' => '

The name of an existing domain.

', 'GetUpgradeStatusRequest$DomainName' => '

The domain of the domain to get upgrade status information for.

', 'ListDataSourcesRequest$DomainName' => '

The name of the domain.

', 'ListDomainMaintenancesRequest$DomainName' => '

The name of the domain.

', 'ListInstanceTypeDetailsRequest$DomainName' => '

The name of the domain.

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListScheduledActionsRequest$DomainName' => '

The name of the domain.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

The name of the domain to list associated VPC endpoints for.

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartDomainMaintenanceRequest$DomainName' => '

The name of the domain.

', 'StartServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to update to the latest service software.

', 'UpdateDataSourceRequest$DomainName' => '

The name of the domain.

', 'UpdateDomainConfigRequest$DomainName' => '

The name of the domain that you\'re updating.

', 'UpdateScheduledActionRequest$DomainName' => '

The name of the domain to reschedule an action for.

', 'UpgradeDomainRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to upgrade.

', 'UpgradeDomainResponse$DomainName' => '

The name of the domain that was upgraded.

', ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

The fully qualified URL for the custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of OpenSearch Service domain names.

', 'refs' => [ 'DescribeDomainsRequest$DomainNames' => '

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

', ], ], 'DomainNodesStatus' => [ 'base' => '

Container for information about nodes on the domain.

', 'refs' => [ 'DomainNodesStatusList$member' => NULL, ], ], 'DomainNodesStatusList' => [ 'base' => '

List of DomainNodesStatus with details about nodes on the requested domain.

', 'refs' => [ 'DescribeDomainNodesResponse$DomainNodesStatusList' => '

Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

Information about a package that is associated with a domain.

', 'DissociatePackageResponse$DomainPackageDetails' => '

Information about a package that has been dissociated from the domain.

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

Information about all domains associated with a package.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of all packages associated with a domain.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

State of the association.

', ], ], 'DomainProcessingStatusType' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$DomainProcessingStatus' => '

The status of any changes that are currently in progress for the domain.

', ], ], 'DomainState' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$DomainState' => '

The current state of the domain.

', ], ], 'DomainStatus' => [ 'base' => '

The current status of an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainResponse$DomainStatus' => '

The status of the newly created domain.

', 'DeleteDomainResponse$DomainStatus' => '

The status of the domain being deleted.

', 'DescribeDomainResponse$DomainStatus' => '

List that contains the status of each specified OpenSearch Service domain.

', 'DescribeDryRunProgressResponse$DryRunConfig' => '

Details about the changes you\'re planning to make on the domain.

', 'DomainStatusList$member' => NULL, ], ], 'DomainStatusList' => [ 'base' => '

List that contains the status of each specified OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainsResponse$DomainStatusList' => '

The status of the requested domains.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedInstance$FixedPrice' => '

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

', 'ReservedInstance$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'ReservedInstanceOffering$FixedPrice' => '

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

', 'ReservedInstanceOffering$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'UpgradeStepItem$ProgressPercent' => '

The floating point value representing the progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'CancelDomainConfigChangeRequest$DryRun' => '

When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

', 'CancelDomainConfigChangeResponse$DryRun' => '

Whether or not the request was a dry run. If True, the changes were not actually cancelled.

', 'UpdateDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

', ], ], 'DryRunMode' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRunMode' => '

The type of dry run to perform.

', ], ], 'DryRunProgressStatus' => [ 'base' => '

Information about the progress of a pre-upgrade dry run analysis.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunProgressStatus' => '

The current status of the dry run, including any validation errors.

', 'UpdateDomainConfigResponse$DryRunProgressStatus' => '

The status of the dry run being performed on the domain, if any.

', ], ], 'DryRunResults' => [ 'base' => '

Results of a dry run performed in an update domain request.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunResults' => '

The results of the dry run.

', 'UpdateDomainConfigResponse$DryRunResults' => '

Results of the dry run performed in the update domain request.

', ], ], 'Duration' => [ 'base' => '

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

', ], ], 'DurationValue' => [ 'base' => '

Integer that specifies the value of a maintenance schedule duration.

', 'refs' => [ 'Duration$Value' => '

Integer to specify the value of a maintenance schedule duration.

', ], ], 'EBSOptions' => [ 'base' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$EBSOptions' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'DomainStatus$EBSOptions' => '

Container for EBS-based storage settings for the domain.

', 'EBSOptionsStatus$Options' => '

The configured EBS options for the specified domain.

', 'UpdateDomainConfigRequest$EBSOptions' => '

The type and size of the EBS volume to attach to instances in the domain.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

The status of the EBS options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EBSOptions' => '

Container for EBS options configured for the domain.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can\'t modify this parameter after it\'s already been specified.

', 'refs' => [ 'CreateDomainRequest$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', 'DomainStatus$EncryptionAtRestOptions' => '

Encryption at rest settings for the domain.

', 'EncryptionAtRestOptionsStatus$Options' => '

Encryption at rest options for the specified domain.

', 'UpdateDomainConfigRequest$EncryptionAtRestOptions' => '

Encryption at rest options for the domain.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

Status of the encryption at rest options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$Endpoint' => '

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

', 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$Endpoints' => '

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

', 'ListDomainNamesRequest$EngineType' => '

Filters the output by domain engine type.

', ], ], 'EngineVersion' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', ], ], 'EnvironmentInfo' => [ 'base' => '

Information about the active domain environment.

', 'refs' => [ 'EnvironmentInfoList$member' => NULL, ], ], 'EnvironmentInfoList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$EnvironmentInformation' => '

A list of EnvironmentInfo for the domain.

', ], ], 'ErrorDetails' => [ 'base' => '

Additional information if the package is in an error state. Null otherwise.

', 'refs' => [ 'DomainPackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', 'PackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BaseException$message' => '

A description of the error.

', 'ErrorDetails$ErrorMessage' => '

A message describing the error.

', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => '

The type of error that occurred.

', ], ], 'Filter' => [ 'base' => '

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsRequest$Filters' => '

A list of filters used to match properties for inbound cross-cluster connections.

', 'DescribeOutboundConnectionsRequest$Filters' => '

List of filter names and values that you can use for requests.

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

The ID of the configuration change.

', 'ChangeProgressStatusDetails$ChangeId' => '

The unique change identifier associated with a specific domain configuration change.

', 'DescribeDomainChangeProgressRequest$ChangeId' => '

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

', 'DescribeDryRunProgressRequest$DryRunId' => '

The unique identifier of the dry run.

', 'DescribeReservedInstanceOfferingsRequest$ReservedInstanceOfferingId' => '

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

', 'DescribeReservedInstancesRequest$ReservedInstanceId' => '

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

', 'DryRunProgressStatus$DryRunId' => '

The unique identifier of the dry run.

', 'GUIDList$member' => NULL, 'PurchaseReservedInstanceOfferingRequest$ReservedInstanceOfferingId' => '

The ID of the Reserved Instance offering to purchase.

', 'PurchaseReservedInstanceOfferingResponse$ReservedInstanceId' => '

The ID of the Reserved Instance offering that was purchased.

', 'ReservedInstance$ReservedInstanceId' => '

The unique identifier for the reservation.

', 'ReservedInstanceOffering$ReservedInstanceOfferingId' => '

The unique identifier of the Reserved Instance offering.

', ], ], 'GUIDList' => [ 'base' => NULL, 'refs' => [ 'CancelDomainConfigChangeResponse$CancelledChangeIds' => '

The unique identifiers of the changes that were cancelled.

', ], ], 'GetCompatibleVersionsRequest' => [ 'base' => '

Container for the request parameters to GetCompatibleVersions operation.

', 'refs' => [], ], 'GetCompatibleVersionsResponse' => [ 'base' => '

Container for the response returned by the GetCompatibleVersions operation.

', 'refs' => [], ], 'GetDataSourceRequest' => [ 'base' => '

Container for the parameters to the GetDataSource operation.

', 'refs' => [], ], 'GetDataSourceResponse' => [ 'base' => '

The result of a GetDataSource operation.

', 'refs' => [], ], 'GetDomainMaintenanceStatusRequest' => [ 'base' => '

Container for the parameters to the GetDomainMaintenanceStatus operation.

', 'refs' => [], ], 'GetDomainMaintenanceStatusResponse' => [ 'base' => '

The result of a GetDomainMaintenanceStatus request that information about the requested action.

', 'refs' => [], ], 'GetPackageVersionHistoryRequest' => [ 'base' => '

Container for the request parameters to the GetPackageVersionHistory operation.

', 'refs' => [], ], 'GetPackageVersionHistoryResponse' => [ 'base' => '

Container for response returned by GetPackageVersionHistory operation.

', 'refs' => [], ], 'GetUpgradeHistoryRequest' => [ 'base' => '

Container for the request parameters to the GetUpgradeHistory operation.

', 'refs' => [], ], 'GetUpgradeHistoryResponse' => [ 'base' => '

Container for the response returned by the GetUpgradeHistory operation.

', 'refs' => [], ], 'GetUpgradeStatusRequest' => [ 'base' => '

Container for the request parameters to the GetUpgradeStatus operation.

', 'refs' => [], ], 'GetUpgradeStatusResponse' => [ 'base' => '

Container for the response returned by the GetUpgradeStatus operation.

', 'refs' => [], ], 'HostedZoneId' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$DomainEndpointV2HostedZoneId' => '

The DualStack Hosted Zone Id for the domain.

', ], ], 'IPAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$IPAddressType' => '

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can\'t change your address type later.

', 'DomainStatus$IPAddressType' => '

The type of IP addresses supported by the endpoint for the domain.

', 'IPAddressTypeStatus$Options' => '

The IP address options for the domain.

', 'UpdateDomainConfigRequest$IPAddressType' => '

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can\'t change it.

', ], ], 'IPAddressTypeStatus' => [ 'base' => '

The IP address type status for the domain.

', 'refs' => [ 'DomainConfig$IPAddressType' => '

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can\'t change your address type later.

', ], ], 'IdentityPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$IdentityPoolId' => '

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'InboundConnection' => [ 'base' => '

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'refs' => [ 'AcceptInboundConnectionResponse$Connection' => '

Information about the accepted inbound connection.

', 'DeleteInboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'InboundConnections$member' => NULL, 'RejectInboundConnectionResponse$Connection' => '

Contains details about the rejected inbound connection.

', ], ], 'InboundConnectionStatus' => [ 'base' => '

The status of an inbound cross-cluster connection for OpenSearch Service.

', 'refs' => [ 'InboundConnection$ConnectionStatus' => '

The current status of the connection.

', ], ], 'InboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$StatusCode' => '

The status code for the connection. Can be one of the following:

', ], ], 'InboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsResponse$Connections' => '

List of inbound connections.

', ], ], 'InitiatedBy' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$InitiatedBy' => '

The IAM principal who initiated the configuration change.

', 'ChangeProgressStatusDetails$InitiatedBy' => '

The IAM principal who initiated the configuration change.

', ], ], 'InstanceCount' => [ 'base' => '

Number of instances in an OpenSearch Service cluster.

', 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$InstanceCount' => '

The number of OpenSearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => '

Limits on the number of instances that can be created for a given instance type.

', ], ], 'InstanceLimits' => [ 'base' => '

Instance-related attributes that are available for a given instance type.

', 'refs' => [ 'Limits$InstanceLimits' => '

The limits for a given instance type.

', ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'InstanceRoleList$member' => NULL, 'LimitsByRole$key' => NULL, ], ], 'InstanceRoleList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$InstanceRole' => '

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

', ], ], 'InstanceTypeDetails' => [ 'base' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'refs' => [ 'InstanceTypeDetailsList$member' => NULL, ], ], 'InstanceTypeDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsResponse$InstanceTypeDetails' => '

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

', ], ], 'InstanceTypeString' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsRequest$InstanceType' => '

An optional parameter that lists information for a given instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$Duration' => '

The duration, in seconds, for which the OpenSearch instance is reserved.

', 'ReservedInstance$InstanceCount' => '

The number of OpenSearch instances that have been reserved.

', 'ReservedInstanceOffering$Duration' => '

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceCount' => '

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

', 'ClusterConfig$DedicatedMasterCount' => '

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

', 'ClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'EBSOptions$VolumeSize' => '

Specifies the size (in GiB) of EBS volumes attached to data nodes.

', 'EBSOptions$Iops' => '

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

', 'EBSOptions$Throughput' => '

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

', ], ], 'InternalException' => [ 'base' => '

Request processing failed because of an unknown error, exception, or internal failure.

', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => '

Request processing failed because you provided an invalid pagination token.

', 'refs' => [], ], 'InvalidTypeException' => [ 'base' => '

An exception for trying to create or access a sub-resource that\'s either invalid or not supported.

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The most recent updated timestamp of the stage.

', 'DomainPackageDetails$LastUpdated' => '

Timestamp of the most recent update to the package association status.

', 'PackageDetails$LastUpdatedAt' => '

Date and time when the package was last updated.

', ], ], 'LimitExceededException' => [ 'base' => '

An exception for trying to create more than the allowed number of resources or sub-resources.

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '', 'StorageTypeLimit$LimitName' => '

Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

The values of the additional instance type limits.

', 'StorageTypeLimit$LimitValues' => '

The limit values.

', ], ], 'Limits' => [ 'base' => '

Limits for a given instance type and for each of its roles.

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

', 'refs' => [ 'DescribeInstanceTypeLimitsResponse$LimitsByRole' => '

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

', ], ], 'ListDataSourcesRequest' => [ 'base' => '

Container for the parameters to the ListDataSources operation.

', 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => '

The result of a ListDataSources operation.

', 'refs' => [], ], 'ListDomainMaintenancesRequest' => [ 'base' => '

Container for the parameters to the ListDomainMaintenances operation.

', 'refs' => [], ], 'ListDomainMaintenancesResponse' => [ 'base' => '

The result of a ListDomainMaintenances request that contains information about the requested actions.

', 'refs' => [], ], 'ListDomainNamesRequest' => [ 'base' => '

Container for the parameters to the ListDomainNames operation.

', 'refs' => [], ], 'ListDomainNamesResponse' => [ 'base' => '

The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

', 'refs' => [], ], 'ListDomainsForPackageRequest' => [ 'base' => '

Container for the request parameters to the ListDomainsForPackage operation.

', 'refs' => [], ], 'ListDomainsForPackageResponse' => [ 'base' => '

Container for the response parameters to the ListDomainsForPackage operation.

', 'refs' => [], ], 'ListInstanceTypeDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceTypeDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesForDomainRequest' => [ 'base' => '

Container for the request parameters to the ListPackagesForDomain operation.

', 'refs' => [], ], 'ListPackagesForDomainResponse' => [ 'base' => '

Container for the response parameters to the ListPackagesForDomain operation.

', 'refs' => [], ], 'ListScheduledActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListScheduledActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsRequest' => [ 'base' => '

Container for the parameters to the ListTags operation.

', 'refs' => [], ], 'ListTagsResponse' => [ 'base' => '

The results of a ListTags operation.

', 'refs' => [], ], 'ListVersionsRequest' => [ 'base' => '

Container for the request parameters to the ListVersions operation.

', 'refs' => [], ], 'ListVersionsResponse' => [ 'base' => '

Container for the parameters for response received from the ListVersions operation.

', 'refs' => [], ], 'ListVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogPublishingOption' => [ 'base' => '

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', 'DomainStatus$LogPublishingOptions' => '

Log publishing options for the domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the domain.

', 'UpdateDomainConfigRequest$LogPublishingOptions' => '

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

The configured log publishing options for the domain and their current status.

', 'refs' => [ 'DomainConfig$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', ], ], 'LogType' => [ 'base' => '

The type of log file. Can be one of the following:

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$BillingSubscriptionId' => '

The unique identifier of the billing subscription.

', 'ScheduledAction$ScheduledTime' => '

The time when the change is scheduled to happen.

', 'SlotList$member' => NULL, 'StartServiceSoftwareUpdateRequest$DesiredStartTime' => '

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

', 'UpdateScheduledActionRequest$DesiredStartTime' => '

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

', ], ], 'MaintenanceStatus' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Status' => '

The status of the action.

', 'GetDomainMaintenanceStatusResponse$Status' => '

The status of the maintenance action.

', 'ListDomainMaintenancesRequest$Status' => '

The status of the action.

', ], ], 'MaintenanceStatusMessage' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$StatusMessage' => '

The status message for the action.

', 'GetDomainMaintenanceStatusResponse$StatusMessage' => '

The status message of the maintenance action.

', ], ], 'MaintenanceType' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Action' => '

The name of the action.

', 'GetDomainMaintenanceStatusResponse$Action' => '

The action name.

', 'ListDomainMaintenancesRequest$Action' => '

The name of the action.

', 'StartDomainMaintenanceRequest$Action' => '

The name of the action.

', ], ], 'MasterNodeStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$MasterNode' => '

Indicates whether the domain has an elected master node.

', ], ], 'MasterUserOptions' => [ 'base' => '

Credentials for the master user for a domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

Container for information about the master user.

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

An optional parameter that specifies the maximum number of results to return for a given request.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeInboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeOutboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribePackagesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstanceOfferingsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetPackageVersionHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetUpgradeHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainMaintenancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainsForPackageRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListInstanceTypeDetailsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListPackagesForDomainRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListScheduledActionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListVersionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

Maximum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => '

The minimum allowed number of instances.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

A message corresponding to the status of the configuration change.

', 'DryRunResults$Message' => '

A message corresponding to the deployment type.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

Minimum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => '

The maximum allowed number of instances.

', ], ], 'ModifyingProperties' => [ 'base' => '

Information about the domain properties that are currently being modified.

', 'refs' => [ 'ModifyingPropertiesList$member' => NULL, ], ], 'ModifyingPropertiesList' => [ 'base' => NULL, 'refs' => [ 'DomainConfig$ModifyingProperties' => '

Information about the domain properties that are currently being modified.

', 'DomainStatus$ModifyingProperties' => '

Information about the domain properties that are currently being modified.

', ], ], 'NextToken' => [ 'base' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

', 'DescribeDomainAutoTunesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeInboundConnectionsRequest$NextToken' => '

If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

', 'DescribeInboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeOutboundConnectionsRequest$NextToken' => '

If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

', 'DescribeOutboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribePackagesRequest$NextToken' => '

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsRequest$NextToken' => '

If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesRequest$NextToken' => '

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

', 'GetPackageVersionHistoryRequest$NextToken' => '

If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

', 'GetUpgradeHistoryRequest$NextToken' => '

If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

', 'ListDomainMaintenancesRequest$NextToken' => '

If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

', 'ListDomainMaintenancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListDomainsForPackageRequest$NextToken' => '

If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

', 'ListInstanceTypeDetailsRequest$NextToken' => '

If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

', 'ListInstanceTypeDetailsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListPackagesForDomainRequest$NextToken' => '

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

', 'ListScheduledActionsRequest$NextToken' => '

If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

', 'ListScheduledActionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVersionsRequest$NextToken' => '

If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

', 'ListVersionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVpcEndpointAccessRequest$NextToken' => '

If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

', 'ListVpcEndpointAccessResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListVpcEndpointsRequest$NextToken' => '

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

', 'ListVpcEndpointsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$NodeId' => '

The ID of the data node.

', 'DomainNodesStatus$NodeId' => '

The ID of the node.

', 'GetDomainMaintenanceStatusResponse$NodeId' => '

The node ID of the maintenance action.

', 'StartDomainMaintenanceRequest$NodeId' => '

The ID of the data node.

', ], ], 'NodeStatus' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeStatus' => '

Indicates if the node is active or in standby.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

', 'refs' => [ 'CreateDomainRequest$NodeToNodeEncryptionOptions' => '

Enables node-to-node encryption.

', 'DomainStatus$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

The node-to-node encryption options for the specified domain.

', 'UpdateDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Node-to-node encryption options for the domain.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

Status of the node-to-node encryption options for the specified domain.

', 'refs' => [ 'DomainConfig$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeType' => '

Indicates whether the nodes is a data, master, or ultrawarm node.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

The name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'NumberOfAZs' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$AvailabilityZoneCount' => '

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$ActiveAvailabilityZoneCount' => '

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$StandByAvailabilityZoneCount' => '

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', ], ], 'NumberOfNodes' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ConfiguredDataNodeCount' => '

The total number of data nodes configured in the Availability Zone.

', 'AvailabilityZoneInfo$AvailableDataNodeCount' => '

The number of data nodes active in the Availability Zone.

', 'DescribeDomainHealthResponse$DataNodeCount' => '

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$MasterEligibleNodeCount' => '

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$WarmNodeCount' => '

The number of warm nodes configured for the domain.

', ], ], 'NumberOfShards' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$TotalShards' => '

The total number of primary and replica shards in the Availability Zone.

', 'AvailabilityZoneInfo$TotalUnAssignedShards' => '

The total number of primary and replica shards that aren\'t allocated to any of the nodes in the Availability Zone.

', 'DescribeDomainHealthResponse$TotalShards' => '

The total number of primary and replica shards for the domain.

', 'DescribeDomainHealthResponse$TotalUnAssignedShards' => '

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

', ], ], 'OffPeakWindow' => [ 'base' => '

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don\'t specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

', 'refs' => [ 'OffPeakWindowOptions$OffPeakWindow' => '

Off-peak window settings for the domain.

', ], ], 'OffPeakWindowOptions' => [ 'base' => '

Options for a domain\'s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

', 'refs' => [ 'CreateDomainRequest$OffPeakWindowOptions' => '

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

', 'DomainStatus$OffPeakWindowOptions' => '

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

', 'OffPeakWindowOptionsStatus$Options' => '

The domain\'s off-peak window configuration.

', 'UpdateDomainConfigRequest$OffPeakWindowOptions' => '

Off-peak window options for the domain.

', ], ], 'OffPeakWindowOptionsStatus' => [ 'base' => '

The status of off-peak window options for a domain.

', 'refs' => [ 'DomainConfig$OffPeakWindowOptions' => '

Container for off-peak window options for the domain.

', ], ], 'OpenSearchPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceType' => '

Instance type of data nodes in the cluster.

', 'ClusterConfig$DedicatedMasterType' => '

OpenSearch Service instance type of the dedicated master nodes in the cluster.

', 'DescribeInstanceTypeLimitsRequest$InstanceType' => '

The OpenSearch Service instance type for which you need limit information.

', 'DomainNodesStatus$InstanceType' => '

The instance type information of the node.

', 'InstanceTypeDetails$InstanceType' => '

The instance type.

', 'ReservedInstance$InstanceType' => '

The OpenSearch instance type offered by theReserved Instance offering.

', 'ReservedInstanceOffering$InstanceType' => '

The OpenSearch instance type offered by the Reserved Instance offering.

', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$WarmType' => '

The instance type for the cluster\'s warm nodes.

', ], ], 'OptionState' => [ 'base' => '

The state of a requested domain configuration change. Can be one of the following:

', 'refs' => [ 'OptionStatus$State' => '

The state of the entity.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of an entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

The status of the access policy for the domain.

', 'AdvancedOptionsStatus$Status' => '

The status of advanced options for the specified domain.

', 'AdvancedSecurityOptionsStatus$Status' => '

Status of the fine-grained access control settings for a domain.

', 'ClusterConfigStatus$Status' => '

The status of cluster configuration options for the specified domain.

', 'CognitoOptionsStatus$Status' => '

The status of the Cognito options for the specified domain.

', 'DomainEndpointOptionsStatus$Status' => '

The status of the endpoint options for a domain.

', 'EBSOptionsStatus$Status' => '

The status of the EBS options for the specified domain.

', 'EncryptionAtRestOptionsStatus$Status' => '

The status of the encryption at rest options for the specified domain.

', 'IPAddressTypeStatus$Status' => NULL, 'LogPublishingOptionsStatus$Status' => '

The status of the log publishing options for the domain.

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

The status of the node-to-node encryption options for the specified domain.

', 'OffPeakWindowOptionsStatus$Status' => '

The current status of off-peak window options.

', 'SnapshotOptionsStatus$Status' => '

The status of a daily automated snapshot.

', 'SoftwareUpdateOptionsStatus$Status' => '

The status of service software update options, including creation date and last updated date.

', 'VPCDerivedInfoStatus$Status' => '

The status of the VPC options for the specified domain.

', 'VersionStatus$Status' => '

The status of the version options for the specified domain.

', ], ], 'OutboundConnection' => [ 'base' => '

Specifies details about an outbound cross-cluster connection.

', 'refs' => [ 'DeleteOutboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'OutboundConnections$member' => NULL, ], ], 'OutboundConnectionStatus' => [ 'base' => '

The status of an outbound cross-cluster connection.

', 'refs' => [ 'CreateOutboundConnectionResponse$ConnectionStatus' => '

The status of the connection.

', 'OutboundConnection$ConnectionStatus' => '

Status of the connection.

', ], ], 'OutboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundConnectionStatus$StatusCode' => '

The status code for the outbound connection. Can be one of the following:

', ], ], 'OutboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundConnectionsResponse$Connections' => '

List of outbound connections that match the filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change.

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$OwnerId' => '

The Amazon Web Services account ID of the domain owner.

', ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

A new description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Basic information about an OpenSearch Service package.

', 'DeletePackageResponse$PackageDetails' => '

Information about the deleted package.

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about a package.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

Basic information about a package.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

', 'DeletePackageRequest$PackageID' => '

The internal ID of the package you want to delete. Use DescribePackages to find this value.

', 'DissociatePackageRequest$PackageID' => '

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

The unique identifier of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => '

The unique identifier of the package.

', 'ListDomainsForPackageRequest$PackageID' => '

The unique identifier of the package for which to list associated domains.

', 'PackageDetails$PackageID' => '

The unique identifier of the package.

', 'UpdatePackageRequest$PackageID' => '

The unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique name for the package.

', 'DomainPackageDetails$PackageName' => '

User-specified name of the package.

', 'PackageDetails$PackageName' => '

The user-specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

The Amazon S3 location to import the package from.

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The Amazon S3 location from which to import the package.

', 'UpdatePackageRequest$PackageSource' => '

Amazon S3 bucket and key for the package.

', ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

The type of package.

', 'DomainPackageDetails$PackageType' => '

The type of package.

', 'PackageDetails$PackageType' => '

The type of package.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => '

The current version of the package.

', 'PackageDetails$AvailablePackageVersion' => '

The package version.

', 'PackageVersionHistory$PackageVersion' => '

The package version.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details about a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

A list of package versions, along with their creation time and commit message.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

', ], ], 'PluginClassName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$ClassName' => '

The name of the class to load.

', ], ], 'PluginDescription' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Description' => '

The description of the plugin.

', ], ], 'PluginName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Name' => '

The name of the plugin.

', ], ], 'PluginProperties' => [ 'base' => '

Basic information about the plugin.

', 'refs' => [ 'PackageDetails$AvailablePluginProperties' => '

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

', 'PackageVersionHistory$PluginProperties' => '

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

', ], ], 'PluginVersion' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Version' => '

The version of the plugin.

', ], ], 'PolicyDocument' => [ 'base' => '

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

', 'CreateDomainRequest$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

', 'DomainStatus$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

', 'UpdateDomainConfigRequest$AccessPolicies' => '

Identity and Access Management (IAM) access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PropertyValueType' => [ 'base' => NULL, 'refs' => [ 'ModifyingProperties$ValueType' => '

The type of value that is currently being modified. Properties can have two types:

', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'base' => '

Container for request parameters to the PurchaseReservedInstanceOffering operation.

', 'refs' => [], ], 'PurchaseReservedInstanceOfferingResponse' => [ 'base' => '

Represents the output of a PurchaseReservedInstanceOffering operation.

', 'refs' => [], ], 'RecurringCharge' => [ 'base' => '

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$RecurringCharges' => '

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

', 'ReservedInstanceOffering$RecurringCharges' => '

The recurring charge to your account, regardless of whether you creates any domains using the offering.

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$Region' => '

The Amazon Web Services Region in which the domain is located.

', ], ], 'RejectInboundConnectionRequest' => [ 'base' => '

Container for the request parameters to the RejectInboundConnection operation.

', 'refs' => [], ], 'RejectInboundConnectionResponse' => [ 'base' => '

Represents the output of a RejectInboundConnection operation.

', 'refs' => [], ], 'RemoveTagsRequest' => [ 'base' => '

Container for the request parameters to the RemoveTags operation.

', 'refs' => [], ], 'RequestId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$MaintenanceId' => '

The ID of the requested action.

', 'GetDomainMaintenanceStatusRequest$MaintenanceId' => '

The request ID of the maintenance action.

', 'StartDomainMaintenanceResponse$MaintenanceId' => '

The request ID of requested action.

', ], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedInstance' => [ 'base' => '

Details of an OpenSearch Reserved Instance.

', 'refs' => [ 'ReservedInstanceList$member' => NULL, ], ], 'ReservedInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstancesResponse$ReservedInstances' => '

List of Reserved Instances in the current Region.

', ], ], 'ReservedInstanceOffering' => [ 'base' => '

Details of an OpenSearch Reserved Instance offering.

', 'refs' => [ 'ReservedInstanceOfferingList$member' => NULL, ], ], 'ReservedInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings' => '

List of Reserved Instance offerings.

', ], ], 'ReservedInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$PaymentOption' => '

The payment option as defined in the Reserved Instance offering.

', 'ReservedInstanceOffering$PaymentOption' => '

Payment option for the Reserved Instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

An exception for creating a resource that already exists.

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

An exception for accessing or deleting a resource that doesn\'t exist.

', 'refs' => [], ], 'RevokeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

', 'S3GlueDataCatalog$RoleArn' => '

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

', ], ], 'RollbackOnDisable' => [ 'base' => '

The rollback state while disabling Auto-Tune for the domain.

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

The name of the Amazon S3 bucket containing the package.

', ], ], 'S3GlueDataCatalog' => [ 'base' => '

Information about the Amazon S3 Glue Data Catalog.

', 'refs' => [ 'DataSourceType$S3GlueDataCatalog' => '

An Amazon S3 data source.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3Key' => '

Key (file name) of the package.

', ], ], 'SAMLEntityId' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$EntityId' => '

The unique entity ID of the application in the SAML identity provider.

', ], ], 'SAMLIdp' => [ 'base' => '

The SAML identity povider information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

The SAML Identity Provider\'s information.

', 'SAMLOptionsOutput$Idp' => '

Describes the SAML identity provider\'s information.

', ], ], 'SAMLMetadata' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$MetadataContent' => '

The metadata of the SAML application, in XML format.

', ], ], 'SAMLOptionsInput' => [ 'base' => '

The SAML authentication configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'ScheduleAt' => [ 'base' => NULL, 'refs' => [ 'StartServiceSoftwareUpdateRequest$ScheduleAt' => '

When to start the service software update.

Default: NOW if you don\'t specify a value for DesiredStartTime, and TIMESTAMP if you do.

', 'UpdateScheduledActionRequest$ScheduleAt' => '

When to schedule the action.

', ], ], 'ScheduledAction' => [ 'base' => '

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

', 'refs' => [ 'ScheduledActionsList$member' => NULL, 'UpdateScheduledActionResponse$ScheduledAction' => '

Information about the rescheduled action.

', ], ], 'ScheduledActionsList' => [ 'base' => NULL, 'refs' => [ 'ListScheduledActionsResponse$ScheduledActions' => '

A list of actions that are scheduled for the domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

The Auto-Tune action type.

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

The type of Auto-Tune action.

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

The description of an Auto-Tune maintenance action that occurs on a domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

A description of the Auto-Tune action.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => '

Container for details about a scheduled Auto-Tune action.

', ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

The Auto-Tune action severity.

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.

', ], ], 'ScheduledBy' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$ScheduledBy' => '

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'refs' => [ 'CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

Container for the state of your domain relative to the latest service software.

', 'DomainStatus$ServiceSoftwareOptions' => '

The current status of the domain\'s service software.

', 'StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the OpenSearch Service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

', 'refs' => [ 'DomainStatus$Endpoint' => '

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

', 'DomainStatus$EndpointV2' => '

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

', 'EndpointsMap$value' => NULL, ], ], 'SkipUnavailableStatus' => [ 'base' => '

The status of SkipUnavailable setting for the outbound connection.

', 'refs' => [ 'CrossClusterSearchConnectionProperties$SkipUnavailable' => '

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

', ], ], 'SlotList' => [ 'base' => NULL, 'refs' => [ 'SlotNotAvailableException$SlotSuggestions' => '

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

', ], ], 'SlotNotAvailableException' => [ 'base' => '

An exception for attempting to schedule a domain action during an unavailable time slot.

', 'refs' => [], ], 'SnapshotOptions' => [ 'base' => '

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'refs' => [ 'CreateDomainRequest$SnapshotOptions' => '

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

', 'DomainStatus$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', 'SnapshotOptionsStatus$Options' => '

The daily snapshot options specified for the domain.

', 'UpdateDomainConfigRequest$SnapshotOptions' => '

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Container for information about a daily automated snapshot for an OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', ], ], 'SoftwareUpdateOptions' => [ 'base' => '

Options for configuring service software updates for a domain.

', 'refs' => [ 'CreateDomainRequest$SoftwareUpdateOptions' => '

Software update options for the domain.

', 'DomainStatus$SoftwareUpdateOptions' => '

Service software update options for the domain.

', 'SoftwareUpdateOptionsStatus$Options' => '

The service software update options for a domain.

', 'UpdateDomainConfigRequest$SoftwareUpdateOptions' => '

Service software update options for the domain.

', ], ], 'SoftwareUpdateOptionsStatus' => [ 'base' => '

The status of the service software options for a domain.

', 'refs' => [ 'DomainConfig$SoftwareUpdateOptions' => '

Software update options for the domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

', ], ], 'StartDomainMaintenanceRequest' => [ 'base' => '

Container for the parameters to the StartDomainMaintenance operation.

', 'refs' => [], ], 'StartDomainMaintenanceResponse' => [ 'base' => '

The result of a StartDomainMaintenance request that information about the requested action.

', 'refs' => [], ], 'StartServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the request parameters to the StartServiceSoftwareUpdate operation.

', 'refs' => [], ], 'StartServiceSoftwareUpdateResponse' => [ 'base' => '

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimeHours' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Hours' => '

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

', ], ], 'StartTimeMinutes' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Minutes' => '

The start minute of the window, in UTC.

', ], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

', ], ], 'StorageSubTypeName' => [ 'base' => '

Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types:

', 'refs' => [ 'StorageType$StorageSubTypeName' => '

The storage sub-type, such as gp3 or io1.

', ], ], 'StorageType' => [ 'base' => '

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for the given Amazon OpenSearch Service storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

Limits that are applicable for the given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

Storage-related attributes that are available for a given instance type.

', ], ], 'StorageTypeName' => [ 'base' => '

The type of storage that the domain uses. Can be one of the following:

instance

Built-in storage available for the instance.

ebs

Elastic Block Storage (EBS) attached to the instance.

', 'refs' => [ 'DomainNodesStatus$StorageType' => '

Indicates if the node has EBS or instance storage.

', 'StorageType$StorageTypeName' => '

The name of the storage type.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceResponse$Message' => '

A message associated with creation of the data source.

', 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsOutput$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', 'AutoTuneStatus$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', 'CancelledChangeProperty$PropertyName' => '

The name of the property whose change was cancelled.

', 'CancelledChangeProperty$CancelledValue' => '

The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

', 'CancelledChangeProperty$ActiveValue' => '

The current value of the property, after the change was cancelled.

', 'DeleteDataSourceResponse$Message' => '

A message associated with deletion of the data source.

', 'DescribePackagesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'DryRunProgressStatus$DryRunStatus' => '

The current status of the dry run.

', 'DryRunProgressStatus$CreationDate' => '

The timestamp when the dry run was initiated.

', 'DryRunProgressStatus$UpdateDate' => '

The timestamp when the dry run was last updated.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'GetUpgradeHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListDomainsForPackageResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ListPackagesForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

', 'ModifyingProperties$Name' => '

The name of the property that is currently being modified.

', 'ModifyingProperties$ActiveValue' => '

The current value of the domain property that is being modified.

', 'ModifyingProperties$PendingValue' => '

The value that the property that is currently being modified will eventually have.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedInstance$ReservedInstanceOfferingId' => '

The unique identifier of the Reserved Instance offering.

', 'ReservedInstance$CurrencyCode' => '

The currency code for the offering.

', 'ReservedInstance$State' => '

The state of the Reserved Instance.

', 'ReservedInstanceOffering$CurrencyCode' => '

The currency code for the Reserved Instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

Element of the SAML assertion to use for the user name. Default is NameID.

', 'SAMLOptionsInput$RolesKey' => '

Element of the SAML assertion to use for backend roles. Default is roles.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML roles attribute.

', 'ScheduledAction$Id' => '

The unique identifier of the scheduled action.

', 'ScheduledAction$Description' => '

A description of the action to be taken.

', 'ServiceSoftwareOptions$CurrentVersion' => '

The current service software version present on the domain.

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version, if one is available.

', 'ServiceSoftwareOptions$Description' => '

A description of the service software update status.

', 'StringList$member' => NULL, 'UpdateDataSourceResponse$Message' => '

A message associated with the updated data source.

', 'UpdateScheduledActionRequest$ActionID' => '

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

', 'UpgradeDomainResponse$UpgradeId' => '

The unique identifier of the domain upgrade.

', 'VPCDerivedInfo$VPCId' => '

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

', 'ValidationFailure$Code' => '

The error code of the failure.

', 'ValidationFailure$Message' => '

A message corresponding to the failure.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

The list of properties in the domain configuration change that are still pending.

', 'ChangeProgressStatusDetails$CompletedProperties' => '

The list of properties in the domain configuration change that have completed.

', 'RemoveTagsRequest$TagKeys' => '

The list of tag keys to remove from the domain.

', 'VPCDerivedInfo$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain.

', 'VPCDerivedInfo$AvailabilityZones' => '

The list of Availability Zones associated with the VPC subnets.

', 'VPCDerivedInfo$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain.

', 'VPCOptions$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

', 'VPCOptions$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

', ], ], 'Tag' => [ 'base' => '

A tag (key-value pair) for an Amazon OpenSearch Service resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => '

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they\'re attached.

', 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique for the domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of tags attached to a domain.

', 'refs' => [ 'AddTagsRequest$TagList' => '

List of resource tags.

', 'CreateDomainRequest$TagList' => '

List of tags to add to the domain upon creation.

', 'ListTagsResponse$TagList' => '

List of resource tags associated with the specified domain.

', ], ], 'TagValue' => [ 'base' => '

A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don\'t have to be unique in a tag set.

', 'refs' => [ 'Tag$Value' => '

The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

The unit of a maintenance schedule duration. Valid value is HOUR.

', 'refs' => [ 'Duration$Unit' => '

The unit of measurement for the duration of a maintenance schedule.

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

The latest version of the Auto-Tune options.

', 'OptionStatus$UpdateVersion' => '

The latest version of the entity.

', ], ], 'UncompressedPluginSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$UncompressedSizeInBytes' => '

The uncompressed size of the plugin.

', ], ], 'UpdateDataSourceRequest' => [ 'base' => '

Container for the parameters to the UpdateDataSource operation.

', 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => '

The result of an UpdateDataSource operation.

', 'refs' => [], ], 'UpdateDomainConfigRequest' => [ 'base' => '

Container for the request parameters to the UpdateDomain operation.

', 'refs' => [], ], 'UpdateDomainConfigResponse' => [ 'base' => '

The results of an UpdateDomain request. Contains the status of the domain being updated.

', 'refs' => [], ], 'UpdatePackageRequest' => [ 'base' => '

Container for request parameters to the UpdatePackage operation.

', 'refs' => [], ], 'UpdatePackageResponse' => [ 'base' => '

Container for the response returned by the UpdatePackage operation.

', 'refs' => [], ], 'UpdateScheduledActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateScheduledActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Date and time when Auto-Tune was enabled for the domain.

', 'AutoTuneStatus$UpdateDate' => '

Date and time when the Auto-Tune options were last updated for the domain.

', 'ChangeProgressDetails$StartTime' => '

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

', 'ChangeProgressDetails$LastUpdatedTime' => '

The last time that the configuration change was updated.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'ChangeProgressStatusDetails$LastUpdatedTime' => '

The last time that the status of the configuration change was updated.

', 'DomainMaintenanceDetails$CreatedAt' => '

The time at which the action was created.

', 'DomainMaintenanceDetails$UpdatedAt' => '

The time at which the action was updated.

', 'GetDomainMaintenanceStatusResponse$CreatedAt' => '

The time at which the action was created.

', 'GetDomainMaintenanceStatusResponse$UpdatedAt' => '

The time at which the action was updated.

', 'OptionStatus$CreationDate' => '

The timestamp when the entity was created.

', 'OptionStatus$UpdateDate' => '

The timestamp of the last time the entity was updated.

', 'ReservedInstance$StartTime' => '

The date and time when the reservation was purchased.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeDomainRequest' => [ 'base' => '

Container for the request parameters to the UpgradeDomain operation.

', 'refs' => [], ], 'UpgradeDomainResponse' => [ 'base' => '

Container for the response returned by UpgradeDomain operation.

', 'refs' => [], ], 'UpgradeHistory' => [ 'base' => '

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update.

', 'UpgradeHistory$UpgradeName' => '

A string that describes the upgrade.

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

The status of the current step that an upgrade is on.

', 'UpgradeHistory$UpgradeStatus' => '

The current status of the upgrade. The status can take one of the following values:

', 'UpgradeStepItem$UpgradeStepStatus' => '

The current status of the upgrade. The status can take one of the following values:

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through.

', 'UpgradeStepItem$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through:

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of an upgrade or upgrade eligibility check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

', 'SAMLOptionsInput$MasterUserName' => '

The SAML master user name, which is stored in the domain\'s internal user database.

', ], ], 'VPCDerivedInfo' => [ 'base' => '

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.

', 'refs' => [ 'DomainStatus$VPCOptions' => '

The VPC configuration for the domain.

', 'VPCDerivedInfoStatus$Options' => '

The VPC options for the specified domain.

', 'VpcEndpoint$VpcOptions' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

', ], ], 'VPCDerivedInfoStatus' => [ 'base' => '

Status of the VPC options for a specified domain.

', 'refs' => [ 'DomainConfig$VPCOptions' => '

The current VPC options for the domain and the status of any updates to their configuration.

', ], ], 'VPCOptions' => [ 'base' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'refs' => [ 'CreateDomainRequest$VPCOptions' => '

Container for the values required to configure VPC access domains. If you don\'t specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateDomainConfigRequest$VPCOptions' => '

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

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

An exception for accessing or deleting a resource that doesn\'t exist.

', 'refs' => [], ], 'ValidationFailure' => [ 'base' => '

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

', 'refs' => [ 'ValidationFailures$member' => NULL, ], ], 'ValidationFailures' => [ 'base' => NULL, 'refs' => [ 'DryRunProgressStatus$ValidationFailures' => '

Any validation failures that occurred as a result of the dry run.

', ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more values for the filter.

', ], ], 'VersionList' => [ 'base' => '

List of supported OpenSearch versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => '

The possible versions that you can upgrade the domain to.

', 'ListVersionsResponse$Versions' => '

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', ], ], 'VersionStatus' => [ 'base' => '

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EngineVersion' => '

The OpenSearch or Elasticsearch version that the domain is running.

', ], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version that the OpenSearch Service domain is running.

', 'CreateDomainRequest$EngineVersion' => '

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'DescribeInstanceTypeLimitsRequest$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'DomainStatus$EngineVersion' => '

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

', 'ListInstanceTypeDetailsRequest$EngineVersion' => '

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'UpgradeDomainRequest$TargetVersion' => '

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

', 'UpgradeDomainResponse$TargetVersion' => '

OpenSearch or Elasticsearch version that the domain was upgraded to.

', 'VersionList$member' => NULL, 'VersionStatus$Options' => '

The OpenSearch or Elasticsearch version for the specified domain.

', ], ], 'VolumeSize' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$StorageSize' => '

The storage size of the node, in GiB.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.

', 'refs' => [ 'DomainNodesStatus$StorageVolumeType' => '

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

', 'EBSOptions$VolumeType' => '

Specifies the type of EBS volumes attached to data nodes.

', ], ], 'VpcEndpoint' => [ 'base' => '

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

', 'refs' => [ 'CreateVpcEndpointResponse$VpcEndpoint' => '

Information about the newly created VPC endpoint.

', 'UpdateVpcEndpointResponse$VpcEndpoint' => '

The endpoint to be updated.

', 'VpcEndpoints$member' => NULL, ], ], 'VpcEndpointError' => [ 'base' => '

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'VpcEndpointErrorList$member' => NULL, ], ], 'VpcEndpointErrorCode' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointError$ErrorCode' => '

The code associated with the error.

', ], ], 'VpcEndpointErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpointErrors' => '

Any errors associated with the request.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'DeleteVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpoint$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointError$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointIdList$member' => NULL, 'VpcEndpointSummary$VpcEndpointId' => '

The unique identifier of the endpoint.

', ], ], 'VpcEndpointIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsRequest$VpcEndpointIds' => '

The unique identifiers of the endpoints to get information about.

', ], ], 'VpcEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'WindowStartTime' => [ 'base' => '

The desired start time for an off-peak maintenance window.

', 'refs' => [ 'OffPeakWindow$WindowStartTime' => '

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can\'t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

The zone awareness configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'ClusterConfig$ZoneAwarenessConfig' => '

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

', ], ], 'ZoneStatus' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ZoneStatus' => '

The current state of the Availability Zone. Current options are Active and StandBy.

', ], ], ],]; diff --git a/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json b/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json index a2266f3cfc..71341cc4ef 100644 --- a/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json +++ b/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json @@ -31,6 +31,23 @@ {"shape":"InternalServerException"} ] }, + "AssociateProtectConfiguration":{ + "name":"AssociateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateProtectConfigurationRequest"}, + "output":{"shape":"AssociateProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "CreateConfigurationSet":{ "name":"CreateConfigurationSet", "http":{ @@ -101,6 +118,22 @@ {"shape":"InternalServerException"} ] }, + "CreateProtectConfiguration":{ + "name":"CreateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProtectConfigurationRequest"}, + "output":{"shape":"CreateProtectConfigurationResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "CreateRegistration":{ "name":"CreateRegistration", "http":{ @@ -188,6 +221,22 @@ {"shape":"InternalServerException"} ] }, + "DeleteAccountDefaultProtectConfiguration":{ + "name":"DeleteAccountDefaultProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountDefaultProtectConfigurationRequest"}, + "output":{"shape":"DeleteAccountDefaultProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "DeleteConfigurationSet":{ "name":"DeleteConfigurationSet", "http":{ @@ -269,6 +318,21 @@ {"shape":"InternalServerException"} ] }, + "DeleteMediaMessageSpendLimitOverride":{ + "name":"DeleteMediaMessageSpendLimitOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMediaMessageSpendLimitOverrideRequest"}, + "output":{"shape":"DeleteMediaMessageSpendLimitOverrideResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "DeleteOptOutList":{ "name":"DeleteOptOutList", "http":{ @@ -320,6 +384,23 @@ {"shape":"InternalServerException"} ] }, + "DeleteProtectConfiguration":{ + "name":"DeleteProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProtectConfigurationRequest"}, + "output":{"shape":"DeleteProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "DeleteRegistration":{ "name":"DeleteRegistration", "http":{ @@ -544,6 +625,22 @@ {"shape":"InternalServerException"} ] }, + "DescribeProtectConfigurations":{ + "name":"DescribeProtectConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProtectConfigurationsRequest"}, + "output":{"shape":"DescribeProtectConfigurationsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "DescribeRegistrationAttachments":{ "name":"DescribeRegistrationAttachments", "http":{ @@ -717,6 +814,23 @@ {"shape":"InternalServerException"} ] }, + "DisassociateProtectConfiguration":{ + "name":"DisassociateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateProtectConfigurationRequest"}, + "output":{"shape":"DisassociateProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "DiscardRegistrationVersion":{ "name":"DiscardRegistrationVersion", "http":{ @@ -734,6 +848,22 @@ {"shape":"InternalServerException"} ] }, + "GetProtectConfigurationCountryRuleSet":{ + "name":"GetProtectConfigurationCountryRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetProtectConfigurationCountryRuleSetRequest"}, + "output":{"shape":"GetProtectConfigurationCountryRuleSetResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "ListPoolOriginationIdentities":{ "name":"ListPoolOriginationIdentities", "http":{ @@ -920,6 +1050,24 @@ {"shape":"InternalServerException"} ] }, + "SendMediaMessage":{ + "name":"SendMediaMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMediaMessageRequest"}, + "output":{"shape":"SendMediaMessageResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "SendTextMessage":{ "name":"SendTextMessage", "http":{ @@ -956,6 +1104,22 @@ {"shape":"InternalServerException"} ] }, + "SetAccountDefaultProtectConfiguration":{ + "name":"SetAccountDefaultProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetAccountDefaultProtectConfigurationRequest"}, + "output":{"shape":"SetAccountDefaultProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "SetDefaultMessageType":{ "name":"SetDefaultMessageType", "http":{ @@ -988,6 +1152,21 @@ {"shape":"InternalServerException"} ] }, + "SetMediaMessageSpendLimitOverride":{ + "name":"SetMediaMessageSpendLimitOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetMediaMessageSpendLimitOverrideRequest"}, + "output":{"shape":"SetMediaMessageSpendLimitOverrideResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "SetTextMessageSpendLimitOverride":{ "name":"SetTextMessageSpendLimitOverride", "http":{ @@ -1119,6 +1298,38 @@ {"shape":"InternalServerException"} ] }, + "UpdateProtectConfiguration":{ + "name":"UpdateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProtectConfigurationRequest"}, + "output":{"shape":"UpdateProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "UpdateProtectConfigurationCountryRuleSet":{ + "name":"UpdateProtectConfigurationCountryRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProtectConfigurationCountryRuleSetRequest"}, + "output":{"shape":"UpdateProtectConfigurationCountryRuleSetResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, "UpdateSenderId":{ "name":"UpdateSenderId", "http":{ @@ -1186,7 +1397,10 @@ }, "AccountAttributeName":{ "type":"string", - "enum":["ACCOUNT_TIER"] + "enum":[ + "ACCOUNT_TIER", + "DEFAULT_PROTECT_CONFIGURATION_ID" + ] }, "AccountLimit":{ "type":"structure", @@ -1251,6 +1465,32 @@ "IsoCountryCode":{"shape":"IsoCountryCode"} } }, + "AssociateProtectConfigurationRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "ConfigurationSetName" + ], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"}, + "ConfigurationSetName":{"shape":"ConfigurationSetNameOrArn"} + } + }, + "AssociateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ConfigurationSetArn", + "ConfigurationSetName", + "ProtectConfigurationArn", + "ProtectConfigurationId" + ], + "members":{ + "ConfigurationSetArn":{"shape":"String"}, + "ConfigurationSetName":{"shape":"ConfigurationSetName"}, + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"} + } + }, "AttachmentBody":{ "type":"blob", "max":1572864, @@ -1319,7 +1559,8 @@ "event-destination-name", "matching-event-types", "default-message-type", - "default-sender-id" + "default-sender-id", + "protect-configuration-id" ] }, "ConfigurationSetInformation":{ @@ -1336,7 +1577,8 @@ "EventDestinations":{"shape":"EventDestinationList"}, "DefaultMessageType":{"shape":"MessageType"}, "DefaultSenderId":{"shape":"SenderId"}, - "CreatedTimestamp":{"shape":"Timestamp"} + "CreatedTimestamp":{"shape":"Timestamp"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"} } }, "ConfigurationSetInformationList":{ @@ -1404,7 +1646,11 @@ "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED", "TWO_WAY_CONFIG_MISMATCH", "VERIFICATION_CODE_EXPIRED", - "VERIFICATION_ALREADY_COMPLETE" + "VERIFICATION_ALREADY_COMPLETE", + "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT", + "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET", + "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET", + "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION" ] }, "ContextKey":{ @@ -1533,6 +1779,35 @@ "CreatedTimestamp":{"shape":"Timestamp"} } }, + "CreateProtectConfigurationRequest":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "DeletionProtectionEnabled":{"shape":"Boolean"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"}, + "CreatedTimestamp":{"shape":"Timestamp"}, + "AccountDefault":{"shape":"PrimitiveBoolean"}, + "DeletionProtectionEnabled":{"shape":"PrimitiveBoolean"}, + "Tags":{"shape":"TagList"} + } + }, "CreateRegistrationAssociationRequest":{ "type":"structure", "required":[ @@ -1680,6 +1955,22 @@ "CreatedTimestamp":{"shape":"Timestamp"} } }, + "DeleteAccountDefaultProtectConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteAccountDefaultProtectConfigurationResult":{ + "type":"structure", + "required":[ + "DefaultProtectConfigurationArn", + "DefaultProtectConfigurationId" + ], + "members":{ + "DefaultProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "DefaultProtectConfigurationId":{"shape":"ProtectConfigurationId"} + } + }, "DeleteConfigurationSetRequest":{ "type":"structure", "required":["ConfigurationSetName"], @@ -1768,6 +2059,17 @@ "KeywordAction":{"shape":"KeywordAction"} } }, + "DeleteMediaMessageSpendLimitOverrideRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteMediaMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{"shape":"MonthlyLimit"} + } + }, "DeleteOptOutListRequest":{ "type":"structure", "required":["OptOutListName"], @@ -1827,6 +2129,30 @@ "CreatedTimestamp":{"shape":"Timestamp"} } }, + "DeleteProtectConfigurationRequest":{ + "type":"structure", + "required":["ProtectConfigurationId"], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"} + } + }, + "DeleteProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"}, + "CreatedTimestamp":{"shape":"Timestamp"}, + "AccountDefault":{"shape":"PrimitiveBoolean"}, + "DeletionProtectionEnabled":{"shape":"PrimitiveBoolean"} + } + }, "DeleteRegistrationAttachmentRequest":{ "type":"structure", "required":["RegistrationAttachmentId"], @@ -2089,6 +2415,22 @@ "NextToken":{"shape":"NextToken"} } }, + "DescribeProtectConfigurationsRequest":{ + "type":"structure", + "members":{ + "ProtectConfigurationIds":{"shape":"ProtectConfigurationIdList"}, + "Filters":{"shape":"ProtectConfigurationFilterList"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + } + }, + "DescribeProtectConfigurationsResult":{ + "type":"structure", + "members":{ + "ProtectConfigurations":{"shape":"ProtectConfigurationInformationList"}, + "NextToken":{"shape":"NextToken"} + } + }, "DescribeRegistrationAttachmentsRequest":{ "type":"structure", "members":{ @@ -2339,6 +2681,32 @@ "IsoCountryCode":{"shape":"IsoCountryCode"} } }, + "DisassociateProtectConfigurationRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "ConfigurationSetName" + ], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"}, + "ConfigurationSetName":{"shape":"ConfigurationSetNameOrArn"} + } + }, + "DisassociateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ConfigurationSetArn", + "ConfigurationSetName", + "ProtectConfigurationArn", + "ProtectConfigurationId" + ], + "members":{ + "ConfigurationSetArn":{"shape":"String"}, + "ConfigurationSetName":{"shape":"ConfigurationSetName"}, + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"} + } + }, "DiscardRegistrationVersionRequest":{ "type":"structure", "required":["RegistrationId"], @@ -2416,13 +2784,30 @@ "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", - "VOICE_TTL_EXPIRED" + "VOICE_TTL_EXPIRED", + "MEDIA_ALL", + "MEDIA_PENDING", + "MEDIA_QUEUED", + "MEDIA_SUCCESSFUL", + "MEDIA_DELIVERED", + "MEDIA_INVALID", + "MEDIA_INVALID_MESSAGE", + "MEDIA_UNREACHABLE", + "MEDIA_CARRIER_UNREACHABLE", + "MEDIA_BLOCKED", + "MEDIA_CARRIER_BLOCKED", + "MEDIA_SPAM", + "MEDIA_UNKNOWN", + "MEDIA_TTL_EXPIRED", + "MEDIA_FILE_INACCESSIBLE", + "MEDIA_FILE_TYPE_UNSUPPORTED", + "MEDIA_FILE_SIZE_EXCEEDED" ] }, "EventTypeList":{ "type":"list", "member":{"shape":"EventType"}, - "max":25, + "max":43, "min":1 }, "FieldPath":{ @@ -2455,9 +2840,9 @@ }, "FilterValue":{ "type":"string", - "max":100, + "max":128, "min":1, - "pattern":"[\\.:A-Za-z0-9_-]+" + "pattern":"[/\\.:A-Za-z0-9_-]+" }, "FilterValueList":{ "type":"list", @@ -2465,6 +2850,32 @@ "max":20, "min":1 }, + "GetProtectConfigurationCountryRuleSetRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "NumberCapability" + ], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"}, + "NumberCapability":{"shape":"NumberCapability"} + } + }, + "GetProtectConfigurationCountryRuleSetResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "NumberCapability", + "CountryRuleSet" + ], + "members":{ + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"}, + "NumberCapability":{"shape":"NumberCapability"}, + "CountryRuleSet":{"shape":"ProtectConfigurationCountryRuleSet"} + } + }, "IamRoleArn":{ "type":"string", "max":2048, @@ -2661,6 +3072,24 @@ "max":100, "min":1 }, + "MediaMessageOriginationIdentity":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/\\+-]+" + }, + "MediaUrlList":{ + "type":"list", + "member":{"shape":"MediaUrlValue"}, + "max":1, + "min":1 + }, + "MediaUrlValue":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"s3://([a-z0-9\\.-]{3,63})/(.+)" + }, "MessageType":{ "type":"string", "enum":[ @@ -2696,13 +3125,14 @@ "type":"string", "enum":[ "SMS", - "VOICE" + "VOICE", + "MMS" ] }, "NumberCapabilityList":{ "type":"list", "member":{"shape":"NumberCapability"}, - "max":2, + "max":3, "min":1 }, "NumberStatus":{ @@ -3037,6 +3467,98 @@ }, "PrimitiveBoolean":{"type":"boolean"}, "PrimitiveLong":{"type":"long"}, + "ProtectConfigurationArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"arn:\\S+" + }, + "ProtectConfigurationCountryRuleSet":{ + "type":"map", + "key":{"shape":"IsoCountryCode"}, + "value":{"shape":"ProtectConfigurationCountryRuleSetInformation"}, + "max":300, + "min":1 + }, + "ProtectConfigurationCountryRuleSetInformation":{ + "type":"structure", + "required":["ProtectStatus"], + "members":{ + "ProtectStatus":{"shape":"ProtectStatus"} + } + }, + "ProtectConfigurationFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{"shape":"ProtectConfigurationFilterName"}, + "Values":{"shape":"FilterValueList"} + } + }, + "ProtectConfigurationFilterList":{ + "type":"list", + "member":{"shape":"ProtectConfigurationFilter"}, + "max":20, + "min":0 + }, + "ProtectConfigurationFilterName":{ + "type":"string", + "enum":[ + "account-default", + "deletion-protection-enabled" + ] + }, + "ProtectConfigurationId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9_-]+" + }, + "ProtectConfigurationIdList":{ + "type":"list", + "member":{"shape":"ProtectConfigurationIdOrArn"}, + "max":5, + "min":0 + }, + "ProtectConfigurationIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "ProtectConfigurationInformation":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"}, + "CreatedTimestamp":{"shape":"Timestamp"}, + "AccountDefault":{"shape":"PrimitiveBoolean"}, + "DeletionProtectionEnabled":{"shape":"PrimitiveBoolean"} + } + }, + "ProtectConfigurationInformationList":{ + "type":"list", + "member":{"shape":"ProtectConfigurationInformation"}, + "max":100, + "min":1 + }, + "ProtectStatus":{ + "type":"string", + "enum":[ + "ALLOW", + "BLOCK" + ] + }, "PutKeywordRequest":{ "type":"structure", "required":[ @@ -3729,7 +4251,8 @@ "opted-out-number", "registration", "registration-attachment", - "verified-destination-number" + "verified-destination-number", + "protect-configuration" ] }, "SectionPath":{ @@ -3804,6 +4327,31 @@ "MessageId":{"shape":"String"} } }, + "SendMediaMessageRequest":{ + "type":"structure", + "required":[ + "DestinationPhoneNumber", + "OriginationIdentity" + ], + "members":{ + "DestinationPhoneNumber":{"shape":"PhoneNumber"}, + "OriginationIdentity":{"shape":"MediaMessageOriginationIdentity"}, + "MessageBody":{"shape":"TextMessageBody"}, + "MediaUrls":{"shape":"MediaUrlList"}, + "ConfigurationSetName":{"shape":"ConfigurationSetNameOrArn"}, + "MaxPrice":{"shape":"MaxPrice"}, + "TimeToLive":{"shape":"TimeToLive"}, + "Context":{"shape":"ContextMap"}, + "DryRun":{"shape":"PrimitiveBoolean"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"} + } + }, + "SendMediaMessageResult":{ + "type":"structure", + "members":{ + "MessageId":{"shape":"String"} + } + }, "SendTextMessageRequest":{ "type":"structure", "required":["DestinationPhoneNumber"], @@ -3818,7 +4366,8 @@ "TimeToLive":{"shape":"TimeToLive"}, "Context":{"shape":"ContextMap"}, "DestinationCountryParameters":{"shape":"DestinationCountryParameters"}, - "DryRun":{"shape":"PrimitiveBoolean"} + "DryRun":{"shape":"PrimitiveBoolean"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"} } }, "SendTextMessageResult":{ @@ -3843,7 +4392,8 @@ "MaxPricePerMinute":{"shape":"MaxPrice"}, "TimeToLive":{"shape":"TimeToLive"}, "Context":{"shape":"ContextMap"}, - "DryRun":{"shape":"PrimitiveBoolean"} + "DryRun":{"shape":"PrimitiveBoolean"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"} } }, "SendVoiceMessageResult":{ @@ -3951,6 +4501,7 @@ "EVENT_DESTINATIONS_PER_CONFIGURATION_SET", "KEYWORDS_PER_PHONE_NUMBER", "KEYWORDS_PER_POOL", + "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA", "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE", "OPT_OUT_LISTS_PER_ACCOUNT", @@ -3965,9 +4516,28 @@ "SENDER_IDS_PER_ACCOUNT", "TAGS_PER_RESOURCE", "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT", - "VERIFICATION_ATTEMPTS_PER_DAY" + "VERIFICATION_ATTEMPTS_PER_DAY", + "PROTECT_CONFIGURATIONS_PER_ACCOUNT" ] }, + "SetAccountDefaultProtectConfigurationRequest":{ + "type":"structure", + "required":["ProtectConfigurationId"], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"} + } + }, + "SetAccountDefaultProtectConfigurationResult":{ + "type":"structure", + "required":[ + "DefaultProtectConfigurationArn", + "DefaultProtectConfigurationId" + ], + "members":{ + "DefaultProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "DefaultProtectConfigurationId":{"shape":"ProtectConfigurationId"} + } + }, "SetDefaultMessageTypeRequest":{ "type":"structure", "required":[ @@ -4006,6 +4576,19 @@ "SenderId":{"shape":"SenderId"} } }, + "SetMediaMessageSpendLimitOverrideRequest":{ + "type":"structure", + "required":["MonthlyLimit"], + "members":{ + "MonthlyLimit":{"shape":"MonthlyLimit"} + } + }, + "SetMediaMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{"shape":"MonthlyLimit"} + } + }, "SetTextMessageSpendLimitOverrideRequest":{ "type":"structure", "required":["MonthlyLimit"], @@ -4068,7 +4651,8 @@ "type":"string", "enum":[ "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", - "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", + "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT" ] }, "String":{"type":"string"}, @@ -4331,6 +4915,59 @@ "CreatedTimestamp":{"shape":"Timestamp"} } }, + "UpdateProtectConfigurationCountryRuleSetRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "NumberCapability", + "CountryRuleSetUpdates" + ], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"}, + "NumberCapability":{"shape":"NumberCapability"}, + "CountryRuleSetUpdates":{"shape":"ProtectConfigurationCountryRuleSet"} + } + }, + "UpdateProtectConfigurationCountryRuleSetResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "NumberCapability", + "CountryRuleSet" + ], + "members":{ + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"}, + "NumberCapability":{"shape":"NumberCapability"}, + "CountryRuleSet":{"shape":"ProtectConfigurationCountryRuleSet"} + } + }, + "UpdateProtectConfigurationRequest":{ + "type":"structure", + "required":["ProtectConfigurationId"], + "members":{ + "ProtectConfigurationId":{"shape":"ProtectConfigurationIdOrArn"}, + "DeletionProtectionEnabled":{"shape":"Boolean"} + } + }, + "UpdateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{"shape":"ProtectConfigurationArn"}, + "ProtectConfigurationId":{"shape":"ProtectConfigurationId"}, + "CreatedTimestamp":{"shape":"Timestamp"}, + "AccountDefault":{"shape":"PrimitiveBoolean"}, + "DeletionProtectionEnabled":{"shape":"PrimitiveBoolean"} + } + }, "UpdateSenderIdRequest":{ "type":"structure", "required":[ @@ -4406,6 +5043,7 @@ "INVALID_REQUEST", "INVALID_REGISTRATION_ASSOCIATION", "MAXIMUM_SIZE_EXCEEDED", + "MEDIA_TYPE_NOT_SUPPORTED", "MISSING_PARAMETER", "PARAMETERS_CANNOT_BE_USED_TOGETHER", "PHONE_NUMBER_CANNOT_BE_OPTED_IN", diff --git a/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json.php b/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json.php index e08adaea02..774a982688 100644 --- a/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json.php +++ b/src/data/pinpoint-sms-voice-v2/2022-03-31/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2022-03-31', 'endpointPrefix' => 'sms-voice', 'jsonVersion' => '1.0', 'protocol' => 'json', 'serviceFullName' => 'Amazon Pinpoint SMS Voice V2', 'serviceId' => 'Pinpoint SMS Voice V2', 'signatureVersion' => 'v4', 'signingName' => 'sms-voice', 'targetPrefix' => 'PinpointSMSVoiceV2', 'uid' => 'pinpoint-sms-voice-v2-2022-03-31', ], 'operations' => [ 'AssociateOriginationIdentity' => [ 'name' => 'AssociateOriginationIdentity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateOriginationIdentityRequest', ], 'output' => [ 'shape' => 'AssociateOriginationIdentityResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConfigurationSet' => [ 'name' => 'CreateConfigurationSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateConfigurationSetRequest', ], 'output' => [ 'shape' => 'CreateConfigurationSetResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateEventDestination' => [ 'name' => 'CreateEventDestination', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventDestinationRequest', ], 'output' => [ 'shape' => 'CreateEventDestinationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateOptOutList' => [ 'name' => 'CreateOptOutList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOptOutListRequest', ], 'output' => [ 'shape' => 'CreateOptOutListResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreatePool' => [ 'name' => 'CreatePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePoolRequest', ], 'output' => [ 'shape' => 'CreatePoolResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistration' => [ 'name' => 'CreateRegistration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationRequest', ], 'output' => [ 'shape' => 'CreateRegistrationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistrationAssociation' => [ 'name' => 'CreateRegistrationAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationAssociationRequest', ], 'output' => [ 'shape' => 'CreateRegistrationAssociationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistrationAttachment' => [ 'name' => 'CreateRegistrationAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationAttachmentRequest', ], 'output' => [ 'shape' => 'CreateRegistrationAttachmentResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistrationVersion' => [ 'name' => 'CreateRegistrationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationVersionRequest', ], 'output' => [ 'shape' => 'CreateRegistrationVersionResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateVerifiedDestinationNumber' => [ 'name' => 'CreateVerifiedDestinationNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVerifiedDestinationNumberRequest', ], 'output' => [ 'shape' => 'CreateVerifiedDestinationNumberResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteConfigurationSet' => [ 'name' => 'DeleteConfigurationSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigurationSetRequest', ], 'output' => [ 'shape' => 'DeleteConfigurationSetResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteDefaultMessageType' => [ 'name' => 'DeleteDefaultMessageType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDefaultMessageTypeRequest', ], 'output' => [ 'shape' => 'DeleteDefaultMessageTypeResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteDefaultSenderId' => [ 'name' => 'DeleteDefaultSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDefaultSenderIdRequest', ], 'output' => [ 'shape' => 'DeleteDefaultSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteEventDestination' => [ 'name' => 'DeleteEventDestination', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventDestinationRequest', ], 'output' => [ 'shape' => 'DeleteEventDestinationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteKeyword' => [ 'name' => 'DeleteKeyword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKeywordRequest', ], 'output' => [ 'shape' => 'DeleteKeywordResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteOptOutList' => [ 'name' => 'DeleteOptOutList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptOutListRequest', ], 'output' => [ 'shape' => 'DeleteOptOutListResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteOptedOutNumber' => [ 'name' => 'DeleteOptedOutNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptedOutNumberRequest', ], 'output' => [ 'shape' => 'DeleteOptedOutNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeletePool' => [ 'name' => 'DeletePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePoolRequest', ], 'output' => [ 'shape' => 'DeletePoolResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteRegistration' => [ 'name' => 'DeleteRegistration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegistrationRequest', ], 'output' => [ 'shape' => 'DeleteRegistrationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteRegistrationAttachment' => [ 'name' => 'DeleteRegistrationAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegistrationAttachmentRequest', ], 'output' => [ 'shape' => 'DeleteRegistrationAttachmentResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteRegistrationFieldValue' => [ 'name' => 'DeleteRegistrationFieldValue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegistrationFieldValueRequest', ], 'output' => [ 'shape' => 'DeleteRegistrationFieldValueResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteTextMessageSpendLimitOverride' => [ 'name' => 'DeleteTextMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTextMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'DeleteTextMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteVerifiedDestinationNumber' => [ 'name' => 'DeleteVerifiedDestinationNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVerifiedDestinationNumberRequest', ], 'output' => [ 'shape' => 'DeleteVerifiedDestinationNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteVoiceMessageSpendLimitOverride' => [ 'name' => 'DeleteVoiceMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVoiceMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'DeleteVoiceMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeAccountAttributes' => [ 'name' => 'DescribeAccountAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountAttributesRequest', ], 'output' => [ 'shape' => 'DescribeAccountAttributesResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeAccountLimits' => [ 'name' => 'DescribeAccountLimits', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountLimitsRequest', ], 'output' => [ 'shape' => 'DescribeAccountLimitsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeConfigurationSets' => [ 'name' => 'DescribeConfigurationSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationSetsRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationSetsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeKeywords' => [ 'name' => 'DescribeKeywords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeKeywordsRequest', ], 'output' => [ 'shape' => 'DescribeKeywordsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeOptOutLists' => [ 'name' => 'DescribeOptOutLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptOutListsRequest', ], 'output' => [ 'shape' => 'DescribeOptOutListsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeOptedOutNumbers' => [ 'name' => 'DescribeOptedOutNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptedOutNumbersRequest', ], 'output' => [ 'shape' => 'DescribeOptedOutNumbersResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribePhoneNumbers' => [ 'name' => 'DescribePhoneNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePhoneNumbersRequest', ], 'output' => [ 'shape' => 'DescribePhoneNumbersResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribePools' => [ 'name' => 'DescribePools', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePoolsRequest', ], 'output' => [ 'shape' => 'DescribePoolsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationAttachments' => [ 'name' => 'DescribeRegistrationAttachments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationAttachmentsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationAttachmentsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationFieldDefinitions' => [ 'name' => 'DescribeRegistrationFieldDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationFieldDefinitionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationFieldDefinitionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationFieldValues' => [ 'name' => 'DescribeRegistrationFieldValues', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationFieldValuesRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationFieldValuesResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationSectionDefinitions' => [ 'name' => 'DescribeRegistrationSectionDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationSectionDefinitionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationSectionDefinitionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationTypeDefinitions' => [ 'name' => 'DescribeRegistrationTypeDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationTypeDefinitionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationTypeDefinitionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationVersions' => [ 'name' => 'DescribeRegistrationVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationVersionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationVersionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrations' => [ 'name' => 'DescribeRegistrations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeSenderIds' => [ 'name' => 'DescribeSenderIds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSenderIdsRequest', ], 'output' => [ 'shape' => 'DescribeSenderIdsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeSpendLimits' => [ 'name' => 'DescribeSpendLimits', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpendLimitsRequest', ], 'output' => [ 'shape' => 'DescribeSpendLimitsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeVerifiedDestinationNumbers' => [ 'name' => 'DescribeVerifiedDestinationNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVerifiedDestinationNumbersRequest', ], 'output' => [ 'shape' => 'DescribeVerifiedDestinationNumbersResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DisassociateOriginationIdentity' => [ 'name' => 'DisassociateOriginationIdentity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateOriginationIdentityRequest', ], 'output' => [ 'shape' => 'DisassociateOriginationIdentityResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DiscardRegistrationVersion' => [ 'name' => 'DiscardRegistrationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscardRegistrationVersionRequest', ], 'output' => [ 'shape' => 'DiscardRegistrationVersionResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListPoolOriginationIdentities' => [ 'name' => 'ListPoolOriginationIdentities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPoolOriginationIdentitiesRequest', ], 'output' => [ 'shape' => 'ListPoolOriginationIdentitiesResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListRegistrationAssociations' => [ 'name' => 'ListRegistrationAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRegistrationAssociationsRequest', ], 'output' => [ 'shape' => 'ListRegistrationAssociationsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'PutKeyword' => [ 'name' => 'PutKeyword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutKeywordRequest', ], 'output' => [ 'shape' => 'PutKeywordResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'PutOptedOutNumber' => [ 'name' => 'PutOptedOutNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutOptedOutNumberRequest', ], 'output' => [ 'shape' => 'PutOptedOutNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'PutRegistrationFieldValue' => [ 'name' => 'PutRegistrationFieldValue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRegistrationFieldValueRequest', ], 'output' => [ 'shape' => 'PutRegistrationFieldValueResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ReleasePhoneNumber' => [ 'name' => 'ReleasePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleasePhoneNumberRequest', ], 'output' => [ 'shape' => 'ReleasePhoneNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ReleaseSenderId' => [ 'name' => 'ReleaseSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleaseSenderIdRequest', ], 'output' => [ 'shape' => 'ReleaseSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'RequestPhoneNumber' => [ 'name' => 'RequestPhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RequestPhoneNumberRequest', ], 'output' => [ 'shape' => 'RequestPhoneNumberResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'RequestSenderId' => [ 'name' => 'RequestSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RequestSenderIdRequest', ], 'output' => [ 'shape' => 'RequestSenderIdResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendDestinationNumberVerificationCode' => [ 'name' => 'SendDestinationNumberVerificationCode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendDestinationNumberVerificationCodeRequest', ], 'output' => [ 'shape' => 'SendDestinationNumberVerificationCodeResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendTextMessage' => [ 'name' => 'SendTextMessage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTextMessageRequest', ], 'output' => [ 'shape' => 'SendTextMessageResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendVoiceMessage' => [ 'name' => 'SendVoiceMessage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendVoiceMessageRequest', ], 'output' => [ 'shape' => 'SendVoiceMessageResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetDefaultMessageType' => [ 'name' => 'SetDefaultMessageType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetDefaultMessageTypeRequest', ], 'output' => [ 'shape' => 'SetDefaultMessageTypeResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetDefaultSenderId' => [ 'name' => 'SetDefaultSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetDefaultSenderIdRequest', ], 'output' => [ 'shape' => 'SetDefaultSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetTextMessageSpendLimitOverride' => [ 'name' => 'SetTextMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetTextMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'SetTextMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetVoiceMessageSpendLimitOverride' => [ 'name' => 'SetVoiceMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetVoiceMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'SetVoiceMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SubmitRegistrationVersion' => [ 'name' => 'SubmitRegistrationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitRegistrationVersionRequest', ], 'output' => [ 'shape' => 'SubmitRegistrationVersionResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateEventDestination' => [ 'name' => 'UpdateEventDestination', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEventDestinationRequest', ], 'output' => [ 'shape' => 'UpdateEventDestinationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdatePhoneNumber' => [ 'name' => 'UpdatePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'UpdatePhoneNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdatePool' => [ 'name' => 'UpdatePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePoolRequest', ], 'output' => [ 'shape' => 'UpdatePoolResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateSenderId' => [ 'name' => 'UpdateSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSenderIdRequest', ], 'output' => [ 'shape' => 'UpdateSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'VerifyDestinationNumber' => [ 'name' => 'VerifyDestinationNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'VerifyDestinationNumberRequest', ], 'output' => [ 'shape' => 'VerifyDestinationNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'AccessDeniedExceptionReason', ], ], 'exception' => true, ], 'AccessDeniedExceptionReason' => [ 'type' => 'string', 'enum' => [ 'INSUFFICIENT_ACCOUNT_REPUTATION', 'ACCOUNT_DISABLED', ], ], 'AccountAttribute' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'AccountAttributeName', ], 'Value' => [ 'shape' => 'String', ], ], ], 'AccountAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountAttribute', ], ], 'AccountAttributeName' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT_TIER', ], ], 'AccountLimit' => [ 'type' => 'structure', 'required' => [ 'Name', 'Used', 'Max', ], 'members' => [ 'Name' => [ 'shape' => 'AccountLimitName', ], 'Used' => [ 'shape' => 'PrimitiveLong', ], 'Max' => [ 'shape' => 'PrimitiveLong', ], ], ], 'AccountLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountLimit', ], ], 'AccountLimitName' => [ 'type' => 'string', 'enum' => [ 'PHONE_NUMBERS', 'POOLS', 'CONFIGURATION_SETS', 'OPT_OUT_LISTS', 'SENDER_IDS', 'REGISTRATIONS', 'REGISTRATION_ATTACHMENTS', 'VERIFIED_DESTINATION_NUMBERS', ], ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 256, 'min' => 20, 'pattern' => 'arn:[A-Za-z0-9_:/-]+', ], 'AssociateOriginationIdentityRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', 'OriginationIdentity', 'IsoCountryCode', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'OriginationIdentity' => [ 'shape' => 'PhoneOrSenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'AssociateOriginationIdentityResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'AttachmentBody' => [ 'type' => 'blob', 'max' => 1572864, 'min' => 1, ], 'AttachmentStatus' => [ 'type' => 'string', 'enum' => [ 'UPLOAD_IN_PROGRESS', 'UPLOAD_COMPLETE', 'UPLOAD_FAILED', 'DELETED', ], ], 'AttachmentUploadErrorReason' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', ], ], 'AttachmentUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '\\S+', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[!-~]+', ], 'CloudWatchLogsDestination' => [ 'type' => 'structure', 'required' => [ 'IamRoleArn', 'LogGroupArn', ], 'members' => [ 'IamRoleArn' => [ 'shape' => 'IamRoleArn', ], 'LogGroupArn' => [ 'shape' => 'LogGroupArn', ], ], ], 'ConfigurationSetFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ConfigurationSetFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'ConfigurationSetFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationSetFilter', ], 'max' => 20, 'min' => 0, ], 'ConfigurationSetFilterName' => [ 'type' => 'string', 'enum' => [ 'event-destination-name', 'matching-event-types', 'default-message-type', 'default-sender-id', ], ], 'ConfigurationSetInformation' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetArn', 'ConfigurationSetName', 'EventDestinations', 'CreatedTimestamp', ], 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestinations' => [ 'shape' => 'EventDestinationList', ], 'DefaultMessageType' => [ 'shape' => 'MessageType', ], 'DefaultSenderId' => [ 'shape' => 'SenderId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ConfigurationSetInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationSetInformation', ], ], 'ConfigurationSetName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'ConfigurationSetNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'max' => 5, 'min' => 0, ], 'ConfigurationSetNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'ConflictExceptionReason', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceId' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ConflictExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CREATE_REGISTRATION_VERSION_NOT_ALLOWED', 'DELETION_PROTECTION_ENABLED', 'DESTINATION_PHONE_NUMBER_NOT_VERIFIED', 'DESTINATION_PHONE_NUMBER_OPTED_OUT', 'DISASSOCIATE_REGISTRATION_NOT_ALLOWED', 'DISCARD_REGISTRATION_VERSION_NOT_ALLOWED', 'EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED', 'EVENT_DESTINATION_MISMATCH', 'KEYWORD_MISMATCH', 'LAST_PHONE_NUMBER', 'NUMBER_CAPABILITIES_MISMATCH', 'MESSAGE_TYPE_MISMATCH', 'NO_ORIGINATION_IDENTITIES_FOUND', 'OPT_OUT_LIST_MISMATCH', 'PHONE_NUMBER_ASSOCIATED_TO_POOL', 'PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION', 'PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL', 'PHONE_NUMBER_NOT_IN_REGISTRATION_REGION', 'REGISTRATION_ALREADY_SUBMITTED', 'REGISTRATION_NOT_COMPLETE', 'SENDER_ID_ASSOCIATED_TO_POOL', 'RESOURCE_ALREADY_EXISTS', 'RESOURCE_DELETION_NOT_ALLOWED', 'RESOURCE_MODIFICATION_NOT_ALLOWED', 'RESOURCE_NOT_ACTIVE', 'RESOURCE_NOT_EMPTY', 'SELF_MANAGED_OPT_OUTS_MISMATCH', 'SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED', 'TWO_WAY_CONFIG_MISMATCH', 'VERIFICATION_CODE_EXPIRED', 'VERIFICATION_ALREADY_COMPLETE', ], ], 'ContextKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '\\S+', ], 'ContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ContextKey', ], 'value' => [ 'shape' => 'ContextValue', ], 'max' => 5, 'min' => 0, ], 'ContextValue' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '(?!\\s)^[\\s\\S]+(? [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateConfigurationSetResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateEventDestinationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'EventDestinationName', 'MatchingEventTypes', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], 'MatchingEventTypes' => [ 'shape' => 'EventTypeList', ], 'CloudWatchLogsDestination' => [ 'shape' => 'CloudWatchLogsDestination', ], 'KinesisFirehoseDestination' => [ 'shape' => 'KinesisFirehoseDestination', ], 'SnsDestination' => [ 'shape' => 'SnsDestination', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateEventDestinationResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestination' => [ 'shape' => 'EventDestination', ], ], ], 'CreateOptOutListRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateOptOutListResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreatePoolRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', 'IsoCountryCode', 'MessageType', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrSenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreatePoolResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateRegistrationAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', 'ResourceId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'ResourceId' => [ 'shape' => 'ResourceIdOrArn', ], ], ], 'CreateRegistrationAssociationResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'ResourceArn', 'ResourceId', 'ResourceType', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'ResourceArn' => [ 'shape' => 'String', ], 'ResourceId' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'CreateRegistrationAttachmentRequest' => [ 'type' => 'structure', 'members' => [ 'AttachmentBody' => [ 'shape' => 'AttachmentBody', ], 'AttachmentUrl' => [ 'shape' => 'AttachmentUrl', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateRegistrationAttachmentResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentArn', 'RegistrationAttachmentId', 'AttachmentStatus', 'CreatedTimestamp', ], 'members' => [ 'RegistrationAttachmentArn' => [ 'shape' => 'String', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], 'AttachmentStatus' => [ 'shape' => 'AttachmentStatus', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateRegistrationResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationStatus', 'CurrentVersionNumber', 'CreatedTimestamp', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationStatus' => [ 'shape' => 'RegistrationStatus', ], 'CurrentVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'AdditionalAttributes' => [ 'shape' => 'StringMap', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateRegistrationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'CreateRegistrationVersionResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], ], ], 'CreateVerifiedDestinationNumberRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateVerifiedDestinationNumberResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'Status', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'VerificationStatus', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteConfigurationSetRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DeleteConfigurationSetResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestinations' => [ 'shape' => 'EventDestinationList', ], 'DefaultMessageType' => [ 'shape' => 'MessageType', ], 'DefaultSenderId' => [ 'shape' => 'SenderId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteDefaultMessageTypeRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DeleteDefaultMessageTypeResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'MessageType' => [ 'shape' => 'MessageType', ], ], ], 'DeleteDefaultSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DeleteDefaultSenderIdResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'SenderId' => [ 'shape' => 'SenderId', ], ], ], 'DeleteEventDestinationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'EventDestinationName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], ], ], 'DeleteEventDestinationResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestination' => [ 'shape' => 'EventDestination', ], ], ], 'DeleteKeywordRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', 'Keyword', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrPoolIdOrArn', ], 'Keyword' => [ 'shape' => 'Keyword', ], ], ], 'DeleteKeywordResult' => [ 'type' => 'structure', 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'DeleteOptOutListRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], ], ], 'DeleteOptOutListResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteOptedOutNumberRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', 'OptedOutNumber', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'DeleteOptedOutNumberResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], 'OptedOutTimestamp' => [ 'shape' => 'Timestamp', ], 'EndUserOptedOut' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'DeletePoolRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], ], ], 'DeletePoolResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteRegistrationAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentId', ], 'members' => [ 'RegistrationAttachmentId' => [ 'shape' => 'RegistrationAttachmentIdOrArn', ], ], ], 'DeleteRegistrationAttachmentResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentArn', 'RegistrationAttachmentId', 'AttachmentStatus', 'CreatedTimestamp', ], 'members' => [ 'RegistrationAttachmentArn' => [ 'shape' => 'String', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], 'AttachmentStatus' => [ 'shape' => 'AttachmentStatus', ], 'AttachmentUploadErrorReason' => [ 'shape' => 'AttachmentUploadErrorReason', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteRegistrationFieldValueRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', 'FieldPath', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], ], ], 'DeleteRegistrationFieldValueResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'FieldPath', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], ], ], 'DeleteRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'DeleteRegistrationResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationStatus', 'CurrentVersionNumber', 'CreatedTimestamp', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationStatus' => [ 'shape' => 'RegistrationStatus', ], 'CurrentVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'ApprovedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'LatestDeniedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'AdditionalAttributes' => [ 'shape' => 'StringMap', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteTextMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTextMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'DeleteVerifiedDestinationNumberRequest' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberId', ], 'members' => [ 'VerifiedDestinationNumberId' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], ], ], 'DeleteVerifiedDestinationNumberResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteVoiceMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVoiceMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'DeliveryStreamArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'DescribeAccountAttributesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeAccountAttributesResult' => [ 'type' => 'structure', 'members' => [ 'AccountAttributes' => [ 'shape' => 'AccountAttributeList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAccountLimitsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeAccountLimitsResult' => [ 'type' => 'structure', 'members' => [ 'AccountLimits' => [ 'shape' => 'AccountLimitList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConfigurationSetsRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetNames' => [ 'shape' => 'ConfigurationSetNameList', ], 'Filters' => [ 'shape' => 'ConfigurationSetFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeConfigurationSetsResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSets' => [ 'shape' => 'ConfigurationSetInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeKeywordsRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrPoolIdOrArn', ], 'Keywords' => [ 'shape' => 'KeywordList', ], 'Filters' => [ 'shape' => 'KeywordFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeKeywordsResult' => [ 'type' => 'structure', 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'Keywords' => [ 'shape' => 'KeywordInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOptOutListsRequest' => [ 'type' => 'structure', 'members' => [ 'OptOutListNames' => [ 'shape' => 'OptOutListNameList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeOptOutListsResult' => [ 'type' => 'structure', 'members' => [ 'OptOutLists' => [ 'shape' => 'OptOutListInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOptedOutNumbersRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'OptedOutNumbers' => [ 'shape' => 'OptedOutNumberList', ], 'Filters' => [ 'shape' => 'OptedOutFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeOptedOutNumbersResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'OptedOutNumbers' => [ 'shape' => 'OptedOutNumberInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePhoneNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberIds' => [ 'shape' => 'PhoneNumberIdList', ], 'Filters' => [ 'shape' => 'PhoneNumberFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribePhoneNumbersResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumbers' => [ 'shape' => 'PhoneNumberInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePoolsRequest' => [ 'type' => 'structure', 'members' => [ 'PoolIds' => [ 'shape' => 'PoolIdList', ], 'Filters' => [ 'shape' => 'PoolFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribePoolsResult' => [ 'type' => 'structure', 'members' => [ 'Pools' => [ 'shape' => 'PoolInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationAttachmentsRequest' => [ 'type' => 'structure', 'members' => [ 'RegistrationAttachmentIds' => [ 'shape' => 'RegistrationAttachmentIdList', ], 'Filters' => [ 'shape' => 'RegistrationAttachmentFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationAttachmentsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachments', ], 'members' => [ 'RegistrationAttachments' => [ 'shape' => 'RegistrationAttachmentsInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationFieldDefinitionsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'SectionPath' => [ 'shape' => 'SectionPath', ], 'FieldPaths' => [ 'shape' => 'FieldPathList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationFieldDefinitionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', 'RegistrationFieldDefinitions', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationFieldDefinitions' => [ 'shape' => 'RegistrationFieldDefinitionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationFieldValuesRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'SectionPath' => [ 'shape' => 'SectionPath', ], 'FieldPaths' => [ 'shape' => 'FieldPathList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationFieldValuesResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationFieldValues', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationFieldValues' => [ 'shape' => 'RegistrationFieldValueInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationSectionDefinitionsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'SectionPaths' => [ 'shape' => 'SectionPathList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationSectionDefinitionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', 'RegistrationSectionDefinitions', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationSectionDefinitions' => [ 'shape' => 'RegistrationSectionDefinitionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationTypeDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'RegistrationTypes' => [ 'shape' => 'RegistrationTypeList', ], 'Filters' => [ 'shape' => 'RegistrationTypeFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationTypeDefinitionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationTypeDefinitions', ], 'members' => [ 'RegistrationTypeDefinitions' => [ 'shape' => 'RegistrationTypeDefinitionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'VersionNumbers' => [ 'shape' => 'RegistrationVersionNumberList', ], 'Filters' => [ 'shape' => 'RegistrationVersionFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationVersionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationVersions', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationVersions' => [ 'shape' => 'RegistrationVersionInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationsRequest' => [ 'type' => 'structure', 'members' => [ 'RegistrationIds' => [ 'shape' => 'RegistrationIdList', ], 'Filters' => [ 'shape' => 'RegistrationFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationsResult' => [ 'type' => 'structure', 'required' => [ 'Registrations', ], 'members' => [ 'Registrations' => [ 'shape' => 'RegistrationInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeSenderIdsRequest' => [ 'type' => 'structure', 'members' => [ 'SenderIds' => [ 'shape' => 'SenderIdList', ], 'Filters' => [ 'shape' => 'SenderIdFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeSenderIdsResult' => [ 'type' => 'structure', 'members' => [ 'SenderIds' => [ 'shape' => 'SenderIdInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeSpendLimitsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeSpendLimitsResult' => [ 'type' => 'structure', 'members' => [ 'SpendLimits' => [ 'shape' => 'SpendLimitList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeVerifiedDestinationNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'VerifiedDestinationNumberIds' => [ 'shape' => 'VerifiedDestinationNumberIdList', ], 'DestinationPhoneNumbers' => [ 'shape' => 'DestinationPhoneNumberList', ], 'Filters' => [ 'shape' => 'VerifiedDestinationNumberFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeVerifiedDestinationNumbersResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumbers', ], 'members' => [ 'VerifiedDestinationNumbers' => [ 'shape' => 'VerifiedDestinationNumberInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DestinationCountryParameterKey' => [ 'type' => 'string', 'enum' => [ 'IN_TEMPLATE_ID', 'IN_ENTITY_ID', ], ], 'DestinationCountryParameterValue' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '\\S+', ], 'DestinationCountryParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'DestinationCountryParameterKey', ], 'value' => [ 'shape' => 'DestinationCountryParameterValue', ], 'max' => 10, 'min' => 0, ], 'DestinationPhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumber', ], 'max' => 5, 'min' => 0, ], 'DisassociateOriginationIdentityRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', 'OriginationIdentity', 'IsoCountryCode', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'OriginationIdentity' => [ 'shape' => 'PhoneOrSenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'DisassociateOriginationIdentityResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'DiscardRegistrationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'DiscardRegistrationVersionResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], ], ], 'EventDestination' => [ 'type' => 'structure', 'required' => [ 'EventDestinationName', 'Enabled', 'MatchingEventTypes', ], 'members' => [ 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'MatchingEventTypes' => [ 'shape' => 'EventTypeList', ], 'CloudWatchLogsDestination' => [ 'shape' => 'CloudWatchLogsDestination', ], 'KinesisFirehoseDestination' => [ 'shape' => 'KinesisFirehoseDestination', ], 'SnsDestination' => [ 'shape' => 'SnsDestination', ], ], ], 'EventDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventDestination', ], ], 'EventDestinationName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'EventType' => [ 'type' => 'string', 'enum' => [ 'ALL', 'TEXT_ALL', 'TEXT_SENT', 'TEXT_PENDING', 'TEXT_QUEUED', 'TEXT_SUCCESSFUL', 'TEXT_DELIVERED', 'TEXT_INVALID', 'TEXT_INVALID_MESSAGE', 'TEXT_UNREACHABLE', 'TEXT_CARRIER_UNREACHABLE', 'TEXT_BLOCKED', 'TEXT_CARRIER_BLOCKED', 'TEXT_SPAM', 'TEXT_UNKNOWN', 'TEXT_TTL_EXPIRED', 'VOICE_ALL', 'VOICE_INITIATED', 'VOICE_RINGING', 'VOICE_ANSWERED', 'VOICE_COMPLETED', 'VOICE_BUSY', 'VOICE_NO_ANSWER', 'VOICE_FAILED', 'VOICE_TTL_EXPIRED', ], ], 'EventTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventType', ], 'max' => 25, 'min' => 1, ], 'FieldPath' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[A-Za-z0-9_\\.]+', ], 'FieldPathList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldPath', ], 'max' => 5, 'min' => 0, ], 'FieldRequirement' => [ 'type' => 'string', 'enum' => [ 'REQUIRED', 'CONDITIONAL', 'OPTIONAL', ], ], 'FieldType' => [ 'type' => 'string', 'enum' => [ 'SELECT', 'TEXT', 'ATTACHMENT', ], ], 'FilterValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[\\.:A-Za-z0-9_-]+', ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], 'max' => 20, 'min' => 1, ], 'IamRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'IsoCountryCode' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Z]{2}', ], 'Keyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[ \\S]+', ], 'KeywordAction' => [ 'type' => 'string', 'enum' => [ 'AUTOMATIC_RESPONSE', 'OPT_OUT', 'OPT_IN', ], ], 'KeywordFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'KeywordFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'KeywordFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeywordFilter', ], 'max' => 20, 'min' => 0, ], 'KeywordFilterName' => [ 'type' => 'string', 'enum' => [ 'keyword-action', ], ], 'KeywordInformation' => [ 'type' => 'structure', 'required' => [ 'Keyword', 'KeywordMessage', 'KeywordAction', ], 'members' => [ 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'KeywordInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeywordInformation', ], ], 'KeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Keyword', ], 'max' => 5, 'min' => 0, ], 'KeywordMessage' => [ 'type' => 'string', 'max' => 1600, 'min' => 1, 'pattern' => '(?!\\s*$)[\\s\\S]+', ], 'KinesisFirehoseDestination' => [ 'type' => 'structure', 'required' => [ 'IamRoleArn', 'DeliveryStreamArn', ], 'members' => [ 'IamRoleArn' => [ 'shape' => 'IamRoleArn', ], 'DeliveryStreamArn' => [ 'shape' => 'DeliveryStreamArn', ], ], ], 'LanguageCode' => [ 'type' => 'string', 'enum' => [ 'DE_DE', 'EN_GB', 'EN_US', 'ES_419', 'ES_ES', 'FR_CA', 'FR_FR', 'IT_IT', 'JA_JP', 'KO_KR', 'PT_BR', 'ZH_CN', 'ZH_TW', ], ], 'ListPoolOriginationIdentitiesRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'Filters' => [ 'shape' => 'PoolOriginationIdentitiesFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPoolOriginationIdentitiesResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'OriginationIdentities' => [ 'shape' => 'OriginationIdentityMetadataList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRegistrationAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'Filters' => [ 'shape' => 'RegistrationAssociationFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListRegistrationAssociationsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationAssociations', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationAssociations' => [ 'shape' => 'RegistrationAssociationMetadataList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'ListTagsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'LogGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'MaxPrice' => [ 'type' => 'string', 'max' => 8, 'min' => 2, 'pattern' => '[0-9]{0,2}\\.[0-9]{1,5}', ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MessageType' => [ 'type' => 'string', 'enum' => [ 'TRANSACTIONAL', 'PROMOTIONAL', ], ], 'MessageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MessageType', ], 'max' => 2, 'min' => 0, ], 'MonthlyLimit' => [ 'type' => 'long', 'box' => true, 'max' => 1000000000, 'min' => 0, ], 'NextToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'NonEmptyTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 1, ], 'NumberCapability' => [ 'type' => 'string', 'enum' => [ 'SMS', 'VOICE', ], ], 'NumberCapabilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NumberCapability', ], 'max' => 2, 'min' => 1, ], 'NumberStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ACTIVE', 'ASSOCIATING', 'DISASSOCIATING', 'DELETED', ], ], 'NumberType' => [ 'type' => 'string', 'enum' => [ 'SHORT_CODE', 'LONG_CODE', 'TOLL_FREE', 'TEN_DLC', 'SIMULATOR', ], ], 'OptOutListInformation' => [ 'type' => 'structure', 'required' => [ 'OptOutListArn', 'OptOutListName', 'CreatedTimestamp', ], 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'OptOutListInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptOutListInformation', ], ], 'OptOutListName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'OptOutListNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptOutListNameOrArn', ], 'max' => 5, 'min' => 0, ], 'OptOutListNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'OptedOutFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'OptedOutFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'OptedOutFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptedOutFilter', ], 'max' => 20, 'min' => 0, ], 'OptedOutFilterName' => [ 'type' => 'string', 'enum' => [ 'end-user-opted-out', ], ], 'OptedOutNumberInformation' => [ 'type' => 'structure', 'required' => [ 'OptedOutNumber', 'OptedOutTimestamp', 'EndUserOptedOut', ], 'members' => [ 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], 'OptedOutTimestamp' => [ 'shape' => 'Timestamp', ], 'EndUserOptedOut' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'OptedOutNumberInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptedOutNumberInformation', ], ], 'OptedOutNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumber', ], 'max' => 5, 'min' => 0, ], 'OriginationIdentityMetadata' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentityArn', 'OriginationIdentity', 'IsoCountryCode', 'NumberCapabilities', ], 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'OriginationIdentityMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OriginationIdentityMetadata', ], ], 'PhoneNumber' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '\\+?[1-9][0-9]{1,18}', ], 'PhoneNumberFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'PhoneNumberFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'PhoneNumberFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberFilter', ], 'max' => 20, 'min' => 0, ], 'PhoneNumberFilterName' => [ 'type' => 'string', 'enum' => [ 'status', 'iso-country-code', 'message-type', 'number-capability', 'number-type', 'two-way-enabled', 'self-managed-opt-outs-enabled', 'opt-out-list-name', 'deletion-protection-enabled', 'two-way-channel-arn', ], ], 'PhoneNumberIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberIdOrArn', ], 'max' => 5, 'min' => 0, ], 'PhoneNumberIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PhoneNumberInformation' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberArn', 'PhoneNumber', 'Status', 'IsoCountryCode', 'MessageType', 'NumberCapabilities', 'NumberType', 'MonthlyLeasingPrice', 'TwoWayEnabled', 'SelfManagedOptOutsEnabled', 'OptOutListName', 'DeletionProtectionEnabled', 'CreatedTimestamp', ], 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'NumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'PoolId' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'PhoneNumberInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberInformation', ], ], 'PhoneOrPoolIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PhoneOrSenderIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PoolFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'PoolFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'PoolFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolFilter', ], 'max' => 20, 'min' => 0, ], 'PoolFilterName' => [ 'type' => 'string', 'enum' => [ 'status', 'message-type', 'two-way-enabled', 'self-managed-opt-outs-enabled', 'opt-out-list-name', 'shared-routes-enabled', 'deletion-protection-enabled', 'two-way-channel-arn', ], ], 'PoolIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolIdOrArn', ], 'max' => 5, 'min' => 0, ], 'PoolIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PoolInformation' => [ 'type' => 'structure', 'required' => [ 'PoolArn', 'PoolId', 'Status', 'MessageType', 'TwoWayEnabled', 'SelfManagedOptOutsEnabled', 'OptOutListName', 'SharedRoutesEnabled', 'DeletionProtectionEnabled', 'CreatedTimestamp', ], 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'PoolInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolInformation', ], ], 'PoolOriginationIdentitiesFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'PoolOriginationIdentitiesFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'PoolOriginationIdentitiesFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolOriginationIdentitiesFilter', ], 'max' => 20, 'min' => 0, ], 'PoolOriginationIdentitiesFilterName' => [ 'type' => 'string', 'enum' => [ 'iso-country-code', 'number-capability', ], ], 'PoolStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', ], ], 'PrimitiveBoolean' => [ 'type' => 'boolean', ], 'PrimitiveLong' => [ 'type' => 'long', ], 'PutKeywordRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', 'Keyword', 'KeywordMessage', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrPoolIdOrArn', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'PutKeywordResult' => [ 'type' => 'structure', 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'PutOptedOutNumberRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', 'OptedOutNumber', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'PutOptedOutNumberResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], 'OptedOutTimestamp' => [ 'shape' => 'Timestamp', ], 'EndUserOptedOut' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'PutRegistrationFieldValueRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', 'FieldPath', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'RegistrationAttachmentIdOrArn', ], ], ], 'PutRegistrationFieldValueResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'FieldPath', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], ], ], 'RegistrationAssociationBehavior' => [ 'type' => 'string', 'enum' => [ 'ASSOCIATE_BEFORE_SUBMIT', 'ASSOCIATE_ON_APPROVAL', 'ASSOCIATE_AFTER_COMPLETE', ], ], 'RegistrationAssociationFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationAssociationFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationAssociationFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAssociationFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationAssociationFilterName' => [ 'type' => 'string', 'enum' => [ 'resource-type', 'iso-country-code', ], ], 'RegistrationAssociationMetadata' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'ResourceId', 'ResourceType', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'ResourceId' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'RegistrationAssociationMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAssociationMetadata', ], ], 'RegistrationAttachmentFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationAttachmentFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationAttachmentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAttachmentFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationAttachmentFilterName' => [ 'type' => 'string', 'enum' => [ 'attachment-status', ], ], 'RegistrationAttachmentIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationIdOrArn', ], 'max' => 5, 'min' => 0, ], 'RegistrationAttachmentIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'RegistrationAttachmentsInformation' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentArn', 'RegistrationAttachmentId', 'AttachmentStatus', 'CreatedTimestamp', ], 'members' => [ 'RegistrationAttachmentArn' => [ 'shape' => 'String', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], 'AttachmentStatus' => [ 'shape' => 'AttachmentStatus', ], 'AttachmentUploadErrorReason' => [ 'shape' => 'AttachmentUploadErrorReason', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RegistrationAttachmentsInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAttachmentsInformation', ], ], 'RegistrationDeniedReasonInformation' => [ 'type' => 'structure', 'required' => [ 'Reason', 'ShortDescription', ], 'members' => [ 'Reason' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], ], ], 'RegistrationDeniedReasonInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationDeniedReasonInformation', ], ], 'RegistrationDisassociationBehavior' => [ 'type' => 'string', 'enum' => [ 'DISASSOCIATE_ALL_CLOSES_REGISTRATION', 'DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION', 'DELETE_REGISTRATION_DISASSOCIATES', ], ], 'RegistrationFieldDefinition' => [ 'type' => 'structure', 'required' => [ 'SectionPath', 'FieldPath', 'FieldType', 'FieldRequirement', 'DisplayHints', ], 'members' => [ 'SectionPath' => [ 'shape' => 'SectionPath', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'FieldType' => [ 'shape' => 'FieldType', ], 'FieldRequirement' => [ 'shape' => 'FieldRequirement', ], 'SelectValidation' => [ 'shape' => 'SelectValidation', ], 'TextValidation' => [ 'shape' => 'TextValidation', ], 'DisplayHints' => [ 'shape' => 'RegistrationFieldDisplayHints', ], ], ], 'RegistrationFieldDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationFieldDefinition', ], ], 'RegistrationFieldDisplayHints' => [ 'type' => 'structure', 'required' => [ 'Title', 'ShortDescription', ], 'members' => [ 'Title' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], 'SelectOptionDescriptions' => [ 'shape' => 'SelectOptionDescriptionsList', ], 'TextValidationDescription' => [ 'shape' => 'String', ], 'ExampleTextValue' => [ 'shape' => 'String', ], ], ], 'RegistrationFieldValueInformation' => [ 'type' => 'structure', 'required' => [ 'FieldPath', ], 'members' => [ 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'RegistrationAttachmentIdOrArn', ], 'DeniedReason' => [ 'shape' => 'String', ], ], ], 'RegistrationFieldValueInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationFieldValueInformation', ], ], 'RegistrationFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationFilterName' => [ 'type' => 'string', 'enum' => [ 'registration-type', 'registration-status', ], ], 'RegistrationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationIdOrArn', ], 'max' => 5, 'min' => 0, ], 'RegistrationIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'RegistrationInformation' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationStatus', 'CurrentVersionNumber', 'CreatedTimestamp', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationStatus' => [ 'shape' => 'RegistrationStatus', ], 'CurrentVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'ApprovedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'LatestDeniedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'AdditionalAttributes' => [ 'shape' => 'StringMap', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RegistrationInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationInformation', ], ], 'RegistrationSectionDefinition' => [ 'type' => 'structure', 'required' => [ 'SectionPath', 'DisplayHints', ], 'members' => [ 'SectionPath' => [ 'shape' => 'SectionPath', ], 'DisplayHints' => [ 'shape' => 'RegistrationSectionDisplayHints', ], ], ], 'RegistrationSectionDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationSectionDefinition', ], ], 'RegistrationSectionDisplayHints' => [ 'type' => 'structure', 'required' => [ 'Title', 'ShortDescription', ], 'members' => [ 'Title' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], ], ], 'RegistrationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATED', 'SUBMITTED', 'REVIEWING', 'PROVISIONING', 'COMPLETE', 'REQUIRES_UPDATES', 'CLOSED', 'DELETED', ], ], 'RegistrationType' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_]+', ], 'RegistrationTypeDefinition' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', 'DisplayHints', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'SupportedAssociations' => [ 'shape' => 'SupportedAssociationList', ], 'DisplayHints' => [ 'shape' => 'RegistrationTypeDisplayHints', ], ], ], 'RegistrationTypeDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationTypeDefinition', ], ], 'RegistrationTypeDisplayHints' => [ 'type' => 'structure', 'required' => [ 'Title', ], 'members' => [ 'Title' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], ], ], 'RegistrationTypeFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationTypeFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationTypeFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationTypeFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationTypeFilterName' => [ 'type' => 'string', 'enum' => [ 'supported-association-resource-type', 'supported-association-iso-country-code', ], ], 'RegistrationTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationType', ], 'max' => 5, 'min' => 0, ], 'RegistrationVersionFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationVersionFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationVersionFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationVersionFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationVersionFilterName' => [ 'type' => 'string', 'enum' => [ 'registration-version-status', ], ], 'RegistrationVersionInformation' => [ 'type' => 'structure', 'required' => [ 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], 'DeniedReasons' => [ 'shape' => 'RegistrationDeniedReasonInformationList', ], ], ], 'RegistrationVersionInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationVersionInformation', ], ], 'RegistrationVersionNumber' => [ 'type' => 'long', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RegistrationVersionNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationVersionNumber', ], 'max' => 5, 'min' => 0, ], 'RegistrationVersionStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'SUBMITTED', 'REVIEWING', 'APPROVED', 'DISCARDED', 'DENIED', 'REVOKED', 'ARCHIVED', ], ], 'RegistrationVersionStatusHistory' => [ 'type' => 'structure', 'required' => [ 'DraftTimestamp', ], 'members' => [ 'DraftTimestamp' => [ 'shape' => 'Timestamp', ], 'SubmittedTimestamp' => [ 'shape' => 'Timestamp', ], 'ReviewingTimestamp' => [ 'shape' => 'Timestamp', ], 'ApprovedTimestamp' => [ 'shape' => 'Timestamp', ], 'DiscardedTimestamp' => [ 'shape' => 'Timestamp', ], 'DeniedTimestamp' => [ 'shape' => 'Timestamp', ], 'RevokedTimestamp' => [ 'shape' => 'Timestamp', ], 'ArchivedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ReleasePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberIdOrArn', ], ], ], 'ReleasePhoneNumberResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'NumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'RegistrationId' => [ 'shape' => 'String', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ReleaseSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'ReleaseSenderIdResult' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], ], ], 'RequestPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'IsoCountryCode', 'MessageType', 'NumberCapabilities', 'NumberType', ], 'members' => [ 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'RequestableNumberType', ], 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'RequestPhoneNumberResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'RequestableNumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'PoolId' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RequestSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'RequestSenderIdResult' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'DeletionProtectionEnabled', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RequestableNumberType' => [ 'type' => 'string', 'enum' => [ 'LONG_CODE', 'TOLL_FREE', 'TEN_DLC', 'SIMULATOR', ], ], 'ResourceIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceId' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'account', 'phone-number', 'sender-id', 'pool', 'configuration-set', 'opt-out-list', 'event-destination', 'keyword', 'opted-out-number', 'registration', 'registration-attachment', 'verified-destination-number', ], ], 'SectionPath' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[A-Za-z0-9_]+', ], 'SectionPathList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SectionPath', ], 'max' => 5, 'min' => 0, ], 'SelectChoice' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'SelectChoiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectChoice', ], 'max' => 100, 'min' => 0, ], 'SelectOptionDescription' => [ 'type' => 'structure', 'required' => [ 'Option', ], 'members' => [ 'Option' => [ 'shape' => 'String', ], 'Title' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], ], ], 'SelectOptionDescriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectOptionDescription', ], ], 'SelectValidation' => [ 'type' => 'structure', 'required' => [ 'MinChoices', 'MaxChoices', 'Options', ], 'members' => [ 'MinChoices' => [ 'shape' => 'Integer', ], 'MaxChoices' => [ 'shape' => 'Integer', ], 'Options' => [ 'shape' => 'StringList', ], ], ], 'SendDestinationNumberVerificationCodeRequest' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberId', 'VerificationChannel', ], 'members' => [ 'VerifiedDestinationNumberId' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], 'VerificationChannel' => [ 'shape' => 'VerificationChannel', ], 'LanguageCode' => [ 'shape' => 'LanguageCode', ], 'OriginationIdentity' => [ 'shape' => 'VerificationMessageOriginationIdentity', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DestinationCountryParameters' => [ 'shape' => 'DestinationCountryParameters', ], ], ], 'SendDestinationNumberVerificationCodeResult' => [ 'type' => 'structure', 'required' => [ 'MessageId', ], 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SendTextMessageRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'OriginationIdentity' => [ 'shape' => 'TextMessageOriginationIdentity', ], 'MessageBody' => [ 'shape' => 'TextMessageBody', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MaxPrice' => [ 'shape' => 'MaxPrice', ], 'TimeToLive' => [ 'shape' => 'TimeToLive', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DestinationCountryParameters' => [ 'shape' => 'DestinationCountryParameters', ], 'DryRun' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'SendTextMessageResult' => [ 'type' => 'structure', 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SendVoiceMessageRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', 'OriginationIdentity', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'OriginationIdentity' => [ 'shape' => 'VoiceMessageOriginationIdentity', ], 'MessageBody' => [ 'shape' => 'VoiceMessageBody', ], 'MessageBodyTextType' => [ 'shape' => 'VoiceMessageBodyTextType', ], 'VoiceId' => [ 'shape' => 'VoiceId', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MaxPricePerMinute' => [ 'shape' => 'MaxPrice', ], 'TimeToLive' => [ 'shape' => 'TimeToLive', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DryRun' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'SendVoiceMessageResult' => [ 'type' => 'structure', 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SenderId' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'SenderIdAndCountry' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'SenderIdFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'SenderIdFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'SenderIdFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SenderIdFilter', ], 'max' => 20, 'min' => 0, ], 'SenderIdFilterName' => [ 'type' => 'string', 'enum' => [ 'sender-id', 'iso-country-code', 'message-type', 'deletion-protection-enabled', 'registered', ], ], 'SenderIdInformation' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'DeletionProtectionEnabled', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], ], ], 'SenderIdInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SenderIdInformation', ], ], 'SenderIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SenderIdAndCountry', ], 'max' => 5, 'min' => 0, ], 'SenderIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'ServiceQuotaExceededExceptionReason', ], ], 'exception' => true, ], 'ServiceQuotaExceededExceptionReason' => [ 'type' => 'string', 'enum' => [ 'ASSOCIATIONS_PER_REGISTRATION', 'CONFIGURATION_SETS_PER_ACCOUNT', 'DAILY_DESTINATION_CALL_LIMIT', 'EVENT_DESTINATIONS_PER_CONFIGURATION_SET', 'KEYWORDS_PER_PHONE_NUMBER', 'KEYWORDS_PER_POOL', 'MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT', 'MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE', 'OPT_OUT_LISTS_PER_ACCOUNT', 'ORIGINATION_IDENTITIES_PER_POOL', 'PHONE_NUMBERS_PER_ACCOUNT', 'PHONE_NUMBERS_PER_REGISTRATION', 'POOLS_PER_ACCOUNT', 'REGISTRATION_ATTACHMENTS_CREATED_PER_DAY', 'REGISTRATION_ATTACHMENTS_PER_ACCOUNT', 'REGISTRATION_VERSIONS_CREATED_PER_DAY', 'REGISTRATIONS_PER_ACCOUNT', 'SENDER_IDS_PER_ACCOUNT', 'TAGS_PER_RESOURCE', 'VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT', 'VERIFICATION_ATTEMPTS_PER_DAY', ], ], 'SetDefaultMessageTypeRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'MessageType', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MessageType' => [ 'shape' => 'MessageType', ], ], ], 'SetDefaultMessageTypeResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'MessageType' => [ 'shape' => 'MessageType', ], ], ], 'SetDefaultSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'SenderId', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'SenderId' => [ 'shape' => 'SenderId', ], ], ], 'SetDefaultSenderIdResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'SenderId' => [ 'shape' => 'SenderId', ], ], ], 'SetTextMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'MonthlyLimit', ], 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetTextMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetVoiceMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'MonthlyLimit', ], 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetVoiceMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SnsDestination' => [ 'type' => 'structure', 'required' => [ 'TopicArn', ], 'members' => [ 'TopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'SpendLimit' => [ 'type' => 'structure', 'required' => [ 'Name', 'EnforcedLimit', 'MaxLimit', 'Overridden', ], 'members' => [ 'Name' => [ 'shape' => 'SpendLimitName', ], 'EnforcedLimit' => [ 'shape' => 'PrimitiveLong', ], 'MaxLimit' => [ 'shape' => 'PrimitiveLong', ], 'Overridden' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'SpendLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpendLimit', ], ], 'SpendLimitName' => [ 'type' => 'string', 'enum' => [ 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT', 'VOICE_MESSAGE_MONTHLY_SPEND_LIMIT', ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SubmitRegistrationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'SubmitRegistrationVersionResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], ], ], 'SupportedAssociation' => [ 'type' => 'structure', 'required' => [ 'ResourceType', 'AssociationBehavior', 'DisassociationBehavior', ], 'members' => [ 'ResourceType' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'AssociationBehavior' => [ 'shape' => 'RegistrationAssociationBehavior', ], 'DisassociationBehavior' => [ 'shape' => 'RegistrationDisassociationBehavior', ], ], ], 'SupportedAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedAssociation', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.+', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'NonEmptyTagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'TextMessageBody' => [ 'type' => 'string', 'max' => 1600, 'min' => 1, 'pattern' => '(?!\\s*$)[\\s\\S]+', ], 'TextMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], 'TextValidation' => [ 'type' => 'structure', 'required' => [ 'MinLength', 'MaxLength', 'Pattern', ], 'members' => [ 'MinLength' => [ 'shape' => 'Integer', ], 'MaxLength' => [ 'shape' => 'Integer', ], 'Pattern' => [ 'shape' => 'String', ], ], ], 'TextValue' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'TimeToLive' => [ 'type' => 'integer', 'box' => true, 'max' => 259200, 'min' => 5, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TwoWayChannelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '\\S+', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'UpdateEventDestinationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'EventDestinationName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'MatchingEventTypes' => [ 'shape' => 'EventTypeList', ], 'CloudWatchLogsDestination' => [ 'shape' => 'CloudWatchLogsDestination', ], 'KinesisFirehoseDestination' => [ 'shape' => 'KinesisFirehoseDestination', ], 'SnsDestination' => [ 'shape' => 'SnsDestination', ], ], ], 'UpdateEventDestinationResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestination' => [ 'shape' => 'EventDestination', ], ], ], 'UpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberIdOrArn', ], 'TwoWayEnabled' => [ 'shape' => 'Boolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'Boolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdatePhoneNumberResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'NumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'UpdatePoolRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'TwoWayEnabled' => [ 'shape' => 'Boolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'Boolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'SharedRoutesEnabled' => [ 'shape' => 'Boolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdatePoolResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdateSenderIdResult' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'DeletionProtectionEnabled', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'ValidationExceptionReason', ], 'Fields' => [ 'shape' => 'ValidationExceptionFieldList', ], ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'Name', 'Message', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CANNOT_ADD_OPTED_OUT_NUMBER', 'CANNOT_PARSE', 'COUNTRY_CODE_MISMATCH', 'DESTINATION_COUNTRY_BLOCKED', 'FIELD_VALIDATION_FAILED', 'ATTACHMENT_TYPE_NOT_SUPPORTED', 'INVALID_ARN', 'INVALID_FILTER_VALUES', 'INVALID_IDENTITY_FOR_DESTINATION_COUNTRY', 'INVALID_NEXT_TOKEN', 'INVALID_PARAMETER', 'INVALID_REQUEST', 'INVALID_REGISTRATION_ASSOCIATION', 'MAXIMUM_SIZE_EXCEEDED', 'MISSING_PARAMETER', 'PARAMETERS_CANNOT_BE_USED_TOGETHER', 'PHONE_NUMBER_CANNOT_BE_OPTED_IN', 'PHONE_NUMBER_CANNOT_BE_RELEASED', 'PRICE_OVER_THRESHOLD', 'RESOURCE_NOT_ACCESSIBLE', 'REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT', 'SENDER_ID_NOT_REGISTERED', 'SENDER_ID_NOT_SUPPORTED', 'SENDER_ID_REQUIRES_REGISTRATION', 'TWO_WAY_TOPIC_NOT_PRESENT', 'TWO_WAY_NOT_ENABLED', 'TWO_WAY_NOT_SUPPORTED_IN_COUNTRY', 'TWO_WAY_NOT_SUPPORTED_IN_REGION', 'TWO_WAY_CHANNEL_NOT_PRESENT', 'UNKNOWN_REGISTRATION_FIELD', 'UNKNOWN_REGISTRATION_SECTION', 'UNKNOWN_REGISTRATION_TYPE', 'UNKNOWN_REGISTRATION_VERSION', 'UNKNOWN_OPERATION', 'REGISTRATION_FIELD_CANNOT_BE_DELETED', 'VERIFICATION_CODE_MISMATCH', 'VOICE_CAPABILITY_NOT_AVAILABLE', 'OTHER', ], ], 'VerificationChannel' => [ 'type' => 'string', 'enum' => [ 'TEXT', 'VOICE', ], ], 'VerificationCode' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '[A-Za-z0-9]+', ], 'VerificationMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], 'VerificationStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'VERIFIED', ], ], 'VerifiedDestinationNumberFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'VerifiedDestinationNumberFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'VerifiedDestinationNumberFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedDestinationNumberFilter', ], 'max' => 20, 'min' => 0, ], 'VerifiedDestinationNumberFilterName' => [ 'type' => 'string', 'enum' => [ 'status', ], ], 'VerifiedDestinationNumberIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], 'max' => 5, 'min' => 0, ], 'VerifiedDestinationNumberIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'VerifiedDestinationNumberInformation' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'Status', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'VerificationStatus', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'VerifiedDestinationNumberInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedDestinationNumberInformation', ], ], 'VerifyDestinationNumberRequest' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberId', 'VerificationCode', ], 'members' => [ 'VerifiedDestinationNumberId' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], 'VerificationCode' => [ 'shape' => 'VerificationCode', ], ], ], 'VerifyDestinationNumberResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'Status', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'VerificationStatus', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'VoiceId' => [ 'type' => 'string', 'enum' => [ 'AMY', 'ASTRID', 'BIANCA', 'BRIAN', 'CAMILA', 'CARLA', 'CARMEN', 'CELINE', 'CHANTAL', 'CONCHITA', 'CRISTIANO', 'DORA', 'EMMA', 'ENRIQUE', 'EWA', 'FILIZ', 'GERAINT', 'GIORGIO', 'GWYNETH', 'HANS', 'INES', 'IVY', 'JACEK', 'JAN', 'JOANNA', 'JOEY', 'JUSTIN', 'KARL', 'KENDRA', 'KIMBERLY', 'LEA', 'LIV', 'LOTTE', 'LUCIA', 'LUPE', 'MADS', 'MAJA', 'MARLENE', 'MATHIEU', 'MATTHEW', 'MAXIM', 'MIA', 'MIGUEL', 'MIZUKI', 'NAJA', 'NICOLE', 'PENELOPE', 'RAVEENA', 'RICARDO', 'RUBEN', 'RUSSELL', 'SALLI', 'SEOYEON', 'TAKUMI', 'TATYANA', 'VICKI', 'VITORIA', 'ZEINA', 'ZHIYU', ], ], 'VoiceMessageBody' => [ 'type' => 'string', 'max' => 6000, 'min' => 1, 'pattern' => '(?!\\s*$)[\\s\\S]+', ], 'VoiceMessageBodyTextType' => [ 'type' => 'string', 'enum' => [ 'TEXT', 'SSML', ], ], 'VoiceMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2022-03-31', 'endpointPrefix' => 'sms-voice', 'jsonVersion' => '1.0', 'protocol' => 'json', 'serviceFullName' => 'Amazon Pinpoint SMS Voice V2', 'serviceId' => 'Pinpoint SMS Voice V2', 'signatureVersion' => 'v4', 'signingName' => 'sms-voice', 'targetPrefix' => 'PinpointSMSVoiceV2', 'uid' => 'pinpoint-sms-voice-v2-2022-03-31', ], 'operations' => [ 'AssociateOriginationIdentity' => [ 'name' => 'AssociateOriginationIdentity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateOriginationIdentityRequest', ], 'output' => [ 'shape' => 'AssociateOriginationIdentityResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'AssociateProtectConfiguration' => [ 'name' => 'AssociateProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateProtectConfigurationRequest', ], 'output' => [ 'shape' => 'AssociateProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConfigurationSet' => [ 'name' => 'CreateConfigurationSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateConfigurationSetRequest', ], 'output' => [ 'shape' => 'CreateConfigurationSetResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateEventDestination' => [ 'name' => 'CreateEventDestination', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventDestinationRequest', ], 'output' => [ 'shape' => 'CreateEventDestinationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateOptOutList' => [ 'name' => 'CreateOptOutList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOptOutListRequest', ], 'output' => [ 'shape' => 'CreateOptOutListResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreatePool' => [ 'name' => 'CreatePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePoolRequest', ], 'output' => [ 'shape' => 'CreatePoolResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateProtectConfiguration' => [ 'name' => 'CreateProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProtectConfigurationRequest', ], 'output' => [ 'shape' => 'CreateProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistration' => [ 'name' => 'CreateRegistration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationRequest', ], 'output' => [ 'shape' => 'CreateRegistrationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistrationAssociation' => [ 'name' => 'CreateRegistrationAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationAssociationRequest', ], 'output' => [ 'shape' => 'CreateRegistrationAssociationResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistrationAttachment' => [ 'name' => 'CreateRegistrationAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationAttachmentRequest', ], 'output' => [ 'shape' => 'CreateRegistrationAttachmentResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateRegistrationVersion' => [ 'name' => 'CreateRegistrationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegistrationVersionRequest', ], 'output' => [ 'shape' => 'CreateRegistrationVersionResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateVerifiedDestinationNumber' => [ 'name' => 'CreateVerifiedDestinationNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVerifiedDestinationNumberRequest', ], 'output' => [ 'shape' => 'CreateVerifiedDestinationNumberResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteAccountDefaultProtectConfiguration' => [ 'name' => 'DeleteAccountDefaultProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccountDefaultProtectConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteAccountDefaultProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteConfigurationSet' => [ 'name' => 'DeleteConfigurationSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigurationSetRequest', ], 'output' => [ 'shape' => 'DeleteConfigurationSetResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteDefaultMessageType' => [ 'name' => 'DeleteDefaultMessageType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDefaultMessageTypeRequest', ], 'output' => [ 'shape' => 'DeleteDefaultMessageTypeResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteDefaultSenderId' => [ 'name' => 'DeleteDefaultSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDefaultSenderIdRequest', ], 'output' => [ 'shape' => 'DeleteDefaultSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteEventDestination' => [ 'name' => 'DeleteEventDestination', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventDestinationRequest', ], 'output' => [ 'shape' => 'DeleteEventDestinationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteKeyword' => [ 'name' => 'DeleteKeyword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKeywordRequest', ], 'output' => [ 'shape' => 'DeleteKeywordResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteMediaMessageSpendLimitOverride' => [ 'name' => 'DeleteMediaMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMediaMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'DeleteMediaMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteOptOutList' => [ 'name' => 'DeleteOptOutList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptOutListRequest', ], 'output' => [ 'shape' => 'DeleteOptOutListResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteOptedOutNumber' => [ 'name' => 'DeleteOptedOutNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptedOutNumberRequest', ], 'output' => [ 'shape' => 'DeleteOptedOutNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeletePool' => [ 'name' => 'DeletePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePoolRequest', ], 'output' => [ 'shape' => 'DeletePoolResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteProtectConfiguration' => [ 'name' => 'DeleteProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProtectConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteRegistration' => [ 'name' => 'DeleteRegistration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegistrationRequest', ], 'output' => [ 'shape' => 'DeleteRegistrationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteRegistrationAttachment' => [ 'name' => 'DeleteRegistrationAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegistrationAttachmentRequest', ], 'output' => [ 'shape' => 'DeleteRegistrationAttachmentResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteRegistrationFieldValue' => [ 'name' => 'DeleteRegistrationFieldValue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegistrationFieldValueRequest', ], 'output' => [ 'shape' => 'DeleteRegistrationFieldValueResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteTextMessageSpendLimitOverride' => [ 'name' => 'DeleteTextMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTextMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'DeleteTextMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteVerifiedDestinationNumber' => [ 'name' => 'DeleteVerifiedDestinationNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVerifiedDestinationNumberRequest', ], 'output' => [ 'shape' => 'DeleteVerifiedDestinationNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteVoiceMessageSpendLimitOverride' => [ 'name' => 'DeleteVoiceMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVoiceMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'DeleteVoiceMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeAccountAttributes' => [ 'name' => 'DescribeAccountAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountAttributesRequest', ], 'output' => [ 'shape' => 'DescribeAccountAttributesResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeAccountLimits' => [ 'name' => 'DescribeAccountLimits', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountLimitsRequest', ], 'output' => [ 'shape' => 'DescribeAccountLimitsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeConfigurationSets' => [ 'name' => 'DescribeConfigurationSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationSetsRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationSetsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeKeywords' => [ 'name' => 'DescribeKeywords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeKeywordsRequest', ], 'output' => [ 'shape' => 'DescribeKeywordsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeOptOutLists' => [ 'name' => 'DescribeOptOutLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptOutListsRequest', ], 'output' => [ 'shape' => 'DescribeOptOutListsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeOptedOutNumbers' => [ 'name' => 'DescribeOptedOutNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptedOutNumbersRequest', ], 'output' => [ 'shape' => 'DescribeOptedOutNumbersResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribePhoneNumbers' => [ 'name' => 'DescribePhoneNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePhoneNumbersRequest', ], 'output' => [ 'shape' => 'DescribePhoneNumbersResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribePools' => [ 'name' => 'DescribePools', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePoolsRequest', ], 'output' => [ 'shape' => 'DescribePoolsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeProtectConfigurations' => [ 'name' => 'DescribeProtectConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProtectConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeProtectConfigurationsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationAttachments' => [ 'name' => 'DescribeRegistrationAttachments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationAttachmentsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationAttachmentsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationFieldDefinitions' => [ 'name' => 'DescribeRegistrationFieldDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationFieldDefinitionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationFieldDefinitionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationFieldValues' => [ 'name' => 'DescribeRegistrationFieldValues', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationFieldValuesRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationFieldValuesResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationSectionDefinitions' => [ 'name' => 'DescribeRegistrationSectionDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationSectionDefinitionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationSectionDefinitionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationTypeDefinitions' => [ 'name' => 'DescribeRegistrationTypeDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationTypeDefinitionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationTypeDefinitionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrationVersions' => [ 'name' => 'DescribeRegistrationVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationVersionsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationVersionsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeRegistrations' => [ 'name' => 'DescribeRegistrations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRegistrationsRequest', ], 'output' => [ 'shape' => 'DescribeRegistrationsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeSenderIds' => [ 'name' => 'DescribeSenderIds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSenderIdsRequest', ], 'output' => [ 'shape' => 'DescribeSenderIdsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeSpendLimits' => [ 'name' => 'DescribeSpendLimits', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpendLimitsRequest', ], 'output' => [ 'shape' => 'DescribeSpendLimitsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DescribeVerifiedDestinationNumbers' => [ 'name' => 'DescribeVerifiedDestinationNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVerifiedDestinationNumbersRequest', ], 'output' => [ 'shape' => 'DescribeVerifiedDestinationNumbersResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DisassociateOriginationIdentity' => [ 'name' => 'DisassociateOriginationIdentity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateOriginationIdentityRequest', ], 'output' => [ 'shape' => 'DisassociateOriginationIdentityResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DisassociateProtectConfiguration' => [ 'name' => 'DisassociateProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateProtectConfigurationRequest', ], 'output' => [ 'shape' => 'DisassociateProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DiscardRegistrationVersion' => [ 'name' => 'DiscardRegistrationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscardRegistrationVersionRequest', ], 'output' => [ 'shape' => 'DiscardRegistrationVersionResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetProtectConfigurationCountryRuleSet' => [ 'name' => 'GetProtectConfigurationCountryRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProtectConfigurationCountryRuleSetRequest', ], 'output' => [ 'shape' => 'GetProtectConfigurationCountryRuleSetResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListPoolOriginationIdentities' => [ 'name' => 'ListPoolOriginationIdentities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPoolOriginationIdentitiesRequest', ], 'output' => [ 'shape' => 'ListPoolOriginationIdentitiesResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListRegistrationAssociations' => [ 'name' => 'ListRegistrationAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRegistrationAssociationsRequest', ], 'output' => [ 'shape' => 'ListRegistrationAssociationsResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'PutKeyword' => [ 'name' => 'PutKeyword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutKeywordRequest', ], 'output' => [ 'shape' => 'PutKeywordResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'PutOptedOutNumber' => [ 'name' => 'PutOptedOutNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutOptedOutNumberRequest', ], 'output' => [ 'shape' => 'PutOptedOutNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'PutRegistrationFieldValue' => [ 'name' => 'PutRegistrationFieldValue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRegistrationFieldValueRequest', ], 'output' => [ 'shape' => 'PutRegistrationFieldValueResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ReleasePhoneNumber' => [ 'name' => 'ReleasePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleasePhoneNumberRequest', ], 'output' => [ 'shape' => 'ReleasePhoneNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ReleaseSenderId' => [ 'name' => 'ReleaseSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleaseSenderIdRequest', ], 'output' => [ 'shape' => 'ReleaseSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'RequestPhoneNumber' => [ 'name' => 'RequestPhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RequestPhoneNumberRequest', ], 'output' => [ 'shape' => 'RequestPhoneNumberResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'RequestSenderId' => [ 'name' => 'RequestSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RequestSenderIdRequest', ], 'output' => [ 'shape' => 'RequestSenderIdResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendDestinationNumberVerificationCode' => [ 'name' => 'SendDestinationNumberVerificationCode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendDestinationNumberVerificationCodeRequest', ], 'output' => [ 'shape' => 'SendDestinationNumberVerificationCodeResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendMediaMessage' => [ 'name' => 'SendMediaMessage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendMediaMessageRequest', ], 'output' => [ 'shape' => 'SendMediaMessageResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendTextMessage' => [ 'name' => 'SendTextMessage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTextMessageRequest', ], 'output' => [ 'shape' => 'SendTextMessageResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SendVoiceMessage' => [ 'name' => 'SendVoiceMessage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendVoiceMessageRequest', ], 'output' => [ 'shape' => 'SendVoiceMessageResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetAccountDefaultProtectConfiguration' => [ 'name' => 'SetAccountDefaultProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetAccountDefaultProtectConfigurationRequest', ], 'output' => [ 'shape' => 'SetAccountDefaultProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetDefaultMessageType' => [ 'name' => 'SetDefaultMessageType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetDefaultMessageTypeRequest', ], 'output' => [ 'shape' => 'SetDefaultMessageTypeResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetDefaultSenderId' => [ 'name' => 'SetDefaultSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetDefaultSenderIdRequest', ], 'output' => [ 'shape' => 'SetDefaultSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetMediaMessageSpendLimitOverride' => [ 'name' => 'SetMediaMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetMediaMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'SetMediaMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetTextMessageSpendLimitOverride' => [ 'name' => 'SetTextMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetTextMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'SetTextMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SetVoiceMessageSpendLimitOverride' => [ 'name' => 'SetVoiceMessageSpendLimitOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetVoiceMessageSpendLimitOverrideRequest', ], 'output' => [ 'shape' => 'SetVoiceMessageSpendLimitOverrideResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'SubmitRegistrationVersion' => [ 'name' => 'SubmitRegistrationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitRegistrationVersionRequest', ], 'output' => [ 'shape' => 'SubmitRegistrationVersionResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateEventDestination' => [ 'name' => 'UpdateEventDestination', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEventDestinationRequest', ], 'output' => [ 'shape' => 'UpdateEventDestinationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdatePhoneNumber' => [ 'name' => 'UpdatePhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'UpdatePhoneNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdatePool' => [ 'name' => 'UpdatePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePoolRequest', ], 'output' => [ 'shape' => 'UpdatePoolResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateProtectConfiguration' => [ 'name' => 'UpdateProtectConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProtectConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateProtectConfigurationResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateProtectConfigurationCountryRuleSet' => [ 'name' => 'UpdateProtectConfigurationCountryRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProtectConfigurationCountryRuleSetRequest', ], 'output' => [ 'shape' => 'UpdateProtectConfigurationCountryRuleSetResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateSenderId' => [ 'name' => 'UpdateSenderId', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSenderIdRequest', ], 'output' => [ 'shape' => 'UpdateSenderIdResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'VerifyDestinationNumber' => [ 'name' => 'VerifyDestinationNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'VerifyDestinationNumberRequest', ], 'output' => [ 'shape' => 'VerifyDestinationNumberResult', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'AccessDeniedExceptionReason', ], ], 'exception' => true, ], 'AccessDeniedExceptionReason' => [ 'type' => 'string', 'enum' => [ 'INSUFFICIENT_ACCOUNT_REPUTATION', 'ACCOUNT_DISABLED', ], ], 'AccountAttribute' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'AccountAttributeName', ], 'Value' => [ 'shape' => 'String', ], ], ], 'AccountAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountAttribute', ], ], 'AccountAttributeName' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT_TIER', 'DEFAULT_PROTECT_CONFIGURATION_ID', ], ], 'AccountLimit' => [ 'type' => 'structure', 'required' => [ 'Name', 'Used', 'Max', ], 'members' => [ 'Name' => [ 'shape' => 'AccountLimitName', ], 'Used' => [ 'shape' => 'PrimitiveLong', ], 'Max' => [ 'shape' => 'PrimitiveLong', ], ], ], 'AccountLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountLimit', ], ], 'AccountLimitName' => [ 'type' => 'string', 'enum' => [ 'PHONE_NUMBERS', 'POOLS', 'CONFIGURATION_SETS', 'OPT_OUT_LISTS', 'SENDER_IDS', 'REGISTRATIONS', 'REGISTRATION_ATTACHMENTS', 'VERIFIED_DESTINATION_NUMBERS', ], ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 256, 'min' => 20, 'pattern' => 'arn:[A-Za-z0-9_:/-]+', ], 'AssociateOriginationIdentityRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', 'OriginationIdentity', 'IsoCountryCode', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'OriginationIdentity' => [ 'shape' => 'PhoneOrSenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'AssociateOriginationIdentityResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'AssociateProtectConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', 'ConfigurationSetName', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'AssociateProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetArn', 'ConfigurationSetName', 'ProtectConfigurationArn', 'ProtectConfigurationId', ], 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], ], ], 'AttachmentBody' => [ 'type' => 'blob', 'max' => 1572864, 'min' => 1, ], 'AttachmentStatus' => [ 'type' => 'string', 'enum' => [ 'UPLOAD_IN_PROGRESS', 'UPLOAD_COMPLETE', 'UPLOAD_FAILED', 'DELETED', ], ], 'AttachmentUploadErrorReason' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', ], ], 'AttachmentUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '\\S+', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[!-~]+', ], 'CloudWatchLogsDestination' => [ 'type' => 'structure', 'required' => [ 'IamRoleArn', 'LogGroupArn', ], 'members' => [ 'IamRoleArn' => [ 'shape' => 'IamRoleArn', ], 'LogGroupArn' => [ 'shape' => 'LogGroupArn', ], ], ], 'ConfigurationSetFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ConfigurationSetFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'ConfigurationSetFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationSetFilter', ], 'max' => 20, 'min' => 0, ], 'ConfigurationSetFilterName' => [ 'type' => 'string', 'enum' => [ 'event-destination-name', 'matching-event-types', 'default-message-type', 'default-sender-id', 'protect-configuration-id', ], ], 'ConfigurationSetInformation' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetArn', 'ConfigurationSetName', 'EventDestinations', 'CreatedTimestamp', ], 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestinations' => [ 'shape' => 'EventDestinationList', ], 'DefaultMessageType' => [ 'shape' => 'MessageType', ], 'DefaultSenderId' => [ 'shape' => 'SenderId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], ], ], 'ConfigurationSetInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationSetInformation', ], ], 'ConfigurationSetName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'ConfigurationSetNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'max' => 5, 'min' => 0, ], 'ConfigurationSetNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'ConflictExceptionReason', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceId' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ConflictExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CREATE_REGISTRATION_VERSION_NOT_ALLOWED', 'DELETION_PROTECTION_ENABLED', 'DESTINATION_PHONE_NUMBER_NOT_VERIFIED', 'DESTINATION_PHONE_NUMBER_OPTED_OUT', 'DISASSOCIATE_REGISTRATION_NOT_ALLOWED', 'DISCARD_REGISTRATION_VERSION_NOT_ALLOWED', 'EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED', 'EVENT_DESTINATION_MISMATCH', 'KEYWORD_MISMATCH', 'LAST_PHONE_NUMBER', 'NUMBER_CAPABILITIES_MISMATCH', 'MESSAGE_TYPE_MISMATCH', 'NO_ORIGINATION_IDENTITIES_FOUND', 'OPT_OUT_LIST_MISMATCH', 'PHONE_NUMBER_ASSOCIATED_TO_POOL', 'PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION', 'PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL', 'PHONE_NUMBER_NOT_IN_REGISTRATION_REGION', 'REGISTRATION_ALREADY_SUBMITTED', 'REGISTRATION_NOT_COMPLETE', 'SENDER_ID_ASSOCIATED_TO_POOL', 'RESOURCE_ALREADY_EXISTS', 'RESOURCE_DELETION_NOT_ALLOWED', 'RESOURCE_MODIFICATION_NOT_ALLOWED', 'RESOURCE_NOT_ACTIVE', 'RESOURCE_NOT_EMPTY', 'SELF_MANAGED_OPT_OUTS_MISMATCH', 'SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED', 'TWO_WAY_CONFIG_MISMATCH', 'VERIFICATION_CODE_EXPIRED', 'VERIFICATION_ALREADY_COMPLETE', 'PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT', 'PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET', 'PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET', 'DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION', ], ], 'ContextKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '\\S+', ], 'ContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ContextKey', ], 'value' => [ 'shape' => 'ContextValue', ], 'max' => 5, 'min' => 0, ], 'ContextValue' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '(?!\\s)^[\\s\\S]+(? [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateConfigurationSetResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateEventDestinationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'EventDestinationName', 'MatchingEventTypes', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], 'MatchingEventTypes' => [ 'shape' => 'EventTypeList', ], 'CloudWatchLogsDestination' => [ 'shape' => 'CloudWatchLogsDestination', ], 'KinesisFirehoseDestination' => [ 'shape' => 'KinesisFirehoseDestination', ], 'SnsDestination' => [ 'shape' => 'SnsDestination', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateEventDestinationResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestination' => [ 'shape' => 'EventDestination', ], ], ], 'CreateOptOutListRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateOptOutListResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreatePoolRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', 'IsoCountryCode', 'MessageType', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrSenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreatePoolResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateProtectConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationArn', 'ProtectConfigurationId', 'CreatedTimestamp', 'AccountDefault', 'DeletionProtectionEnabled', ], 'members' => [ 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], 'AccountDefault' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRegistrationAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', 'ResourceId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'ResourceId' => [ 'shape' => 'ResourceIdOrArn', ], ], ], 'CreateRegistrationAssociationResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'ResourceArn', 'ResourceId', 'ResourceType', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'ResourceArn' => [ 'shape' => 'String', ], 'ResourceId' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'CreateRegistrationAttachmentRequest' => [ 'type' => 'structure', 'members' => [ 'AttachmentBody' => [ 'shape' => 'AttachmentBody', ], 'AttachmentUrl' => [ 'shape' => 'AttachmentUrl', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateRegistrationAttachmentResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentArn', 'RegistrationAttachmentId', 'AttachmentStatus', 'CreatedTimestamp', ], 'members' => [ 'RegistrationAttachmentArn' => [ 'shape' => 'String', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], 'AttachmentStatus' => [ 'shape' => 'AttachmentStatus', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateRegistrationResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationStatus', 'CurrentVersionNumber', 'CreatedTimestamp', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationStatus' => [ 'shape' => 'RegistrationStatus', ], 'CurrentVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'AdditionalAttributes' => [ 'shape' => 'StringMap', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'CreateRegistrationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'CreateRegistrationVersionResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], ], ], 'CreateVerifiedDestinationNumberRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateVerifiedDestinationNumberResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'Status', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'VerificationStatus', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteAccountDefaultProtectConfigurationRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAccountDefaultProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'DefaultProtectConfigurationArn', 'DefaultProtectConfigurationId', ], 'members' => [ 'DefaultProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'DefaultProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], ], ], 'DeleteConfigurationSetRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DeleteConfigurationSetResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestinations' => [ 'shape' => 'EventDestinationList', ], 'DefaultMessageType' => [ 'shape' => 'MessageType', ], 'DefaultSenderId' => [ 'shape' => 'SenderId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteDefaultMessageTypeRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DeleteDefaultMessageTypeResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'MessageType' => [ 'shape' => 'MessageType', ], ], ], 'DeleteDefaultSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DeleteDefaultSenderIdResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'SenderId' => [ 'shape' => 'SenderId', ], ], ], 'DeleteEventDestinationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'EventDestinationName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], ], ], 'DeleteEventDestinationResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestination' => [ 'shape' => 'EventDestination', ], ], ], 'DeleteKeywordRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', 'Keyword', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrPoolIdOrArn', ], 'Keyword' => [ 'shape' => 'Keyword', ], ], ], 'DeleteKeywordResult' => [ 'type' => 'structure', 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'DeleteMediaMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMediaMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'DeleteOptOutListRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], ], ], 'DeleteOptOutListResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteOptedOutNumberRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', 'OptedOutNumber', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'DeleteOptedOutNumberResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], 'OptedOutTimestamp' => [ 'shape' => 'Timestamp', ], 'EndUserOptedOut' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'DeletePoolRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], ], ], 'DeletePoolResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteProtectConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], ], ], 'DeleteProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationArn', 'ProtectConfigurationId', 'CreatedTimestamp', 'AccountDefault', 'DeletionProtectionEnabled', ], 'members' => [ 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], 'AccountDefault' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'DeleteRegistrationAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentId', ], 'members' => [ 'RegistrationAttachmentId' => [ 'shape' => 'RegistrationAttachmentIdOrArn', ], ], ], 'DeleteRegistrationAttachmentResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentArn', 'RegistrationAttachmentId', 'AttachmentStatus', 'CreatedTimestamp', ], 'members' => [ 'RegistrationAttachmentArn' => [ 'shape' => 'String', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], 'AttachmentStatus' => [ 'shape' => 'AttachmentStatus', ], 'AttachmentUploadErrorReason' => [ 'shape' => 'AttachmentUploadErrorReason', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteRegistrationFieldValueRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', 'FieldPath', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], ], ], 'DeleteRegistrationFieldValueResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'FieldPath', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], ], ], 'DeleteRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'DeleteRegistrationResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationStatus', 'CurrentVersionNumber', 'CreatedTimestamp', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationStatus' => [ 'shape' => 'RegistrationStatus', ], 'CurrentVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'ApprovedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'LatestDeniedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'AdditionalAttributes' => [ 'shape' => 'StringMap', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteTextMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTextMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'DeleteVerifiedDestinationNumberRequest' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberId', ], 'members' => [ 'VerifiedDestinationNumberId' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], ], ], 'DeleteVerifiedDestinationNumberResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteVoiceMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVoiceMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'DeliveryStreamArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'DescribeAccountAttributesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeAccountAttributesResult' => [ 'type' => 'structure', 'members' => [ 'AccountAttributes' => [ 'shape' => 'AccountAttributeList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAccountLimitsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeAccountLimitsResult' => [ 'type' => 'structure', 'members' => [ 'AccountLimits' => [ 'shape' => 'AccountLimitList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConfigurationSetsRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetNames' => [ 'shape' => 'ConfigurationSetNameList', ], 'Filters' => [ 'shape' => 'ConfigurationSetFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeConfigurationSetsResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSets' => [ 'shape' => 'ConfigurationSetInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeKeywordsRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrPoolIdOrArn', ], 'Keywords' => [ 'shape' => 'KeywordList', ], 'Filters' => [ 'shape' => 'KeywordFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeKeywordsResult' => [ 'type' => 'structure', 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'Keywords' => [ 'shape' => 'KeywordInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOptOutListsRequest' => [ 'type' => 'structure', 'members' => [ 'OptOutListNames' => [ 'shape' => 'OptOutListNameList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeOptOutListsResult' => [ 'type' => 'structure', 'members' => [ 'OptOutLists' => [ 'shape' => 'OptOutListInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOptedOutNumbersRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'OptedOutNumbers' => [ 'shape' => 'OptedOutNumberList', ], 'Filters' => [ 'shape' => 'OptedOutFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeOptedOutNumbersResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'OptedOutNumbers' => [ 'shape' => 'OptedOutNumberInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePhoneNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberIds' => [ 'shape' => 'PhoneNumberIdList', ], 'Filters' => [ 'shape' => 'PhoneNumberFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribePhoneNumbersResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumbers' => [ 'shape' => 'PhoneNumberInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePoolsRequest' => [ 'type' => 'structure', 'members' => [ 'PoolIds' => [ 'shape' => 'PoolIdList', ], 'Filters' => [ 'shape' => 'PoolFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribePoolsResult' => [ 'type' => 'structure', 'members' => [ 'Pools' => [ 'shape' => 'PoolInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeProtectConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'ProtectConfigurationIds' => [ 'shape' => 'ProtectConfigurationIdList', ], 'Filters' => [ 'shape' => 'ProtectConfigurationFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeProtectConfigurationsResult' => [ 'type' => 'structure', 'members' => [ 'ProtectConfigurations' => [ 'shape' => 'ProtectConfigurationInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationAttachmentsRequest' => [ 'type' => 'structure', 'members' => [ 'RegistrationAttachmentIds' => [ 'shape' => 'RegistrationAttachmentIdList', ], 'Filters' => [ 'shape' => 'RegistrationAttachmentFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationAttachmentsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachments', ], 'members' => [ 'RegistrationAttachments' => [ 'shape' => 'RegistrationAttachmentsInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationFieldDefinitionsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'SectionPath' => [ 'shape' => 'SectionPath', ], 'FieldPaths' => [ 'shape' => 'FieldPathList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationFieldDefinitionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', 'RegistrationFieldDefinitions', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationFieldDefinitions' => [ 'shape' => 'RegistrationFieldDefinitionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationFieldValuesRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'SectionPath' => [ 'shape' => 'SectionPath', ], 'FieldPaths' => [ 'shape' => 'FieldPathList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationFieldValuesResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationFieldValues', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationFieldValues' => [ 'shape' => 'RegistrationFieldValueInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationSectionDefinitionsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'SectionPaths' => [ 'shape' => 'SectionPathList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationSectionDefinitionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', 'RegistrationSectionDefinitions', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationSectionDefinitions' => [ 'shape' => 'RegistrationSectionDefinitionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationTypeDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'RegistrationTypes' => [ 'shape' => 'RegistrationTypeList', ], 'Filters' => [ 'shape' => 'RegistrationTypeFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationTypeDefinitionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationTypeDefinitions', ], 'members' => [ 'RegistrationTypeDefinitions' => [ 'shape' => 'RegistrationTypeDefinitionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'VersionNumbers' => [ 'shape' => 'RegistrationVersionNumberList', ], 'Filters' => [ 'shape' => 'RegistrationVersionFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationVersionsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationVersions', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationVersions' => [ 'shape' => 'RegistrationVersionInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRegistrationsRequest' => [ 'type' => 'structure', 'members' => [ 'RegistrationIds' => [ 'shape' => 'RegistrationIdList', ], 'Filters' => [ 'shape' => 'RegistrationFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeRegistrationsResult' => [ 'type' => 'structure', 'required' => [ 'Registrations', ], 'members' => [ 'Registrations' => [ 'shape' => 'RegistrationInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeSenderIdsRequest' => [ 'type' => 'structure', 'members' => [ 'SenderIds' => [ 'shape' => 'SenderIdList', ], 'Filters' => [ 'shape' => 'SenderIdFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeSenderIdsResult' => [ 'type' => 'structure', 'members' => [ 'SenderIds' => [ 'shape' => 'SenderIdInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeSpendLimitsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeSpendLimitsResult' => [ 'type' => 'structure', 'members' => [ 'SpendLimits' => [ 'shape' => 'SpendLimitList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeVerifiedDestinationNumbersRequest' => [ 'type' => 'structure', 'members' => [ 'VerifiedDestinationNumberIds' => [ 'shape' => 'VerifiedDestinationNumberIdList', ], 'DestinationPhoneNumbers' => [ 'shape' => 'DestinationPhoneNumberList', ], 'Filters' => [ 'shape' => 'VerifiedDestinationNumberFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'DescribeVerifiedDestinationNumbersResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumbers', ], 'members' => [ 'VerifiedDestinationNumbers' => [ 'shape' => 'VerifiedDestinationNumberInformationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DestinationCountryParameterKey' => [ 'type' => 'string', 'enum' => [ 'IN_TEMPLATE_ID', 'IN_ENTITY_ID', ], ], 'DestinationCountryParameterValue' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '\\S+', ], 'DestinationCountryParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'DestinationCountryParameterKey', ], 'value' => [ 'shape' => 'DestinationCountryParameterValue', ], 'max' => 10, 'min' => 0, ], 'DestinationPhoneNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumber', ], 'max' => 5, 'min' => 0, ], 'DisassociateOriginationIdentityRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', 'OriginationIdentity', 'IsoCountryCode', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'OriginationIdentity' => [ 'shape' => 'PhoneOrSenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'DisassociateOriginationIdentityResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'DisassociateProtectConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', 'ConfigurationSetName', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], ], ], 'DisassociateProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetArn', 'ConfigurationSetName', 'ProtectConfigurationArn', 'ProtectConfigurationId', ], 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], ], ], 'DiscardRegistrationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'DiscardRegistrationVersionResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], ], ], 'EventDestination' => [ 'type' => 'structure', 'required' => [ 'EventDestinationName', 'Enabled', 'MatchingEventTypes', ], 'members' => [ 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'MatchingEventTypes' => [ 'shape' => 'EventTypeList', ], 'CloudWatchLogsDestination' => [ 'shape' => 'CloudWatchLogsDestination', ], 'KinesisFirehoseDestination' => [ 'shape' => 'KinesisFirehoseDestination', ], 'SnsDestination' => [ 'shape' => 'SnsDestination', ], ], ], 'EventDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventDestination', ], ], 'EventDestinationName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'EventType' => [ 'type' => 'string', 'enum' => [ 'ALL', 'TEXT_ALL', 'TEXT_SENT', 'TEXT_PENDING', 'TEXT_QUEUED', 'TEXT_SUCCESSFUL', 'TEXT_DELIVERED', 'TEXT_INVALID', 'TEXT_INVALID_MESSAGE', 'TEXT_UNREACHABLE', 'TEXT_CARRIER_UNREACHABLE', 'TEXT_BLOCKED', 'TEXT_CARRIER_BLOCKED', 'TEXT_SPAM', 'TEXT_UNKNOWN', 'TEXT_TTL_EXPIRED', 'VOICE_ALL', 'VOICE_INITIATED', 'VOICE_RINGING', 'VOICE_ANSWERED', 'VOICE_COMPLETED', 'VOICE_BUSY', 'VOICE_NO_ANSWER', 'VOICE_FAILED', 'VOICE_TTL_EXPIRED', 'MEDIA_ALL', 'MEDIA_PENDING', 'MEDIA_QUEUED', 'MEDIA_SUCCESSFUL', 'MEDIA_DELIVERED', 'MEDIA_INVALID', 'MEDIA_INVALID_MESSAGE', 'MEDIA_UNREACHABLE', 'MEDIA_CARRIER_UNREACHABLE', 'MEDIA_BLOCKED', 'MEDIA_CARRIER_BLOCKED', 'MEDIA_SPAM', 'MEDIA_UNKNOWN', 'MEDIA_TTL_EXPIRED', 'MEDIA_FILE_INACCESSIBLE', 'MEDIA_FILE_TYPE_UNSUPPORTED', 'MEDIA_FILE_SIZE_EXCEEDED', ], ], 'EventTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventType', ], 'max' => 43, 'min' => 1, ], 'FieldPath' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[A-Za-z0-9_\\.]+', ], 'FieldPathList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldPath', ], 'max' => 5, 'min' => 0, ], 'FieldRequirement' => [ 'type' => 'string', 'enum' => [ 'REQUIRED', 'CONDITIONAL', 'OPTIONAL', ], ], 'FieldType' => [ 'type' => 'string', 'enum' => [ 'SELECT', 'TEXT', 'ATTACHMENT', ], ], 'FilterValue' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[/\\.:A-Za-z0-9_-]+', ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], 'max' => 20, 'min' => 1, ], 'GetProtectConfigurationCountryRuleSetRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', 'NumberCapability', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], 'NumberCapability' => [ 'shape' => 'NumberCapability', ], ], ], 'GetProtectConfigurationCountryRuleSetResult' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationArn', 'ProtectConfigurationId', 'NumberCapability', 'CountryRuleSet', ], 'members' => [ 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], 'NumberCapability' => [ 'shape' => 'NumberCapability', ], 'CountryRuleSet' => [ 'shape' => 'ProtectConfigurationCountryRuleSet', ], ], ], 'IamRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'IsoCountryCode' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Z]{2}', ], 'Keyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[ \\S]+', ], 'KeywordAction' => [ 'type' => 'string', 'enum' => [ 'AUTOMATIC_RESPONSE', 'OPT_OUT', 'OPT_IN', ], ], 'KeywordFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'KeywordFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'KeywordFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeywordFilter', ], 'max' => 20, 'min' => 0, ], 'KeywordFilterName' => [ 'type' => 'string', 'enum' => [ 'keyword-action', ], ], 'KeywordInformation' => [ 'type' => 'structure', 'required' => [ 'Keyword', 'KeywordMessage', 'KeywordAction', ], 'members' => [ 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'KeywordInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeywordInformation', ], ], 'KeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Keyword', ], 'max' => 5, 'min' => 0, ], 'KeywordMessage' => [ 'type' => 'string', 'max' => 1600, 'min' => 1, 'pattern' => '(?!\\s*$)[\\s\\S]+', ], 'KinesisFirehoseDestination' => [ 'type' => 'structure', 'required' => [ 'IamRoleArn', 'DeliveryStreamArn', ], 'members' => [ 'IamRoleArn' => [ 'shape' => 'IamRoleArn', ], 'DeliveryStreamArn' => [ 'shape' => 'DeliveryStreamArn', ], ], ], 'LanguageCode' => [ 'type' => 'string', 'enum' => [ 'DE_DE', 'EN_GB', 'EN_US', 'ES_419', 'ES_ES', 'FR_CA', 'FR_FR', 'IT_IT', 'JA_JP', 'KO_KR', 'PT_BR', 'ZH_CN', 'ZH_TW', ], ], 'ListPoolOriginationIdentitiesRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'Filters' => [ 'shape' => 'PoolOriginationIdentitiesFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPoolOriginationIdentitiesResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'OriginationIdentities' => [ 'shape' => 'OriginationIdentityMetadataList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRegistrationAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'Filters' => [ 'shape' => 'RegistrationAssociationFilterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListRegistrationAssociationsResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationAssociations', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationAssociations' => [ 'shape' => 'RegistrationAssociationMetadataList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'ListTagsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'LogGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'MaxPrice' => [ 'type' => 'string', 'max' => 8, 'min' => 2, 'pattern' => '[0-9]{0,2}\\.[0-9]{1,5}', ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MediaMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], 'MediaUrlList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaUrlValue', ], 'max' => 1, 'min' => 1, ], 'MediaUrlValue' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 's3://([a-z0-9\\.-]{3,63})/(.+)', ], 'MessageType' => [ 'type' => 'string', 'enum' => [ 'TRANSACTIONAL', 'PROMOTIONAL', ], ], 'MessageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MessageType', ], 'max' => 2, 'min' => 0, ], 'MonthlyLimit' => [ 'type' => 'long', 'box' => true, 'max' => 1000000000, 'min' => 0, ], 'NextToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'NonEmptyTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 1, ], 'NumberCapability' => [ 'type' => 'string', 'enum' => [ 'SMS', 'VOICE', 'MMS', ], ], 'NumberCapabilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NumberCapability', ], 'max' => 3, 'min' => 1, ], 'NumberStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ACTIVE', 'ASSOCIATING', 'DISASSOCIATING', 'DELETED', ], ], 'NumberType' => [ 'type' => 'string', 'enum' => [ 'SHORT_CODE', 'LONG_CODE', 'TOLL_FREE', 'TEN_DLC', 'SIMULATOR', ], ], 'OptOutListInformation' => [ 'type' => 'structure', 'required' => [ 'OptOutListArn', 'OptOutListName', 'CreatedTimestamp', ], 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'OptOutListInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptOutListInformation', ], ], 'OptOutListName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'OptOutListNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptOutListNameOrArn', ], 'max' => 5, 'min' => 0, ], 'OptOutListNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'OptedOutFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'OptedOutFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'OptedOutFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptedOutFilter', ], 'max' => 20, 'min' => 0, ], 'OptedOutFilterName' => [ 'type' => 'string', 'enum' => [ 'end-user-opted-out', ], ], 'OptedOutNumberInformation' => [ 'type' => 'structure', 'required' => [ 'OptedOutNumber', 'OptedOutTimestamp', 'EndUserOptedOut', ], 'members' => [ 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], 'OptedOutTimestamp' => [ 'shape' => 'Timestamp', ], 'EndUserOptedOut' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'OptedOutNumberInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptedOutNumberInformation', ], ], 'OptedOutNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumber', ], 'max' => 5, 'min' => 0, ], 'OriginationIdentityMetadata' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentityArn', 'OriginationIdentity', 'IsoCountryCode', 'NumberCapabilities', ], 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'OriginationIdentityMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OriginationIdentityMetadata', ], ], 'PhoneNumber' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '\\+?[1-9][0-9]{1,18}', ], 'PhoneNumberFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'PhoneNumberFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'PhoneNumberFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberFilter', ], 'max' => 20, 'min' => 0, ], 'PhoneNumberFilterName' => [ 'type' => 'string', 'enum' => [ 'status', 'iso-country-code', 'message-type', 'number-capability', 'number-type', 'two-way-enabled', 'self-managed-opt-outs-enabled', 'opt-out-list-name', 'deletion-protection-enabled', 'two-way-channel-arn', ], ], 'PhoneNumberIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberIdOrArn', ], 'max' => 5, 'min' => 0, ], 'PhoneNumberIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PhoneNumberInformation' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberArn', 'PhoneNumber', 'Status', 'IsoCountryCode', 'MessageType', 'NumberCapabilities', 'NumberType', 'MonthlyLeasingPrice', 'TwoWayEnabled', 'SelfManagedOptOutsEnabled', 'OptOutListName', 'DeletionProtectionEnabled', 'CreatedTimestamp', ], 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'NumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'PoolId' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'PhoneNumberInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberInformation', ], ], 'PhoneOrPoolIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PhoneOrSenderIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PoolFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'PoolFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'PoolFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolFilter', ], 'max' => 20, 'min' => 0, ], 'PoolFilterName' => [ 'type' => 'string', 'enum' => [ 'status', 'message-type', 'two-way-enabled', 'self-managed-opt-outs-enabled', 'opt-out-list-name', 'shared-routes-enabled', 'deletion-protection-enabled', 'two-way-channel-arn', ], ], 'PoolIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolIdOrArn', ], 'max' => 5, 'min' => 0, ], 'PoolIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'PoolInformation' => [ 'type' => 'structure', 'required' => [ 'PoolArn', 'PoolId', 'Status', 'MessageType', 'TwoWayEnabled', 'SelfManagedOptOutsEnabled', 'OptOutListName', 'SharedRoutesEnabled', 'DeletionProtectionEnabled', 'CreatedTimestamp', ], 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'PoolInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolInformation', ], ], 'PoolOriginationIdentitiesFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'PoolOriginationIdentitiesFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'PoolOriginationIdentitiesFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PoolOriginationIdentitiesFilter', ], 'max' => 20, 'min' => 0, ], 'PoolOriginationIdentitiesFilterName' => [ 'type' => 'string', 'enum' => [ 'iso-country-code', 'number-capability', ], ], 'PoolStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', ], ], 'PrimitiveBoolean' => [ 'type' => 'boolean', ], 'PrimitiveLong' => [ 'type' => 'long', ], 'ProtectConfigurationArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:\\S+', ], 'ProtectConfigurationCountryRuleSet' => [ 'type' => 'map', 'key' => [ 'shape' => 'IsoCountryCode', ], 'value' => [ 'shape' => 'ProtectConfigurationCountryRuleSetInformation', ], 'max' => 300, 'min' => 1, ], 'ProtectConfigurationCountryRuleSetInformation' => [ 'type' => 'structure', 'required' => [ 'ProtectStatus', ], 'members' => [ 'ProtectStatus' => [ 'shape' => 'ProtectStatus', ], ], ], 'ProtectConfigurationFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ProtectConfigurationFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'ProtectConfigurationFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtectConfigurationFilter', ], 'max' => 20, 'min' => 0, ], 'ProtectConfigurationFilterName' => [ 'type' => 'string', 'enum' => [ 'account-default', 'deletion-protection-enabled', ], ], 'ProtectConfigurationId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'ProtectConfigurationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], 'max' => 5, 'min' => 0, ], 'ProtectConfigurationIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ProtectConfigurationInformation' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationArn', 'ProtectConfigurationId', 'CreatedTimestamp', 'AccountDefault', 'DeletionProtectionEnabled', ], 'members' => [ 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], 'AccountDefault' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'ProtectConfigurationInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtectConfigurationInformation', ], 'max' => 100, 'min' => 1, ], 'ProtectStatus' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', ], ], 'PutKeywordRequest' => [ 'type' => 'structure', 'required' => [ 'OriginationIdentity', 'Keyword', 'KeywordMessage', ], 'members' => [ 'OriginationIdentity' => [ 'shape' => 'PhoneOrPoolIdOrArn', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'PutKeywordResult' => [ 'type' => 'structure', 'members' => [ 'OriginationIdentityArn' => [ 'shape' => 'String', ], 'OriginationIdentity' => [ 'shape' => 'String', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'KeywordMessage' => [ 'shape' => 'KeywordMessage', ], 'KeywordAction' => [ 'shape' => 'KeywordAction', ], ], ], 'PutOptedOutNumberRequest' => [ 'type' => 'structure', 'required' => [ 'OptOutListName', 'OptedOutNumber', ], 'members' => [ 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'PutOptedOutNumberResult' => [ 'type' => 'structure', 'members' => [ 'OptOutListArn' => [ 'shape' => 'String', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'OptedOutNumber' => [ 'shape' => 'PhoneNumber', ], 'OptedOutTimestamp' => [ 'shape' => 'Timestamp', ], 'EndUserOptedOut' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'PutRegistrationFieldValueRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', 'FieldPath', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'RegistrationAttachmentIdOrArn', ], ], ], 'PutRegistrationFieldValueResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'FieldPath', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], ], ], 'RegistrationAssociationBehavior' => [ 'type' => 'string', 'enum' => [ 'ASSOCIATE_BEFORE_SUBMIT', 'ASSOCIATE_ON_APPROVAL', 'ASSOCIATE_AFTER_COMPLETE', ], ], 'RegistrationAssociationFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationAssociationFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationAssociationFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAssociationFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationAssociationFilterName' => [ 'type' => 'string', 'enum' => [ 'resource-type', 'iso-country-code', ], ], 'RegistrationAssociationMetadata' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'ResourceId', 'ResourceType', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'ResourceId' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'RegistrationAssociationMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAssociationMetadata', ], ], 'RegistrationAttachmentFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationAttachmentFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationAttachmentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAttachmentFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationAttachmentFilterName' => [ 'type' => 'string', 'enum' => [ 'attachment-status', ], ], 'RegistrationAttachmentIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationIdOrArn', ], 'max' => 5, 'min' => 0, ], 'RegistrationAttachmentIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'RegistrationAttachmentsInformation' => [ 'type' => 'structure', 'required' => [ 'RegistrationAttachmentArn', 'RegistrationAttachmentId', 'AttachmentStatus', 'CreatedTimestamp', ], 'members' => [ 'RegistrationAttachmentArn' => [ 'shape' => 'String', ], 'RegistrationAttachmentId' => [ 'shape' => 'String', ], 'AttachmentStatus' => [ 'shape' => 'AttachmentStatus', ], 'AttachmentUploadErrorReason' => [ 'shape' => 'AttachmentUploadErrorReason', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RegistrationAttachmentsInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationAttachmentsInformation', ], ], 'RegistrationDeniedReasonInformation' => [ 'type' => 'structure', 'required' => [ 'Reason', 'ShortDescription', ], 'members' => [ 'Reason' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], ], ], 'RegistrationDeniedReasonInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationDeniedReasonInformation', ], ], 'RegistrationDisassociationBehavior' => [ 'type' => 'string', 'enum' => [ 'DISASSOCIATE_ALL_CLOSES_REGISTRATION', 'DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION', 'DELETE_REGISTRATION_DISASSOCIATES', ], ], 'RegistrationFieldDefinition' => [ 'type' => 'structure', 'required' => [ 'SectionPath', 'FieldPath', 'FieldType', 'FieldRequirement', 'DisplayHints', ], 'members' => [ 'SectionPath' => [ 'shape' => 'SectionPath', ], 'FieldPath' => [ 'shape' => 'FieldPath', ], 'FieldType' => [ 'shape' => 'FieldType', ], 'FieldRequirement' => [ 'shape' => 'FieldRequirement', ], 'SelectValidation' => [ 'shape' => 'SelectValidation', ], 'TextValidation' => [ 'shape' => 'TextValidation', ], 'DisplayHints' => [ 'shape' => 'RegistrationFieldDisplayHints', ], ], ], 'RegistrationFieldDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationFieldDefinition', ], ], 'RegistrationFieldDisplayHints' => [ 'type' => 'structure', 'required' => [ 'Title', 'ShortDescription', ], 'members' => [ 'Title' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], 'SelectOptionDescriptions' => [ 'shape' => 'SelectOptionDescriptionsList', ], 'TextValidationDescription' => [ 'shape' => 'String', ], 'ExampleTextValue' => [ 'shape' => 'String', ], ], ], 'RegistrationFieldValueInformation' => [ 'type' => 'structure', 'required' => [ 'FieldPath', ], 'members' => [ 'FieldPath' => [ 'shape' => 'FieldPath', ], 'SelectChoices' => [ 'shape' => 'SelectChoiceList', ], 'TextValue' => [ 'shape' => 'TextValue', ], 'RegistrationAttachmentId' => [ 'shape' => 'RegistrationAttachmentIdOrArn', ], 'DeniedReason' => [ 'shape' => 'String', ], ], ], 'RegistrationFieldValueInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationFieldValueInformation', ], ], 'RegistrationFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationFilterName' => [ 'type' => 'string', 'enum' => [ 'registration-type', 'registration-status', ], ], 'RegistrationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationIdOrArn', ], 'max' => 5, 'min' => 0, ], 'RegistrationIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'RegistrationInformation' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'RegistrationType', 'RegistrationStatus', 'CurrentVersionNumber', 'CreatedTimestamp', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'RegistrationStatus' => [ 'shape' => 'RegistrationStatus', ], 'CurrentVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'ApprovedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'LatestDeniedVersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'AdditionalAttributes' => [ 'shape' => 'StringMap', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RegistrationInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationInformation', ], ], 'RegistrationSectionDefinition' => [ 'type' => 'structure', 'required' => [ 'SectionPath', 'DisplayHints', ], 'members' => [ 'SectionPath' => [ 'shape' => 'SectionPath', ], 'DisplayHints' => [ 'shape' => 'RegistrationSectionDisplayHints', ], ], ], 'RegistrationSectionDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationSectionDefinition', ], ], 'RegistrationSectionDisplayHints' => [ 'type' => 'structure', 'required' => [ 'Title', 'ShortDescription', ], 'members' => [ 'Title' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], ], ], 'RegistrationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATED', 'SUBMITTED', 'REVIEWING', 'PROVISIONING', 'COMPLETE', 'REQUIRES_UPDATES', 'CLOSED', 'DELETED', ], ], 'RegistrationType' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9_]+', ], 'RegistrationTypeDefinition' => [ 'type' => 'structure', 'required' => [ 'RegistrationType', 'DisplayHints', ], 'members' => [ 'RegistrationType' => [ 'shape' => 'RegistrationType', ], 'SupportedAssociations' => [ 'shape' => 'SupportedAssociationList', ], 'DisplayHints' => [ 'shape' => 'RegistrationTypeDisplayHints', ], ], ], 'RegistrationTypeDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationTypeDefinition', ], ], 'RegistrationTypeDisplayHints' => [ 'type' => 'structure', 'required' => [ 'Title', ], 'members' => [ 'Title' => [ 'shape' => 'String', ], 'ShortDescription' => [ 'shape' => 'String', ], 'LongDescription' => [ 'shape' => 'String', ], 'DocumentationTitle' => [ 'shape' => 'String', ], 'DocumentationLink' => [ 'shape' => 'String', ], ], ], 'RegistrationTypeFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationTypeFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationTypeFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationTypeFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationTypeFilterName' => [ 'type' => 'string', 'enum' => [ 'supported-association-resource-type', 'supported-association-iso-country-code', ], ], 'RegistrationTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationType', ], 'max' => 5, 'min' => 0, ], 'RegistrationVersionFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'RegistrationVersionFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'RegistrationVersionFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationVersionFilter', ], 'max' => 20, 'min' => 0, ], 'RegistrationVersionFilterName' => [ 'type' => 'string', 'enum' => [ 'registration-version-status', ], ], 'RegistrationVersionInformation' => [ 'type' => 'structure', 'required' => [ 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], 'DeniedReasons' => [ 'shape' => 'RegistrationDeniedReasonInformationList', ], ], ], 'RegistrationVersionInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationVersionInformation', ], ], 'RegistrationVersionNumber' => [ 'type' => 'long', 'box' => true, 'max' => 100000, 'min' => 1, ], 'RegistrationVersionNumberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegistrationVersionNumber', ], 'max' => 5, 'min' => 0, ], 'RegistrationVersionStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'SUBMITTED', 'REVIEWING', 'APPROVED', 'DISCARDED', 'DENIED', 'REVOKED', 'ARCHIVED', ], ], 'RegistrationVersionStatusHistory' => [ 'type' => 'structure', 'required' => [ 'DraftTimestamp', ], 'members' => [ 'DraftTimestamp' => [ 'shape' => 'Timestamp', ], 'SubmittedTimestamp' => [ 'shape' => 'Timestamp', ], 'ReviewingTimestamp' => [ 'shape' => 'Timestamp', ], 'ApprovedTimestamp' => [ 'shape' => 'Timestamp', ], 'DiscardedTimestamp' => [ 'shape' => 'Timestamp', ], 'DeniedTimestamp' => [ 'shape' => 'Timestamp', ], 'RevokedTimestamp' => [ 'shape' => 'Timestamp', ], 'ArchivedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ReleasePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberIdOrArn', ], ], ], 'ReleasePhoneNumberResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'NumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'RegistrationId' => [ 'shape' => 'String', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ReleaseSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'ReleaseSenderIdResult' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], ], ], 'RequestPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'IsoCountryCode', 'MessageType', 'NumberCapabilities', 'NumberType', ], 'members' => [ 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'RequestableNumberType', ], 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'RequestPhoneNumberResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'RequestableNumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'PoolId' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RequestSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'RequestSenderIdResult' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'DeletionProtectionEnabled', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RequestableNumberType' => [ 'type' => 'string', 'enum' => [ 'LONG_CODE', 'TOLL_FREE', 'TEN_DLC', 'SIMULATOR', ], ], 'ResourceIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceId' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'account', 'phone-number', 'sender-id', 'pool', 'configuration-set', 'opt-out-list', 'event-destination', 'keyword', 'opted-out-number', 'registration', 'registration-attachment', 'verified-destination-number', 'protect-configuration', ], ], 'SectionPath' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[A-Za-z0-9_]+', ], 'SectionPathList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SectionPath', ], 'max' => 5, 'min' => 0, ], 'SelectChoice' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'SelectChoiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectChoice', ], 'max' => 100, 'min' => 0, ], 'SelectOptionDescription' => [ 'type' => 'structure', 'required' => [ 'Option', ], 'members' => [ 'Option' => [ 'shape' => 'String', ], 'Title' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], ], ], 'SelectOptionDescriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectOptionDescription', ], ], 'SelectValidation' => [ 'type' => 'structure', 'required' => [ 'MinChoices', 'MaxChoices', 'Options', ], 'members' => [ 'MinChoices' => [ 'shape' => 'Integer', ], 'MaxChoices' => [ 'shape' => 'Integer', ], 'Options' => [ 'shape' => 'StringList', ], ], ], 'SendDestinationNumberVerificationCodeRequest' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberId', 'VerificationChannel', ], 'members' => [ 'VerifiedDestinationNumberId' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], 'VerificationChannel' => [ 'shape' => 'VerificationChannel', ], 'LanguageCode' => [ 'shape' => 'LanguageCode', ], 'OriginationIdentity' => [ 'shape' => 'VerificationMessageOriginationIdentity', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DestinationCountryParameters' => [ 'shape' => 'DestinationCountryParameters', ], ], ], 'SendDestinationNumberVerificationCodeResult' => [ 'type' => 'structure', 'required' => [ 'MessageId', ], 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SendMediaMessageRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', 'OriginationIdentity', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'OriginationIdentity' => [ 'shape' => 'MediaMessageOriginationIdentity', ], 'MessageBody' => [ 'shape' => 'TextMessageBody', ], 'MediaUrls' => [ 'shape' => 'MediaUrlList', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MaxPrice' => [ 'shape' => 'MaxPrice', ], 'TimeToLive' => [ 'shape' => 'TimeToLive', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DryRun' => [ 'shape' => 'PrimitiveBoolean', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], ], ], 'SendMediaMessageResult' => [ 'type' => 'structure', 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SendTextMessageRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'OriginationIdentity' => [ 'shape' => 'TextMessageOriginationIdentity', ], 'MessageBody' => [ 'shape' => 'TextMessageBody', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'Keyword' => [ 'shape' => 'Keyword', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MaxPrice' => [ 'shape' => 'MaxPrice', ], 'TimeToLive' => [ 'shape' => 'TimeToLive', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DestinationCountryParameters' => [ 'shape' => 'DestinationCountryParameters', ], 'DryRun' => [ 'shape' => 'PrimitiveBoolean', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], ], ], 'SendTextMessageResult' => [ 'type' => 'structure', 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SendVoiceMessageRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', 'OriginationIdentity', ], 'members' => [ 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'OriginationIdentity' => [ 'shape' => 'VoiceMessageOriginationIdentity', ], 'MessageBody' => [ 'shape' => 'VoiceMessageBody', ], 'MessageBodyTextType' => [ 'shape' => 'VoiceMessageBodyTextType', ], 'VoiceId' => [ 'shape' => 'VoiceId', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MaxPricePerMinute' => [ 'shape' => 'MaxPrice', ], 'TimeToLive' => [ 'shape' => 'TimeToLive', ], 'Context' => [ 'shape' => 'ContextMap', ], 'DryRun' => [ 'shape' => 'PrimitiveBoolean', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], ], ], 'SendVoiceMessageResult' => [ 'type' => 'structure', 'members' => [ 'MessageId' => [ 'shape' => 'String', ], ], ], 'SenderId' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '[A-Za-z0-9_-]+', ], 'SenderIdAndCountry' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], ], ], 'SenderIdFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'SenderIdFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'SenderIdFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SenderIdFilter', ], 'max' => 20, 'min' => 0, ], 'SenderIdFilterName' => [ 'type' => 'string', 'enum' => [ 'sender-id', 'iso-country-code', 'message-type', 'deletion-protection-enabled', 'registered', ], ], 'SenderIdInformation' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'DeletionProtectionEnabled', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], ], ], 'SenderIdInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SenderIdInformation', ], ], 'SenderIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SenderIdAndCountry', ], 'max' => 5, 'min' => 0, ], 'SenderIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'ServiceQuotaExceededExceptionReason', ], ], 'exception' => true, ], 'ServiceQuotaExceededExceptionReason' => [ 'type' => 'string', 'enum' => [ 'ASSOCIATIONS_PER_REGISTRATION', 'CONFIGURATION_SETS_PER_ACCOUNT', 'DAILY_DESTINATION_CALL_LIMIT', 'EVENT_DESTINATIONS_PER_CONFIGURATION_SET', 'KEYWORDS_PER_PHONE_NUMBER', 'KEYWORDS_PER_POOL', 'MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA', 'MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT', 'MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE', 'OPT_OUT_LISTS_PER_ACCOUNT', 'ORIGINATION_IDENTITIES_PER_POOL', 'PHONE_NUMBERS_PER_ACCOUNT', 'PHONE_NUMBERS_PER_REGISTRATION', 'POOLS_PER_ACCOUNT', 'REGISTRATION_ATTACHMENTS_CREATED_PER_DAY', 'REGISTRATION_ATTACHMENTS_PER_ACCOUNT', 'REGISTRATION_VERSIONS_CREATED_PER_DAY', 'REGISTRATIONS_PER_ACCOUNT', 'SENDER_IDS_PER_ACCOUNT', 'TAGS_PER_RESOURCE', 'VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT', 'VERIFICATION_ATTEMPTS_PER_DAY', 'PROTECT_CONFIGURATIONS_PER_ACCOUNT', ], ], 'SetAccountDefaultProtectConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], ], ], 'SetAccountDefaultProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'DefaultProtectConfigurationArn', 'DefaultProtectConfigurationId', ], 'members' => [ 'DefaultProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'DefaultProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], ], ], 'SetDefaultMessageTypeRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'MessageType', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'MessageType' => [ 'shape' => 'MessageType', ], ], ], 'SetDefaultMessageTypeResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'MessageType' => [ 'shape' => 'MessageType', ], ], ], 'SetDefaultSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'SenderId', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'SenderId' => [ 'shape' => 'SenderId', ], ], ], 'SetDefaultSenderIdResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'SenderId' => [ 'shape' => 'SenderId', ], ], ], 'SetMediaMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'MonthlyLimit', ], 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetMediaMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetTextMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'MonthlyLimit', ], 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetTextMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetVoiceMessageSpendLimitOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'MonthlyLimit', ], 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SetVoiceMessageSpendLimitOverrideResult' => [ 'type' => 'structure', 'members' => [ 'MonthlyLimit' => [ 'shape' => 'MonthlyLimit', ], ], ], 'SnsDestination' => [ 'type' => 'structure', 'required' => [ 'TopicArn', ], 'members' => [ 'TopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:\\S+', ], 'SpendLimit' => [ 'type' => 'structure', 'required' => [ 'Name', 'EnforcedLimit', 'MaxLimit', 'Overridden', ], 'members' => [ 'Name' => [ 'shape' => 'SpendLimitName', ], 'EnforcedLimit' => [ 'shape' => 'PrimitiveLong', ], 'MaxLimit' => [ 'shape' => 'PrimitiveLong', ], 'Overridden' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'SpendLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpendLimit', ], ], 'SpendLimitName' => [ 'type' => 'string', 'enum' => [ 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT', 'VOICE_MESSAGE_MONTHLY_SPEND_LIMIT', 'MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT', ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SubmitRegistrationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'RegistrationId', ], 'members' => [ 'RegistrationId' => [ 'shape' => 'RegistrationIdOrArn', ], ], ], 'SubmitRegistrationVersionResult' => [ 'type' => 'structure', 'required' => [ 'RegistrationArn', 'RegistrationId', 'VersionNumber', 'RegistrationVersionStatus', 'RegistrationVersionStatusHistory', ], 'members' => [ 'RegistrationArn' => [ 'shape' => 'String', ], 'RegistrationId' => [ 'shape' => 'String', ], 'VersionNumber' => [ 'shape' => 'RegistrationVersionNumber', ], 'RegistrationVersionStatus' => [ 'shape' => 'RegistrationVersionStatus', ], 'RegistrationVersionStatusHistory' => [ 'shape' => 'RegistrationVersionStatusHistory', ], ], ], 'SupportedAssociation' => [ 'type' => 'structure', 'required' => [ 'ResourceType', 'AssociationBehavior', 'DisassociationBehavior', ], 'members' => [ 'ResourceType' => [ 'shape' => 'String', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'AssociationBehavior' => [ 'shape' => 'RegistrationAssociationBehavior', ], 'DisassociationBehavior' => [ 'shape' => 'RegistrationDisassociationBehavior', ], ], ], 'SupportedAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedAssociation', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.+', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'NonEmptyTagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'TextMessageBody' => [ 'type' => 'string', 'max' => 1600, 'min' => 1, 'pattern' => '(?!\\s*$)[\\s\\S]+', ], 'TextMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], 'TextValidation' => [ 'type' => 'structure', 'required' => [ 'MinLength', 'MaxLength', 'Pattern', ], 'members' => [ 'MinLength' => [ 'shape' => 'Integer', ], 'MaxLength' => [ 'shape' => 'Integer', ], 'Pattern' => [ 'shape' => 'String', ], ], ], 'TextValue' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'TimeToLive' => [ 'type' => 'integer', 'box' => true, 'max' => 259200, 'min' => 5, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TwoWayChannelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '\\S+', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [], ], 'UpdateEventDestinationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationSetName', 'EventDestinationName', ], 'members' => [ 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetNameOrArn', ], 'EventDestinationName' => [ 'shape' => 'EventDestinationName', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'MatchingEventTypes' => [ 'shape' => 'EventTypeList', ], 'CloudWatchLogsDestination' => [ 'shape' => 'CloudWatchLogsDestination', ], 'KinesisFirehoseDestination' => [ 'shape' => 'KinesisFirehoseDestination', ], 'SnsDestination' => [ 'shape' => 'SnsDestination', ], ], ], 'UpdateEventDestinationResult' => [ 'type' => 'structure', 'members' => [ 'ConfigurationSetArn' => [ 'shape' => 'String', ], 'ConfigurationSetName' => [ 'shape' => 'ConfigurationSetName', ], 'EventDestination' => [ 'shape' => 'EventDestination', ], ], ], 'UpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberIdOrArn', ], 'TwoWayEnabled' => [ 'shape' => 'Boolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'Boolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdatePhoneNumberResult' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberArn' => [ 'shape' => 'String', ], 'PhoneNumberId' => [ 'shape' => 'String', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'NumberStatus', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'NumberCapabilities' => [ 'shape' => 'NumberCapabilityList', ], 'NumberType' => [ 'shape' => 'NumberType', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'UpdatePoolRequest' => [ 'type' => 'structure', 'required' => [ 'PoolId', ], 'members' => [ 'PoolId' => [ 'shape' => 'PoolIdOrArn', ], 'TwoWayEnabled' => [ 'shape' => 'Boolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'Boolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListNameOrArn', ], 'SharedRoutesEnabled' => [ 'shape' => 'Boolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdatePoolResult' => [ 'type' => 'structure', 'members' => [ 'PoolArn' => [ 'shape' => 'String', ], 'PoolId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'PoolStatus', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'TwoWayEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'TwoWayChannelArn' => [ 'shape' => 'TwoWayChannelArn', ], 'TwoWayChannelRole' => [ 'shape' => 'IamRoleArn', ], 'SelfManagedOptOutsEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'OptOutListName' => [ 'shape' => 'OptOutListName', ], 'SharedRoutesEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateProtectConfigurationCountryRuleSetRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', 'NumberCapability', 'CountryRuleSetUpdates', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], 'NumberCapability' => [ 'shape' => 'NumberCapability', ], 'CountryRuleSetUpdates' => [ 'shape' => 'ProtectConfigurationCountryRuleSet', ], ], ], 'UpdateProtectConfigurationCountryRuleSetResult' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationArn', 'ProtectConfigurationId', 'NumberCapability', 'CountryRuleSet', ], 'members' => [ 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], 'NumberCapability' => [ 'shape' => 'NumberCapability', ], 'CountryRuleSet' => [ 'shape' => 'ProtectConfigurationCountryRuleSet', ], ], ], 'UpdateProtectConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationId', ], 'members' => [ 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationIdOrArn', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdateProtectConfigurationResult' => [ 'type' => 'structure', 'required' => [ 'ProtectConfigurationArn', 'ProtectConfigurationId', 'CreatedTimestamp', 'AccountDefault', 'DeletionProtectionEnabled', ], 'members' => [ 'ProtectConfigurationArn' => [ 'shape' => 'ProtectConfigurationArn', ], 'ProtectConfigurationId' => [ 'shape' => 'ProtectConfigurationId', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], 'AccountDefault' => [ 'shape' => 'PrimitiveBoolean', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], ], ], 'UpdateSenderIdRequest' => [ 'type' => 'structure', 'required' => [ 'SenderId', 'IsoCountryCode', ], 'members' => [ 'SenderId' => [ 'shape' => 'SenderIdOrArn', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'DeletionProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdateSenderIdResult' => [ 'type' => 'structure', 'required' => [ 'SenderIdArn', 'SenderId', 'IsoCountryCode', 'MessageTypes', 'MonthlyLeasingPrice', 'DeletionProtectionEnabled', 'Registered', ], 'members' => [ 'SenderIdArn' => [ 'shape' => 'String', ], 'SenderId' => [ 'shape' => 'SenderId', ], 'IsoCountryCode' => [ 'shape' => 'IsoCountryCode', ], 'MessageTypes' => [ 'shape' => 'MessageTypeList', ], 'MonthlyLeasingPrice' => [ 'shape' => 'String', ], 'DeletionProtectionEnabled' => [ 'shape' => 'PrimitiveBoolean', ], 'Registered' => [ 'shape' => 'PrimitiveBoolean', ], 'RegistrationId' => [ 'shape' => 'String', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'ValidationExceptionReason', ], 'Fields' => [ 'shape' => 'ValidationExceptionFieldList', ], ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'Name', 'Message', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CANNOT_ADD_OPTED_OUT_NUMBER', 'CANNOT_PARSE', 'COUNTRY_CODE_MISMATCH', 'DESTINATION_COUNTRY_BLOCKED', 'FIELD_VALIDATION_FAILED', 'ATTACHMENT_TYPE_NOT_SUPPORTED', 'INVALID_ARN', 'INVALID_FILTER_VALUES', 'INVALID_IDENTITY_FOR_DESTINATION_COUNTRY', 'INVALID_NEXT_TOKEN', 'INVALID_PARAMETER', 'INVALID_REQUEST', 'INVALID_REGISTRATION_ASSOCIATION', 'MAXIMUM_SIZE_EXCEEDED', 'MEDIA_TYPE_NOT_SUPPORTED', 'MISSING_PARAMETER', 'PARAMETERS_CANNOT_BE_USED_TOGETHER', 'PHONE_NUMBER_CANNOT_BE_OPTED_IN', 'PHONE_NUMBER_CANNOT_BE_RELEASED', 'PRICE_OVER_THRESHOLD', 'RESOURCE_NOT_ACCESSIBLE', 'REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT', 'SENDER_ID_NOT_REGISTERED', 'SENDER_ID_NOT_SUPPORTED', 'SENDER_ID_REQUIRES_REGISTRATION', 'TWO_WAY_TOPIC_NOT_PRESENT', 'TWO_WAY_NOT_ENABLED', 'TWO_WAY_NOT_SUPPORTED_IN_COUNTRY', 'TWO_WAY_NOT_SUPPORTED_IN_REGION', 'TWO_WAY_CHANNEL_NOT_PRESENT', 'UNKNOWN_REGISTRATION_FIELD', 'UNKNOWN_REGISTRATION_SECTION', 'UNKNOWN_REGISTRATION_TYPE', 'UNKNOWN_REGISTRATION_VERSION', 'UNKNOWN_OPERATION', 'REGISTRATION_FIELD_CANNOT_BE_DELETED', 'VERIFICATION_CODE_MISMATCH', 'VOICE_CAPABILITY_NOT_AVAILABLE', 'OTHER', ], ], 'VerificationChannel' => [ 'type' => 'string', 'enum' => [ 'TEXT', 'VOICE', ], ], 'VerificationCode' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '[A-Za-z0-9]+', ], 'VerificationMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], 'VerificationStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'VERIFIED', ], ], 'VerifiedDestinationNumberFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'VerifiedDestinationNumberFilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'VerifiedDestinationNumberFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedDestinationNumberFilter', ], 'max' => 20, 'min' => 0, ], 'VerifiedDestinationNumberFilterName' => [ 'type' => 'string', 'enum' => [ 'status', ], ], 'VerifiedDestinationNumberIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], 'max' => 5, 'min' => 0, ], 'VerifiedDestinationNumberIdOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/-]+', ], 'VerifiedDestinationNumberInformation' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'Status', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'VerificationStatus', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'VerifiedDestinationNumberInformationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VerifiedDestinationNumberInformation', ], ], 'VerifyDestinationNumberRequest' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberId', 'VerificationCode', ], 'members' => [ 'VerifiedDestinationNumberId' => [ 'shape' => 'VerifiedDestinationNumberIdOrArn', ], 'VerificationCode' => [ 'shape' => 'VerificationCode', ], ], ], 'VerifyDestinationNumberResult' => [ 'type' => 'structure', 'required' => [ 'VerifiedDestinationNumberArn', 'VerifiedDestinationNumberId', 'DestinationPhoneNumber', 'Status', 'CreatedTimestamp', ], 'members' => [ 'VerifiedDestinationNumberArn' => [ 'shape' => 'String', ], 'VerifiedDestinationNumberId' => [ 'shape' => 'String', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'Status' => [ 'shape' => 'VerificationStatus', ], 'CreatedTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'VoiceId' => [ 'type' => 'string', 'enum' => [ 'AMY', 'ASTRID', 'BIANCA', 'BRIAN', 'CAMILA', 'CARLA', 'CARMEN', 'CELINE', 'CHANTAL', 'CONCHITA', 'CRISTIANO', 'DORA', 'EMMA', 'ENRIQUE', 'EWA', 'FILIZ', 'GERAINT', 'GIORGIO', 'GWYNETH', 'HANS', 'INES', 'IVY', 'JACEK', 'JAN', 'JOANNA', 'JOEY', 'JUSTIN', 'KARL', 'KENDRA', 'KIMBERLY', 'LEA', 'LIV', 'LOTTE', 'LUCIA', 'LUPE', 'MADS', 'MAJA', 'MARLENE', 'MATHIEU', 'MATTHEW', 'MAXIM', 'MIA', 'MIGUEL', 'MIZUKI', 'NAJA', 'NICOLE', 'PENELOPE', 'RAVEENA', 'RICARDO', 'RUBEN', 'RUSSELL', 'SALLI', 'SEOYEON', 'TAKUMI', 'TATYANA', 'VICKI', 'VITORIA', 'ZEINA', 'ZHIYU', ], ], 'VoiceMessageBody' => [ 'type' => 'string', 'max' => 6000, 'min' => 1, 'pattern' => '(?!\\s*$)[\\s\\S]+', ], 'VoiceMessageBodyTextType' => [ 'type' => 'string', 'enum' => [ 'TEXT', 'SSML', ], ], 'VoiceMessageOriginationIdentity' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[A-Za-z0-9_:/\\+-]+', ], ],]; diff --git a/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json b/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json index b3fc0bb3c4..e6487ac2a6 100644 --- a/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json +++ b/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json @@ -1,25 +1,30 @@ { "version": "2.0", - "service": "

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

", + "service": "

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint SMS, it's also helpful to review the Amazon Pinpoint SMS User Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

", "operations": { "AssociateOriginationIdentity": "

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an error is returned.

", + "AssociateProtectConfiguration": "

Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.

", "CreateConfigurationSet": "

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

", "CreateEventDestination": "

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

", "CreateOptOutList": "

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.

", "CreatePool": "

Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

", + "CreateProtectConfiguration": "

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

", "CreateRegistration": "

Creates a new registration based on the RegistrationType field.

", "CreateRegistrationAssociation": "

Associate the registration with an origination identity such as a phone number or sender ID.

", "CreateRegistrationAttachment": "

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

", "CreateRegistrationVersion": "

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

", "CreateVerifiedDestinationNumber": "

You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.

", + "DeleteAccountDefaultProtectConfiguration": "

Removes the current account default protect configuration.

", "DeleteConfigurationSet": "

Deletes an existing configuration set.

A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

", "DeleteDefaultMessageType": "

Deletes an existing default message type on a configuration set.

A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

", "DeleteDefaultSenderId": "

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

", "DeleteEventDestination": "

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

", "DeleteKeyword": "

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords \"HELP\" and \"STOP\" can't be deleted or modified.

", + "DeleteMediaMessageSpendLimitOverride": "

Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.

", "DeleteOptOutList": "

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.

", "DeleteOptedOutNumber": "

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.

", "DeletePool": "

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn't active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

", + "DeleteProtectConfiguration": "

Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.

", "DeleteRegistration": "

Permanently delete an existing registration from your account.

", "DeleteRegistrationAttachment": "

Permanently delete the specified registration attachment.

", "DeleteRegistrationFieldValue": "

Delete the value in a registration form field.

", @@ -34,6 +39,7 @@ "DescribeOptedOutNumbers": "

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an error is returned.

", "DescribePhoneNumbers": "

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

", "DescribePools": "

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn't valid, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

", + "DescribeProtectConfigurations": "

Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

", "DescribeRegistrationAttachments": "

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

", "DescribeRegistrationFieldDefinitions": "

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

", "DescribeRegistrationFieldValues": "

Retrieves the specified registration field values.

", @@ -45,7 +51,9 @@ "DescribeSpendLimits": "

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

", "DescribeVerifiedDestinationNumbers": "

Retrieves the specified verified destiona numbers.

", "DisassociateOriginationIdentity": "

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an error is returned.

", + "DisassociateProtectConfiguration": "

Disassociate a protect configuration from a configuration set.

", "DiscardRegistrationVersion": "

Discard the current version of the registration.

", + "GetProtectConfigurationCountryRuleSet": "

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

", "ListPoolOriginationIdentities": "

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

", "ListRegistrationAssociations": "

Retreive all of the origination identies that are associated with a registration.

", "ListTagsForResource": "

List all tags associated with a resource.

", @@ -57,10 +65,13 @@ "RequestPhoneNumber": "

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.

", "RequestSenderId": "

Request a new sender ID that doesn't require registration.

", "SendDestinationNumberVerificationCode": "

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.

", + "SendMediaMessage": "

Creates a new multimedia message (MMS) and sends it to a recipient's phone number.

", "SendTextMessage": "

Creates a new text message and sends it to a recipient's phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

", "SendVoiceMessage": "

Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.

", + "SetAccountDefaultProtectConfiguration": "

Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.

", "SetDefaultMessageType": "

Sets the default message type on a configuration set.

Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

", "SetDefaultSenderId": "

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

", + "SetMediaMessageSpendLimitOverride": "

Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

", "SetTextMessageSpendLimitOverride": "

Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

", "SetVoiceMessageSpendLimitOverride": "

Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

", "SubmitRegistrationVersion": "

Submit the specified registration for review and approval.

", @@ -69,6 +80,8 @@ "UpdateEventDestination": "

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

", "UpdatePhoneNumber": "

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an error is returned.

", "UpdatePool": "

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

", + "UpdateProtectConfiguration": "

Update the setting for an existing protect configuration.

", + "UpdateProtectConfigurationCountryRuleSet": "

Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.

", "UpdateSenderId": "

Updates the configuration of an existing sender ID.

", "VerifyDestinationNumber": "

Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

" }, @@ -139,6 +152,16 @@ "refs": { } }, + "AssociateProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "AssociateProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "AttachmentBody": { "base": null, "refs": { @@ -170,6 +193,7 @@ "base": null, "refs": { "CreatePoolRequest$DeletionProtectionEnabled": "

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

", + "CreateProtectConfigurationRequest$DeletionProtectionEnabled": "

When set to true deletion protection is enabled. By default this is set to false.

", "EventDestination$Enabled": "

When set to true events will be logged.

", "RequestPhoneNumberRequest$DeletionProtectionEnabled": "

By default this is set to false. When set to true the phone number can't be deleted.

", "RequestSenderIdRequest$DeletionProtectionEnabled": "

By default this is set to false. When set to true the sender ID can't be deleted.

", @@ -181,6 +205,7 @@ "UpdatePoolRequest$SelfManagedOptOutsEnabled": "

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

", "UpdatePoolRequest$SharedRoutesEnabled": "

Indicates whether shared routes are enabled for the pool.

", "UpdatePoolRequest$DeletionProtectionEnabled": "

When set to true the pool can't be deleted.

", + "UpdateProtectConfigurationRequest$DeletionProtectionEnabled": "

When set to true deletion protection is enabled. By default this is set to false.

", "UpdateSenderIdRequest$DeletionProtectionEnabled": "

By default this is set to false. When set to true the sender ID can't be deleted.

" } }, @@ -192,6 +217,7 @@ "CreateEventDestinationRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", "CreateOptOutListRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", "CreatePoolRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", + "CreateProtectConfigurationRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", "CreateRegistrationAttachmentRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", "CreateRegistrationRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", "CreateVerifiedDestinationNumberRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

", @@ -203,7 +229,7 @@ "CloudWatchLogsDestination": { "base": "

Contains the destination configuration to use when publishing message sending events.

", "refs": { - "CreateEventDestinationRequest$CloudWatchLogsDestination": "

An object that contains information about an event destination for logging to Amazon CloudWatch logs.

", + "CreateEventDestinationRequest$CloudWatchLogsDestination": "

An object that contains information about an event destination for logging to Amazon CloudWatch Logs.

", "EventDestination$CloudWatchLogsDestination": "

An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

", "UpdateEventDestinationRequest$CloudWatchLogsDestination": "

An object that contains information about an event destination that sends data to CloudWatch Logs.

" } @@ -241,6 +267,7 @@ "ConfigurationSetName": { "base": null, "refs": { + "AssociateProtectConfigurationResult$ConfigurationSetName": "

The name of the ConfigurationSet.

", "ConfigurationSetInformation$ConfigurationSetName": "

The name of the ConfigurationSet.

", "CreateConfigurationSetRequest$ConfigurationSetName": "

The name to use for the new configuration set.

", "CreateConfigurationSetResult$ConfigurationSetName": "

The name of the new configuration set.

", @@ -249,6 +276,7 @@ "DeleteDefaultMessageTypeResult$ConfigurationSetName": "

The name of the configuration set.

", "DeleteDefaultSenderIdResult$ConfigurationSetName": "

The name of the configuration set.

", "DeleteEventDestinationResult$ConfigurationSetName": "

The name of the configuration set the event destination was deleted from.

", + "DisassociateProtectConfigurationResult$ConfigurationSetName": "

The name of the ConfigurationSet.

", "SetDefaultMessageTypeResult$ConfigurationSetName": "

The name of the configuration set that was updated.

", "SetDefaultSenderIdResult$ConfigurationSetName": "

The name of the configuration set that was updated.

", "UpdateEventDestinationResult$ConfigurationSetName": "

The name of the configuration set.

" @@ -263,13 +291,16 @@ "ConfigurationSetNameOrArn": { "base": null, "refs": { + "AssociateProtectConfigurationRequest$ConfigurationSetName": "

The name of the ConfigurationSet.

", "ConfigurationSetNameList$member": null, "CreateEventDestinationRequest$ConfigurationSetName": "

Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

", "DeleteConfigurationSetRequest$ConfigurationSetName": "

The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

", "DeleteDefaultMessageTypeRequest$ConfigurationSetName": "

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

", "DeleteDefaultSenderIdRequest$ConfigurationSetName": "

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

", "DeleteEventDestinationRequest$ConfigurationSetName": "

The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

", + "DisassociateProtectConfigurationRequest$ConfigurationSetName": "

The name of the ConfigurationSet.

", "SendDestinationNumberVerificationCodeRequest$ConfigurationSetName": "

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

", + "SendMediaMessageRequest$ConfigurationSetName": "

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

", "SendTextMessageRequest$ConfigurationSetName": "

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

", "SendVoiceMessageRequest$ConfigurationSetName": "

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

", "SetDefaultMessageTypeRequest$ConfigurationSetName": "

The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

", @@ -298,6 +329,7 @@ "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$Context": "

You can specify custom data in this field. If you do, that data is logged to the event destination.

", + "SendMediaMessageRequest$Context": "

You can specify custom data in this field. If you do, that data is logged to the event destination.

", "SendTextMessageRequest$Context": "

You can specify custom data in this field. If you do, that data is logged to the event destination.

", "SendVoiceMessageRequest$Context": "

You can specify custom data in this field. If you do, that data is logged to the event destination.

" } @@ -348,6 +380,16 @@ "refs": { } }, + "CreateProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "CreateProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "CreateRegistrationAssociationRequest": { "base": null, "refs": { @@ -398,6 +440,16 @@ "refs": { } }, + "DeleteAccountDefaultProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DeleteAccountDefaultProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "DeleteConfigurationSetRequest": { "base": null, "refs": { @@ -448,6 +500,16 @@ "refs": { } }, + "DeleteMediaMessageSpendLimitOverrideRequest": { + "base": null, + "refs": { + } + }, + "DeleteMediaMessageSpendLimitOverrideResult": { + "base": null, + "refs": { + } + }, "DeleteOptOutListRequest": { "base": null, "refs": { @@ -478,6 +540,16 @@ "refs": { } }, + "DeleteProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DeleteProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "DeleteRegistrationAttachmentRequest": { "base": null, "refs": { @@ -624,6 +696,16 @@ "refs": { } }, + "DescribeProtectConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeProtectConfigurationsResult": { + "base": null, + "refs": { + } + }, "DescribeRegistrationAttachmentsRequest": { "base": null, "refs": { @@ -759,6 +841,16 @@ "refs": { } }, + "DisassociateProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DisassociateProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "DiscardRegistrationVersionRequest": { "base": null, "refs": { @@ -770,7 +862,7 @@ } }, "EventDestination": { - "base": "

Contains information about an event destination.

Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.

", + "base": "

Contains information about an event destination.

Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.

", "refs": { "CreateEventDestinationResult$EventDestination": "

The details of the destination where events are logged.

", "DeleteEventDestinationResult$EventDestination": "

The event destination object that was deleted.

", @@ -854,6 +946,7 @@ "PhoneNumberFilter$Values": "

An array values to filter for.

", "PoolFilter$Values": "

An array values to filter for.

", "PoolOriginationIdentitiesFilter$Values": "

An array values to filter for.

", + "ProtectConfigurationFilter$Values": "

An array of values to filter for.

", "RegistrationAssociationFilter$Values": "

An array of values to filter for.

", "RegistrationAttachmentFilter$Values": "

An array of values to filter on.

", "RegistrationFilter$Values": "

An array of values to filter on.

", @@ -863,13 +956,23 @@ "VerifiedDestinationNumberFilter$Values": "

An array of values to filter on.

" } }, + "GetProtectConfigurationCountryRuleSetRequest": { + "base": null, + "refs": { + } + }, + "GetProtectConfigurationCountryRuleSetResult": { + "base": null, + "refs": { + } + }, "IamRoleArn": { "base": null, "refs": { - "CloudWatchLogsDestination$IamRoleArn": "

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.

", + "CloudWatchLogsDestination$IamRoleArn": "

The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.

", "CreatePoolResult$TwoWayChannelRole": "

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

", "DeletePoolResult$TwoWayChannelRole": "

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

", - "KinesisFirehoseDestination$IamRoleArn": "

The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

", + "KinesisFirehoseDestination$IamRoleArn": "

The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.

", "PhoneNumberInformation$TwoWayChannelRole": "

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

", "PoolInformation$TwoWayChannelRole": "

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

", "ReleasePhoneNumberResult$TwoWayChannelRole": "

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

", @@ -905,6 +1008,7 @@ "DisassociateOriginationIdentityResult$IsoCountryCode": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

", "OriginationIdentityMetadata$IsoCountryCode": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

", "PhoneNumberInformation$IsoCountryCode": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

", + "ProtectConfigurationCountryRuleSet$key": null, "RegistrationAssociationMetadata$IsoCountryCode": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

", "ReleasePhoneNumberResult$IsoCountryCode": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

", "ReleaseSenderIdRequest$IsoCountryCode": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

", @@ -988,7 +1092,7 @@ } }, "KinesisFirehoseDestination": { - "base": "

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.

Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.

", + "base": "

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event destination.

Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.

", "refs": { "CreateEventDestinationRequest$KinesisFirehoseDestination": "

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

", "EventDestination$KinesisFirehoseDestination": "

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

", @@ -1040,6 +1144,7 @@ "MaxPrice": { "base": null, "refs": { + "SendMediaMessageRequest$MaxPrice": "

The maximum amount that you want to spend, in US dollars, per each MMS message.

", "SendTextMessageRequest$MaxPrice": "

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

", "SendVoiceMessageRequest$MaxPricePerMinute": "

The maximum amount to spend per voice message, in US dollars.

" } @@ -1055,6 +1160,7 @@ "DescribeOptedOutNumbersRequest$MaxResults": "

The maximum number of results to return per each request.

", "DescribePhoneNumbersRequest$MaxResults": "

The maximum number of results to return per each request.

", "DescribePoolsRequest$MaxResults": "

The maximum number of results to return per each request.

", + "DescribeProtectConfigurationsRequest$MaxResults": "

The maximum number of results to return per each request.

", "DescribeRegistrationAttachmentsRequest$MaxResults": "

The maximum number of results to return per each request.

", "DescribeRegistrationFieldDefinitionsRequest$MaxResults": "

The maximum number of results to return per each request.

", "DescribeRegistrationFieldValuesRequest$MaxResults": "

The maximum number of results to return per each request.

", @@ -1069,6 +1175,24 @@ "ListRegistrationAssociationsRequest$MaxResults": "

The maximum number of results to return per each request.

" } }, + "MediaMessageOriginationIdentity": { + "base": null, + "refs": { + "SendMediaMessageRequest$OriginationIdentity": "

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

" + } + }, + "MediaUrlList": { + "base": null, + "refs": { + "SendMediaMessageRequest$MediaUrls": "

An array of URLs to each media file to send.

The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.

" + } + }, + "MediaUrlValue": { + "base": null, + "refs": { + "MediaUrlList$member": null + } + }, "MessageType": { "base": null, "refs": { @@ -1104,8 +1228,11 @@ "MonthlyLimit": { "base": null, "refs": { + "DeleteMediaMessageSpendLimitOverrideResult$MonthlyLimit": "

The current monthly limit, in US dollars.

", "DeleteTextMessageSpendLimitOverrideResult$MonthlyLimit": "

The current monthly limit, in US dollars.

", "DeleteVoiceMessageSpendLimitOverrideResult$MonthlyLimit": "

The current monthly limit, in US dollars.

", + "SetMediaMessageSpendLimitOverrideRequest$MonthlyLimit": "

The new monthly limit to enforce on text messages.

", + "SetMediaMessageSpendLimitOverrideResult$MonthlyLimit": "

The current monthly limit to enforce on sending text messages.

", "SetTextMessageSpendLimitOverrideRequest$MonthlyLimit": "

The new monthly limit to enforce on text messages.

", "SetTextMessageSpendLimitOverrideResult$MonthlyLimit": "

The current monthly limit to enforce on sending text messages.

", "SetVoiceMessageSpendLimitOverrideRequest$MonthlyLimit": "

The new monthly limit to enforce on voice messages.

", @@ -1131,6 +1258,8 @@ "DescribePhoneNumbersResult$NextToken": "

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

", "DescribePoolsRequest$NextToken": "

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

", "DescribePoolsResult$NextToken": "

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

", + "DescribeProtectConfigurationsRequest$NextToken": "

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

", + "DescribeProtectConfigurationsResult$NextToken": "

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

", "DescribeRegistrationAttachmentsRequest$NextToken": "

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

", "DescribeRegistrationAttachmentsResult$NextToken": "

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

", "DescribeRegistrationFieldDefinitionsRequest$NextToken": "

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

", @@ -1166,7 +1295,11 @@ "NumberCapability": { "base": null, "refs": { - "NumberCapabilityList$member": null + "GetProtectConfigurationCountryRuleSetRequest$NumberCapability": "

The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.

", + "GetProtectConfigurationCountryRuleSetResult$NumberCapability": "

The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.

", + "NumberCapabilityList$member": null, + "UpdateProtectConfigurationCountryRuleSetRequest$NumberCapability": "

The number capability to apply the CountryRuleSetUpdates updates to.

", + "UpdateProtectConfigurationCountryRuleSetResult$NumberCapability": "

The number capability that was updated

" } }, "NumberCapabilityList": { @@ -1315,6 +1448,7 @@ "RegistrationAssociationMetadata$PhoneNumber": "

The phone number associated with the registration in E.164 format.

", "ReleasePhoneNumberResult$PhoneNumber": "

The phone number that was released.

", "RequestPhoneNumberResult$PhoneNumber": "

The new phone number that was requested.

", + "SendMediaMessageRequest$DestinationPhoneNumber": "

The destination phone number in E.164 format.

", "SendTextMessageRequest$DestinationPhoneNumber": "

The destination phone number in E.164 format.

", "SendVoiceMessageRequest$DestinationPhoneNumber": "

The destination phone number in E.164 format.

", "UpdatePhoneNumberResult$PhoneNumber": "

The phone number that was updated.

", @@ -1464,10 +1598,14 @@ "CreatePoolResult$SelfManagedOptOutsEnabled": "

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

", "CreatePoolResult$SharedRoutesEnabled": "

Indicates whether shared routes are enabled for the pool.

", "CreatePoolResult$DeletionProtectionEnabled": "

When set to true deletion protection is enabled. By default this is set to false.

", + "CreateProtectConfigurationResult$AccountDefault": "

This is true if the protect configuration is set as your account default protect configuration.

", + "CreateProtectConfigurationResult$DeletionProtectionEnabled": "

When set to true deletion protection is enabled. By default this is set to false.

", "DeleteOptedOutNumberResult$EndUserOptedOut": "

This is true if it was the end user who requested their phone number be removed.

", "DeletePoolResult$TwoWayEnabled": "

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

", "DeletePoolResult$SelfManagedOptOutsEnabled": "

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

", "DeletePoolResult$SharedRoutesEnabled": "

Indicates whether shared routes are enabled for the pool.

", + "DeleteProtectConfigurationResult$AccountDefault": "

This is true if the protect configuration is set as your account default protect configuration.

", + "DeleteProtectConfigurationResult$DeletionProtectionEnabled": "

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

", "OptedOutNumberInformation$EndUserOptedOut": "

This is set to true if it was the end recipient that opted out.

", "PhoneNumberInformation$TwoWayEnabled": "

By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

", "PhoneNumberInformation$SelfManagedOptOutsEnabled": "

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

", @@ -1476,6 +1614,8 @@ "PoolInformation$SelfManagedOptOutsEnabled": "

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs

", "PoolInformation$SharedRoutesEnabled": "

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

", "PoolInformation$DeletionProtectionEnabled": "

When set to true the pool can't be deleted.

", + "ProtectConfigurationInformation$AccountDefault": "

This is true if the protect configuration is set as your account default protect configuration.

", + "ProtectConfigurationInformation$DeletionProtectionEnabled": "

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

", "PutOptedOutNumberResult$EndUserOptedOut": "

This is true if it was the end user who requested their phone number be removed.

", "ReleasePhoneNumberResult$TwoWayEnabled": "

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

", "ReleasePhoneNumberResult$SelfManagedOptOutsEnabled": "

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

", @@ -1485,6 +1625,7 @@ "RequestPhoneNumberResult$DeletionProtectionEnabled": "

By default this is set to false. When set to true the phone number can't be deleted.

", "RequestSenderIdResult$DeletionProtectionEnabled": "

By default this is set to false. When set to true the sender ID can't be deleted.

", "RequestSenderIdResult$Registered": "

True if the sender ID is registered.

", + "SendMediaMessageRequest$DryRun": "

When set to true, the message is checked and validated, but isn't sent to the end recipient.

", "SendTextMessageRequest$DryRun": "

When set to true, the message is checked and validated, but isn't sent to the end recipient.

", "SendVoiceMessageRequest$DryRun": "

When set to true, the message is checked and validated, but isn't sent to the end recipient.

", "SenderIdInformation$DeletionProtectionEnabled": "

By default this is set to false. When set to true the sender ID can't be deleted.

", @@ -1497,6 +1638,8 @@ "UpdatePoolResult$SelfManagedOptOutsEnabled": "

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

", "UpdatePoolResult$SharedRoutesEnabled": "

Indicates whether shared routes are enabled for the pool.

", "UpdatePoolResult$DeletionProtectionEnabled": "

When set to true the pool can't be deleted.

", + "UpdateProtectConfigurationResult$AccountDefault": "

This is true if the protect configuration is set as your account default protect configuration.

", + "UpdateProtectConfigurationResult$DeletionProtectionEnabled": "

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

", "UpdateSenderIdResult$DeletionProtectionEnabled": "

By default this is set to false. When set to true the sender ID can't be deleted.

", "UpdateSenderIdResult$Registered": "

True if the sender ID is registered..

" } @@ -1510,6 +1653,109 @@ "SpendLimit$MaxLimit": "

The maximum amount of money that you are able to spend to send messages each month, in US dollars.

" } }, + "ProtectConfigurationArn": { + "base": null, + "refs": { + "AssociateProtectConfigurationResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "CreateProtectConfigurationResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "DeleteAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the account default protect configuration.

", + "DeleteProtectConfigurationResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "DisassociateProtectConfigurationResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "GetProtectConfigurationCountryRuleSetResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "ProtectConfigurationInformation$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "SetAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the account default protect configuration.

", + "UpdateProtectConfigurationCountryRuleSetResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

", + "UpdateProtectConfigurationResult$ProtectConfigurationArn": "

The Amazon Resource Name (ARN) of the protect configuration.

" + } + }, + "ProtectConfigurationCountryRuleSet": { + "base": null, + "refs": { + "GetProtectConfigurationCountryRuleSetResult$CountryRuleSet": "

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

", + "UpdateProtectConfigurationCountryRuleSetRequest$CountryRuleSetUpdates": "

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

", + "UpdateProtectConfigurationCountryRuleSetResult$CountryRuleSet": "

An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.

" + } + }, + "ProtectConfigurationCountryRuleSetInformation": { + "base": "

The types of statuses that can be used.

", + "refs": { + "ProtectConfigurationCountryRuleSet$value": null + } + }, + "ProtectConfigurationFilter": { + "base": "

The filter definition for filtering protect configurations that meet a specified criteria.

", + "refs": { + "ProtectConfigurationFilterList$member": null + } + }, + "ProtectConfigurationFilterList": { + "base": null, + "refs": { + "DescribeProtectConfigurationsRequest$Filters": "

An array of ProtectConfigurationFilter objects to filter the results.

" + } + }, + "ProtectConfigurationFilterName": { + "base": null, + "refs": { + "ProtectConfigurationFilter$Name": "

The name of the attribute to filter on.

" + } + }, + "ProtectConfigurationId": { + "base": null, + "refs": { + "AssociateProtectConfigurationResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "CreateProtectConfigurationResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "DeleteAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationId": "

The unique identifier of the account default protect configuration.

", + "DeleteProtectConfigurationResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "DisassociateProtectConfigurationResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "GetProtectConfigurationCountryRuleSetResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "ProtectConfigurationInformation$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "SetAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationId": "

The unique identifier of the account default protect configuration.

", + "UpdateProtectConfigurationCountryRuleSetResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "UpdateProtectConfigurationResult$ProtectConfigurationId": "

The unique identifier for the protect configuration.

" + } + }, + "ProtectConfigurationIdList": { + "base": null, + "refs": { + "DescribeProtectConfigurationsRequest$ProtectConfigurationIds": "

An array of protect configuration identifiers to search for.

" + } + }, + "ProtectConfigurationIdOrArn": { + "base": null, + "refs": { + "AssociateProtectConfigurationRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "ConfigurationSetInformation$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "DeleteProtectConfigurationRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "DisassociateProtectConfigurationRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "GetProtectConfigurationCountryRuleSetRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "ProtectConfigurationIdList$member": null, + "SendMediaMessageRequest$ProtectConfigurationId": "

The unique identifier of the protect configuration to use.

", + "SendTextMessageRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "SendVoiceMessageRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "SetAccountDefaultProtectConfigurationRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "UpdateProtectConfigurationCountryRuleSetRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

", + "UpdateProtectConfigurationRequest$ProtectConfigurationId": "

The unique identifier for the protect configuration.

" + } + }, + "ProtectConfigurationInformation": { + "base": "

Provides information on the specified protect configuration.

", + "refs": { + "ProtectConfigurationInformationList$member": null + } + }, + "ProtectConfigurationInformationList": { + "base": null, + "refs": { + "DescribeProtectConfigurationsResult$ProtectConfigurations": "

An array of ProtectConfigurationInformation objects that contain the details for the request.

" + } + }, + "ProtectStatus": { + "base": null, + "refs": { + "ProtectConfigurationCountryRuleSetInformation$ProtectStatus": "

The types of protection that can be used.

" + } + }, "PutKeywordRequest": { "base": null, "refs": { @@ -2006,6 +2252,16 @@ "refs": { } }, + "SendMediaMessageRequest": { + "base": null, + "refs": { + } + }, + "SendMediaMessageResult": { + "base": null, + "refs": { + } + }, "SendTextMessageRequest": { "base": null, "refs": { @@ -2102,6 +2358,16 @@ "ServiceQuotaExceededException$Reason": "

The reason for the exception.

" } }, + "SetAccountDefaultProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "SetAccountDefaultProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "SetDefaultMessageTypeRequest": { "base": null, "refs": { @@ -2122,6 +2388,16 @@ "refs": { } }, + "SetMediaMessageSpendLimitOverrideRequest": { + "base": null, + "refs": { + } + }, + "SetMediaMessageSpendLimitOverrideResult": { + "base": null, + "refs": { + } + }, "SetTextMessageSpendLimitOverrideRequest": { "base": null, "refs": { @@ -2183,6 +2459,7 @@ "AssociateOriginationIdentityResult$PoolId": "

The PoolId of the pool that is now associated with the origination identity.

", "AssociateOriginationIdentityResult$OriginationIdentityArn": "

The PhoneNumberArn or SenderIdArn of the origination identity.

", "AssociateOriginationIdentityResult$OriginationIdentity": "

The PhoneNumberId or SenderId of the origination identity.

", + "AssociateProtectConfigurationResult$ConfigurationSetArn": "

The Amazon Resource Name (ARN) of the configuration set.

", "ConfigurationSetInformation$ConfigurationSetArn": "

The Resource Name (ARN) of the ConfigurationSet.

", "ConflictException$Message": null, "ConflictException$ResourceId": "

The unique identifier of the request.

", @@ -2234,6 +2511,7 @@ "DisassociateOriginationIdentityResult$PoolId": "

The PoolId of the pool no longer associated with the origination identity.

", "DisassociateOriginationIdentityResult$OriginationIdentityArn": "

The PhoneNumberArn or SenderIdArn of the origination identity.

", "DisassociateOriginationIdentityResult$OriginationIdentity": "

The PhoneNumberId or SenderId of the origination identity.

", + "DisassociateProtectConfigurationResult$ConfigurationSetArn": "

The Amazon Resource Name (ARN) of the configuration set.

", "DiscardRegistrationVersionResult$RegistrationArn": "

The Amazon Resource Name (ARN) for the registration.

", "DiscardRegistrationVersionResult$RegistrationId": "

The unique identifier for the registration.

", "InternalServerException$Message": null, @@ -2308,6 +2586,7 @@ "SelectOptionDescription$Title": "

The title of the select option.

", "SelectOptionDescription$Description": "

A description of the option meaning.

", "SendDestinationNumberVerificationCodeResult$MessageId": "

The unique identifier for the message.

", + "SendMediaMessageResult$MessageId": "

The unique identifier for the message.

", "SendTextMessageResult$MessageId": "

The unique identifier for the message.

", "SendVoiceMessageResult$MessageId": "

The unique identifier for the message.

", "SenderIdInformation$SenderIdArn": "

The Amazon Resource Name (ARN) associated with the SenderId.

", @@ -2408,6 +2687,8 @@ "CreateOptOutListResult$Tags": "

An array of tags (key and value pairs) associated with the new OptOutList.

", "CreatePoolRequest$Tags": "

An array of tags (key and value pairs) associated with the pool.

", "CreatePoolResult$Tags": "

An array of tags (key and value pairs) associated with the pool.

", + "CreateProtectConfigurationRequest$Tags": "

An array of key and value pair tags that are associated with the resource.

", + "CreateProtectConfigurationResult$Tags": "

An array of key and value pair tags that are associated with the resource.

", "CreateRegistrationAttachmentRequest$Tags": "

An array of tags (key and value pairs) to associate with the registration attachment.

", "CreateRegistrationAttachmentResult$Tags": "

An array of tags (key and value pairs) to associate with the registration attachment.

", "CreateRegistrationRequest$Tags": "

An array of tags (key and value pairs) to associate with the registration.

", @@ -2440,6 +2721,7 @@ "TextMessageBody": { "base": null, "refs": { + "SendMediaMessageRequest$MessageBody": "

The text body of the message.

", "SendTextMessageRequest$MessageBody": "

The body of the text message.

" } }, @@ -2472,6 +2754,7 @@ "TimeToLive": { "base": null, "refs": { + "SendMediaMessageRequest$TimeToLive": "

How long the text message is valid for. By default this is 72 hours.

", "SendTextMessageRequest$TimeToLive": "

How long the text message is valid for. By default this is 72 hours.

", "SendVoiceMessageRequest$TimeToLive": "

How long the voice message is valid for. By default this is 72 hours.

" } @@ -2483,6 +2766,7 @@ "CreateConfigurationSetResult$CreatedTimestamp": "

The time when the configuration set was created, in UNIX epoch time format.

", "CreateOptOutListResult$CreatedTimestamp": "

The time when the pool was created, in UNIX epoch time format.

", "CreatePoolResult$CreatedTimestamp": "

The time when the pool was created, in UNIX epoch time format.

", + "CreateProtectConfigurationResult$CreatedTimestamp": "

The time when the protect configuration was created, in UNIX epoch time format.

", "CreateRegistrationAttachmentResult$CreatedTimestamp": "

The time when the registration attachment was created, in UNIX epoch time format.

", "CreateRegistrationResult$CreatedTimestamp": "

The time when the registration was created, in UNIX epoch time format.

", "CreateVerifiedDestinationNumberResult$CreatedTimestamp": "

The time when the verified phone number was created, in UNIX epoch time format.

", @@ -2490,6 +2774,7 @@ "DeleteOptOutListResult$CreatedTimestamp": "

The time when the OptOutList was created, in UNIX epoch time format.

", "DeleteOptedOutNumberResult$OptedOutTimestamp": "

The time that the number was removed at, in UNIX epoch time format.

", "DeletePoolResult$CreatedTimestamp": "

The time when the pool was created, in UNIX epoch time format.

", + "DeleteProtectConfigurationResult$CreatedTimestamp": "

The time when the protect configuration was created, in UNIX epoch time format.

", "DeleteRegistrationAttachmentResult$CreatedTimestamp": "

The time when the registration attachment was created, in UNIX epoch time format.

", "DeleteRegistrationResult$CreatedTimestamp": "

The time when the registration was created, in UNIX epoch time format.

", "DeleteVerifiedDestinationNumberResult$CreatedTimestamp": "

The time when the destination phone number was created, in UNIX epoch time format.

", @@ -2497,6 +2782,7 @@ "OptedOutNumberInformation$OptedOutTimestamp": "

The time that the op tout occurred, in UNIX epoch time format.

", "PhoneNumberInformation$CreatedTimestamp": "

The time when the phone number was created, in UNIX epoch time format.

", "PoolInformation$CreatedTimestamp": "

The time when the pool was created, in UNIX epoch time format.

", + "ProtectConfigurationInformation$CreatedTimestamp": "

The time when the protect configuration was created, in UNIX epoch time format.

", "PutOptedOutNumberResult$OptedOutTimestamp": "

The time that the phone number was added to the OptOutList, in UNIX epoch time format.

", "RegistrationAttachmentsInformation$CreatedTimestamp": "

The time when the registration attachment was created, in UNIX epoch time format.

", "RegistrationInformation$CreatedTimestamp": "

The time when the registration was created, in UNIX epoch time format.

", @@ -2512,6 +2798,7 @@ "RequestPhoneNumberResult$CreatedTimestamp": "

The time when the phone number was created, in UNIX epoch time format.

", "UpdatePhoneNumberResult$CreatedTimestamp": "

The time when the phone number was created, in UNIX epoch time format.

", "UpdatePoolResult$CreatedTimestamp": "

The time when the pool was created, in UNIX epoch time format.

", + "UpdateProtectConfigurationResult$CreatedTimestamp": "

The time when the protect configuration was created, in UNIX epoch time format.

", "VerifiedDestinationNumberInformation$CreatedTimestamp": "

The time when the destination phone number was created, in UNIX epoch time format.

", "VerifyDestinationNumberResult$CreatedTimestamp": "

The time when the destination phone number was created, in UNIX epoch time format.

" } @@ -2571,6 +2858,26 @@ "refs": { } }, + "UpdateProtectConfigurationCountryRuleSetRequest": { + "base": null, + "refs": { + } + }, + "UpdateProtectConfigurationCountryRuleSetResult": { + "base": null, + "refs": { + } + }, + "UpdateProtectConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UpdateProtectConfigurationResult": { + "base": null, + "refs": { + } + }, "UpdateSenderIdRequest": { "base": null, "refs": { diff --git a/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json.php b/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json.php index b4596d6660..506b0d84e4 100644 --- a/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json.php +++ b/src/data/pinpoint-sms-voice-v2/2022-03-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.

If you\'re new to Amazon Pinpoint, it\'s also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

', 'operations' => [ 'AssociateOriginationIdentity' => '

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn\'t match the pool\'s configuration, an error is returned.

', 'CreateConfigurationSet' => '

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

', 'CreateEventDestination' => '

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

', 'CreateOptOutList' => '

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can\'t send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.

', 'CreatePool' => '

Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn\'t inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

', 'CreateRegistration' => '

Creates a new registration based on the RegistrationType field.

', 'CreateRegistrationAssociation' => '

Associate the registration with an origination identity such as a phone number or sender ID.

', 'CreateRegistrationAttachment' => '

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

', 'CreateRegistrationVersion' => '

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

', 'CreateVerifiedDestinationNumber' => '

You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.

', 'DeleteConfigurationSet' => '

Deletes an existing configuration set.

A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

', 'DeleteDefaultMessageType' => '

Deletes an existing default message type on a configuration set.

A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

', 'DeleteDefaultSenderId' => '

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients\' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

', 'DeleteEventDestination' => '

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

', 'DeleteKeyword' => '

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords "HELP" and "STOP" can\'t be deleted or modified.

', 'DeleteOptOutList' => '

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn\'t exist or is in-use by an origination phone number or pool, an error is returned.

', 'DeleteOptedOutNumber' => '

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn\'t exist or if the opt-out list doesn\'t exist, an error is returned.

', 'DeletePool' => '

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn\'t active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

', 'DeleteRegistration' => '

Permanently delete an existing registration from your account.

', 'DeleteRegistrationAttachment' => '

Permanently delete the specified registration attachment.

', 'DeleteRegistrationFieldValue' => '

Delete the value in a registration form field.

', 'DeleteTextMessageSpendLimitOverride' => '

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

', 'DeleteVerifiedDestinationNumber' => '

Delete a verified destination phone number.

', 'DeleteVoiceMessageSpendLimitOverride' => '

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

', 'DescribeAccountAttributes' => '

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you\'re ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

', 'DescribeAccountLimits' => '

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

', 'DescribeConfigurationSets' => '

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don\'t specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn\'t valid, an error is returned.

', 'DescribeKeywords' => '

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn\'t valid, an error is returned.

', 'DescribeOptOutLists' => '

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don\'t specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn\'t valid, an error is returned.

', 'DescribeOptedOutNumbers' => '

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don\'t specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn\'t valid, an error is returned.

', 'DescribePhoneNumbers' => '

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don\'t specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn\'t valid, an error is returned.

', 'DescribePools' => '

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don\'t specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn\'t valid, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

', 'DescribeRegistrationAttachments' => '

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

', 'DescribeRegistrationFieldDefinitions' => '

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

', 'DescribeRegistrationFieldValues' => '

Retrieves the specified registration field values.

', 'DescribeRegistrationSectionDefinitions' => '

Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.

', 'DescribeRegistrationTypeDefinitions' => '

Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.

', 'DescribeRegistrationVersions' => '

Retrieves the specified registration version.

', 'DescribeRegistrations' => '

Retrieves the specified registrations.

', 'DescribeSenderIds' => '

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don\'t specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn\'t valid, an error is returned.

', 'DescribeSpendLimits' => '

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

', 'DescribeVerifiedDestinationNumbers' => '

Retrieves the specified verified destiona numbers.

', 'DisassociateOriginationIdentity' => '

Removes the specified origination identity from an existing pool.

If the origination identity isn\'t associated with the specified pool, an error is returned.

', 'DiscardRegistrationVersion' => '

Discard the current version of the registration.

', 'ListPoolOriginationIdentities' => '

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

', 'ListRegistrationAssociations' => '

Retreive all of the origination identies that are associated with a registration.

', 'ListTagsForResource' => '

List all tags associated with a resource.

', 'PutKeyword' => '

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn\'t valid, an error is returned.

', 'PutOptedOutNumber' => '

Creates an opted out destination phone number in the opt-out list.

If the destination phone number isn\'t valid or if the specified opt-out list doesn\'t exist, an error is returned.

', 'PutRegistrationFieldValue' => '

Creates or updates a field value for a registration.

', 'ReleasePhoneNumber' => '

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.

', 'ReleaseSenderId' => '

Releases an existing sender ID in your account.

', 'RequestPhoneNumber' => '

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.

', 'RequestSenderId' => '

Request a new sender ID that doesn\'t require registration.

', 'SendDestinationNumberVerificationCode' => '

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.

', 'SendTextMessage' => '

Creates a new text message and sends it to a recipient\'s phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

', 'SendVoiceMessage' => '

Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.

', 'SetDefaultMessageType' => '

Sets the default message type on a configuration set.

Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

', 'SetDefaultSenderId' => '

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

', 'SetTextMessageSpendLimitOverride' => '

Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

', 'SetVoiceMessageSpendLimitOverride' => '

Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

', 'SubmitRegistrationVersion' => '

Submit the specified registration for review and approval.

', 'TagResource' => '

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

', 'UntagResource' => '

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

', 'UpdateEventDestination' => '

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can\'t change an event destination\'s type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

', 'UpdatePhoneNumber' => '

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an error is returned.

', 'UpdatePool' => '

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

', 'UpdateSenderId' => '

Updates the configuration of an existing sender ID.

', 'VerifyDestinationNumber' => '

Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

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

The request was denied because you don\'t have sufficient permissions to access the resource.

', 'refs' => [], ], 'AccessDeniedExceptionReason' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Reason' => '

The reason for the exception.

', ], ], 'AccountAttribute' => [ 'base' => '

Displays the attributes associated with a single Amazon Web Services account.

', 'refs' => [ 'AccountAttributeList$member' => NULL, ], ], 'AccountAttributeList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountAttributesResult$AccountAttributes' => '

An array of AccountAttributes objects.

', ], ], 'AccountAttributeName' => [ 'base' => NULL, 'refs' => [ 'AccountAttribute$Name' => '

The name of the account attribute.

', ], ], 'AccountLimit' => [ 'base' => '

The current resource quotas associated with an Amazon Web Services account.

', 'refs' => [ 'AccountLimitList$member' => NULL, ], ], 'AccountLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsResult$AccountLimits' => '

An array of AccountLimit objects that show the current spend limits.

', ], ], 'AccountLimitName' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$Name' => '

The name of the attribute to apply the account limit to.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to query for.

', 'ListTagsForResourceResult$ResourceArn' => '

The ARN of the resource.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', ], ], 'AssociateOriginationIdentityRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateOriginationIdentityResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachmentBody' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAttachmentRequest$AttachmentBody' => '

The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.

', ], ], 'AttachmentStatus' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAttachmentResult$AttachmentStatus' => '

The status of the registration attachment.

', 'DeleteRegistrationAttachmentResult$AttachmentStatus' => '

The status of the registration attachment.

', 'RegistrationAttachmentsInformation$AttachmentStatus' => '

The status of the registration attachment.

', ], ], 'AttachmentUploadErrorReason' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationAttachmentResult$AttachmentUploadErrorReason' => '

The error message if the upload failed.

', 'RegistrationAttachmentsInformation$AttachmentUploadErrorReason' => '

A description of why the upload didn\'t successfully complete.

', ], ], 'AttachmentUrl' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAttachmentRequest$AttachmentUrl' => '

A URL to the required registration file. For example, you can provide the S3 object URL.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreatePoolRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the pool can\'t be deleted. You can change this value using the UpdatePool action.

', 'EventDestination$Enabled' => '

When set to true events will be logged.

', 'RequestPhoneNumberRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the phone number can\'t be deleted.

', 'RequestSenderIdRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'UpdateEventDestinationRequest$Enabled' => '

When set to true logging is enabled.

', 'UpdatePhoneNumberRequest$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePhoneNumberRequest$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'UpdatePhoneNumberRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the phone number can\'t be deleted.

', 'UpdatePoolRequest$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePoolRequest$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'UpdatePoolRequest$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'UpdatePoolRequest$DeletionProtectionEnabled' => '

When set to true the pool can\'t be deleted.

', 'UpdateSenderIdRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateConfigurationSetRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateEventDestinationRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateOptOutListRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreatePoolRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateRegistrationAttachmentRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateRegistrationRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateVerifiedDestinationNumberRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'DisassociateOriginationIdentityRequest$ClientToken' => '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'RequestPhoneNumberRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'RequestSenderIdRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', ], ], 'CloudWatchLogsDestination' => [ 'base' => '

Contains the destination configuration to use when publishing message sending events.

', 'refs' => [ 'CreateEventDestinationRequest$CloudWatchLogsDestination' => '

An object that contains information about an event destination for logging to Amazon CloudWatch logs.

', 'EventDestination$CloudWatchLogsDestination' => '

An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

', 'UpdateEventDestinationRequest$CloudWatchLogsDestination' => '

An object that contains information about an event destination that sends data to CloudWatch Logs.

', ], ], 'ConfigurationSetFilter' => [ 'base' => '

The information for configuration sets that meet a specified criteria.

', 'refs' => [ 'ConfigurationSetFilterList$member' => NULL, ], ], 'ConfigurationSetFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationSetsRequest$Filters' => '

An array of filters to apply to the results that are returned.

', ], ], 'ConfigurationSetFilterName' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'ConfigurationSetInformation' => [ 'base' => '

Information related to a given configuration set in your Amazon Web Services account.

', 'refs' => [ 'ConfigurationSetInformationList$member' => NULL, ], ], 'ConfigurationSetInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationSetsResult$ConfigurationSets' => '

An array of ConfigurationSets objects.

', ], ], 'ConfigurationSetName' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$ConfigurationSetName' => '

The name of the ConfigurationSet.

', 'CreateConfigurationSetRequest$ConfigurationSetName' => '

The name to use for the new configuration set.

', 'CreateConfigurationSetResult$ConfigurationSetName' => '

The name of the new configuration set.

', 'CreateEventDestinationResult$ConfigurationSetName' => '

The name of the configuration set.

', 'DeleteConfigurationSetResult$ConfigurationSetName' => '

The name of the deleted configuration set.

', 'DeleteDefaultMessageTypeResult$ConfigurationSetName' => '

The name of the configuration set.

', 'DeleteDefaultSenderIdResult$ConfigurationSetName' => '

The name of the configuration set.

', 'DeleteEventDestinationResult$ConfigurationSetName' => '

The name of the configuration set the event destination was deleted from.

', 'SetDefaultMessageTypeResult$ConfigurationSetName' => '

The name of the configuration set that was updated.

', 'SetDefaultSenderIdResult$ConfigurationSetName' => '

The name of the configuration set that was updated.

', 'UpdateEventDestinationResult$ConfigurationSetName' => '

The name of the configuration set.

', ], ], 'ConfigurationSetNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationSetsRequest$ConfigurationSetNames' => '

An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

', ], ], 'ConfigurationSetNameOrArn' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetNameList$member' => NULL, 'CreateEventDestinationRequest$ConfigurationSetName' => '

Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteConfigurationSetRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteDefaultMessageTypeRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteDefaultSenderIdRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteEventDestinationRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set\'s Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'SendDestinationNumberVerificationCodeRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SendTextMessageRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SendVoiceMessageRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SetDefaultMessageTypeRequest$ConfigurationSetName' => '

The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

', 'SetDefaultSenderIdRequest$ConfigurationSetName' => '

The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

', 'UpdateEventDestinationRequest$ConfigurationSetName' => '

The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.

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

Your request has conflicting operations. This can occur if you\'re trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn\'t valid for the current state or configuration of the resource.

', 'refs' => [], ], 'ConflictExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Reason' => '

The reason for the exception.

', ], ], 'ContextKey' => [ 'base' => NULL, 'refs' => [ 'ContextMap$key' => NULL, ], ], 'ContextMap' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', 'SendTextMessageRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', 'SendVoiceMessageRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', ], ], 'ContextValue' => [ 'base' => NULL, 'refs' => [ 'ContextMap$value' => NULL, ], ], 'CreateConfigurationSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConfigurationSetResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventDestinationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptOutListRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptOutListResult' => [ 'base' => NULL, 'refs' => [], ], 'CreatePoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePoolResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAttachmentResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateVerifiedDestinationNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVerifiedDestinationNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigurationSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigurationSetResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultMessageTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultMessageTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventDestinationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeywordRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeywordResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptOutListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptOutListResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptedOutNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptedOutNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePoolResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationAttachmentResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationFieldValueRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationFieldValueResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTextMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTextMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVerifiedDestinationNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVerifiedDestinationNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'DeliveryStreamArn' => [ 'base' => NULL, 'refs' => [ 'KinesisFirehoseDestination$DeliveryStreamArn' => '

The Amazon Resource Name (ARN) of the delivery stream.

', ], ], 'DescribeAccountAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationSetsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeywordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeywordsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptOutListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptOutListsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptedOutNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptedOutNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePoolsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePoolsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationAttachmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationAttachmentsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldDefinitionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldValuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldValuesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationSectionDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationSectionDefinitionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationTypeDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationTypeDefinitionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSenderIdsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSenderIdsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpendLimitsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpendLimitsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVerifiedDestinationNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVerifiedDestinationNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'DestinationCountryParameterKey' => [ 'base' => NULL, 'refs' => [ 'DestinationCountryParameters$key' => NULL, ], ], 'DestinationCountryParameterValue' => [ 'base' => NULL, 'refs' => [ 'DestinationCountryParameters$value' => NULL, ], ], 'DestinationCountryParameters' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$DestinationCountryParameters' => '

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

', 'SendTextMessageRequest$DestinationCountryParameters' => '

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

', ], ], 'DestinationPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersRequest$DestinationPhoneNumbers' => '

An array of verified destination phone number, in E.164 format.

', ], ], 'DisassociateOriginationIdentityRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateOriginationIdentityResult' => [ 'base' => NULL, 'refs' => [], ], 'DiscardRegistrationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscardRegistrationVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'EventDestination' => [ 'base' => '

Contains information about an event destination.

Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.

', 'refs' => [ 'CreateEventDestinationResult$EventDestination' => '

The details of the destination where events are logged.

', 'DeleteEventDestinationResult$EventDestination' => '

The event destination object that was deleted.

', 'EventDestinationList$member' => NULL, 'UpdateEventDestinationResult$EventDestination' => '

An EventDestination object containing the details of where events will be logged.

', ], ], 'EventDestinationList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$EventDestinations' => '

An array of EventDestination objects that describe any events to log and where to log them.

', 'DeleteConfigurationSetResult$EventDestinations' => '

An array of any EventDestination objects that were associated with the deleted configuration set.

', ], ], 'EventDestinationName' => [ 'base' => NULL, 'refs' => [ 'CreateEventDestinationRequest$EventDestinationName' => '

The name that identifies the event destination.

', 'DeleteEventDestinationRequest$EventDestinationName' => '

The name of the event destination to delete.

', 'EventDestination$EventDestinationName' => '

The name of the EventDestination.

', 'UpdateEventDestinationRequest$EventDestinationName' => '

The name to use for the event destination.

', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'EventTypeList$member' => NULL, ], ], 'EventTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateEventDestinationRequest$MatchingEventTypes' => '

An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.

The TEXT_SENT event type is not supported.

', 'EventDestination$MatchingEventTypes' => '

An array of event types that determine which events to log.

The TEXT_SENT event type is not supported.

', 'UpdateEventDestinationRequest$MatchingEventTypes' => '

An array of event types that determine which events to log.

The TEXT_SENT event type is not supported.

', ], ], 'FieldPath' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationFieldValueRequest$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'DeleteRegistrationFieldValueResult$FieldPath' => '

The path to the registration form field.

', 'FieldPathList$member' => NULL, 'PutRegistrationFieldValueRequest$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'PutRegistrationFieldValueResult$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'RegistrationFieldDefinition$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'RegistrationFieldValueInformation$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', ], ], 'FieldPathList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldDefinitionsRequest$FieldPaths' => '

An array of paths to the registration form field.

', 'DescribeRegistrationFieldValuesRequest$FieldPaths' => '

An array of paths to the registration form field.

', ], ], 'FieldRequirement' => [ 'base' => NULL, 'refs' => [ 'RegistrationFieldDefinition$FieldRequirement' => '

Specifies if the field for the registration form is required, conditional or optional.

', ], ], 'FieldType' => [ 'base' => NULL, 'refs' => [ 'RegistrationFieldDefinition$FieldType' => '

The type of field.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValueList$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetFilter$Values' => '

An array values to filter for.

', 'KeywordFilter$Values' => '

An array values to filter for.

', 'OptedOutFilter$Values' => '

An array of values to filter for.

', 'PhoneNumberFilter$Values' => '

An array values to filter for.

', 'PoolFilter$Values' => '

An array values to filter for.

', 'PoolOriginationIdentitiesFilter$Values' => '

An array values to filter for.

', 'RegistrationAssociationFilter$Values' => '

An array of values to filter for.

', 'RegistrationAttachmentFilter$Values' => '

An array of values to filter on.

', 'RegistrationFilter$Values' => '

An array of values to filter on.

', 'RegistrationTypeFilter$Values' => '

An array of values to filter on.

', 'RegistrationVersionFilter$Values' => '

An array of values to filter on.

', 'SenderIdFilter$Values' => '

An array of values to filter for.

', 'VerifiedDestinationNumberFilter$Values' => '

An array of values to filter on.

', ], ], 'IamRoleArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogsDestination$IamRoleArn' => '

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.

', 'CreatePoolResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'DeletePoolResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'KinesisFirehoseDestination$IamRoleArn' => '

The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

', 'PhoneNumberInformation$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'PoolInformation$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'ReleasePhoneNumberResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'RequestPhoneNumberResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePhoneNumberRequest$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePhoneNumberResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePoolRequest$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePoolResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'SelectValidation$MinChoices' => '

The minimum number of choices for the select.

', 'SelectValidation$MaxChoices' => '

The maximum number of choices for the select.

', 'TextValidation$MinLength' => '

The minimum number of characters for the text field.

', 'TextValidation$MaxLength' => '

The maximum number of characters for the text field.

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

The API encountered an unexpected error and couldn\'t complete the request. You might be able to successfully issue the request again in the future.

', 'refs' => [], ], 'IsoCountryCode' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$IsoCountryCode' => '

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.

', 'AssociateOriginationIdentityResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'CreatePoolRequest$IsoCountryCode' => '

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

', 'CreateRegistrationAssociationResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'DisassociateOriginationIdentityRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'DisassociateOriginationIdentityResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'OriginationIdentityMetadata$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'PhoneNumberInformation$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RegistrationAssociationMetadata$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ReleasePhoneNumberResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ReleaseSenderIdRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ReleaseSenderIdResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestPhoneNumberRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestPhoneNumberResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestSenderIdRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestSenderIdResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'SenderIdAndCountry$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'SenderIdInformation$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'SupportedAssociation$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'UpdatePhoneNumberResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'UpdateSenderIdRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'UpdateSenderIdResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', ], ], 'Keyword' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordRequest$Keyword' => '

The keyword to delete.

', 'DeleteKeywordResult$Keyword' => '

The keyword that was deleted.

', 'KeywordInformation$Keyword' => '

The keyword as a string.

', 'KeywordList$member' => NULL, 'PutKeywordRequest$Keyword' => '

The new keyword to add.

', 'PutKeywordResult$Keyword' => '

The keyword that was added.

', 'SendTextMessageRequest$Keyword' => '

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

', ], ], 'KeywordAction' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordResult$KeywordAction' => '

The action that was associated with the deleted keyword.

', 'KeywordInformation$KeywordAction' => '

The action to perform for the keyword.

', 'PutKeywordRequest$KeywordAction' => '

The action to perform for the new keyword when it is received.

', 'PutKeywordResult$KeywordAction' => '

The action to perform when the keyword is used.

', ], ], 'KeywordFilter' => [ 'base' => '

The information for keywords that meet a specified criteria.

', 'refs' => [ 'KeywordFilterList$member' => NULL, ], ], 'KeywordFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeKeywordsRequest$Filters' => '

An array of keyword filters to filter the results.

', ], ], 'KeywordFilterName' => [ 'base' => NULL, 'refs' => [ 'KeywordFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'KeywordInformation' => [ 'base' => '

The information for all keywords in a pool.

', 'refs' => [ 'KeywordInformationList$member' => NULL, ], ], 'KeywordInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeKeywordsResult$Keywords' => '

An array of KeywordInformation objects that contain the results.

', ], ], 'KeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeKeywordsRequest$Keywords' => '

An array of keywords to search for.

', ], ], 'KeywordMessage' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordResult$KeywordMessage' => '

The message that was associated with the deleted keyword.

', 'KeywordInformation$KeywordMessage' => '

A custom message that can be used with the keyword.

', 'PutKeywordRequest$KeywordMessage' => '

The message associated with the keyword.

', 'PutKeywordResult$KeywordMessage' => '

The message associated with the keyword.

', ], ], 'KinesisFirehoseDestination' => [ 'base' => '

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.

Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.

', 'refs' => [ 'CreateEventDestinationRequest$KinesisFirehoseDestination' => '

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

', 'EventDestination$KinesisFirehoseDestination' => '

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

', 'UpdateEventDestinationRequest$KinesisFirehoseDestination' => '

An object that contains information about an event destination for logging to Kinesis Data Firehose.

', ], ], 'LanguageCode' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$LanguageCode' => '

Choose the language to use for the message.

', ], ], 'ListPoolOriginationIdentitiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPoolOriginationIdentitiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistrationAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistrationAssociationsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'LogGroupArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogsDestination$LogGroupArn' => '

The name of the Amazon CloudWatch log group that you want to record events in.

', ], ], 'MaxPrice' => [ 'base' => NULL, 'refs' => [ 'SendTextMessageRequest$MaxPrice' => '

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

', 'SendVoiceMessageRequest$MaxPricePerMinute' => '

The maximum amount to spend per voice message, in US dollars.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountAttributesRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeAccountLimitsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeConfigurationSetsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeKeywordsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeOptOutListsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeOptedOutNumbersRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribePhoneNumbersRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribePoolsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationAttachmentsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationFieldDefinitionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationFieldValuesRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationSectionDefinitionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationTypeDefinitionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationVersionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeSenderIdsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeSpendLimitsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeVerifiedDestinationNumbersRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'ListPoolOriginationIdentitiesRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'ListRegistrationAssociationsRequest$MaxResults' => '

The maximum number of results to return per each request.

', ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$DefaultMessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'CreatePoolRequest$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'CreatePoolResult$MessageType' => '

The type of message for the pool to use.

', 'DeleteConfigurationSetResult$DefaultMessageType' => '

The default message type of the configuration set that was deleted.

', 'DeleteDefaultMessageTypeResult$MessageType' => '

The current message type for the configuration set.

', 'DeletePoolResult$MessageType' => '

The message type that was associated with the deleted pool.

', 'MessageTypeList$member' => NULL, 'PhoneNumberInformation$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'PoolInformation$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'ReleasePhoneNumberResult$MessageType' => '

The message type that was associated with the phone number.

', 'RequestPhoneNumberRequest$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'RequestPhoneNumberResult$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SendTextMessageRequest$MessageType' => '

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SetDefaultMessageTypeRequest$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SetDefaultMessageTypeResult$MessageType' => '

The new default message type of the configuration set.

', 'UpdatePhoneNumberResult$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'UpdatePoolResult$MessageType' => '

The type of message for the pool to use.

', ], ], 'MessageTypeList' => [ 'base' => NULL, 'refs' => [ 'ReleaseSenderIdResult$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'RequestSenderIdRequest$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'RequestSenderIdResult$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SenderIdInformation$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'UpdateSenderIdResult$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', ], ], 'MonthlyLimit' => [ 'base' => NULL, 'refs' => [ 'DeleteTextMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit, in US dollars.

', 'DeleteVoiceMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit, in US dollars.

', 'SetTextMessageSpendLimitOverrideRequest$MonthlyLimit' => '

The new monthly limit to enforce on text messages.

', 'SetTextMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit to enforce on sending text messages.

', 'SetVoiceMessageSpendLimitOverrideRequest$MonthlyLimit' => '

The new monthly limit to enforce on voice messages.

', 'SetVoiceMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit to enforce on sending voice messages.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountAttributesRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeAccountAttributesResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeAccountLimitsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeAccountLimitsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeConfigurationSetsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeConfigurationSetsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeKeywordsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeKeywordsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeOptOutListsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeOptOutListsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeOptedOutNumbersRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeOptedOutNumbersResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribePhoneNumbersRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribePhoneNumbersResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribePoolsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribePoolsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeRegistrationAttachmentsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationAttachmentsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldDefinitionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldDefinitionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldValuesRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldValuesResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationSectionDefinitionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationSectionDefinitionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationTypeDefinitionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationTypeDefinitionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationVersionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationVersionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeSenderIdsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeSenderIdsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeSpendLimitsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeSpendLimitsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeVerifiedDestinationNumbersRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeVerifiedDestinationNumbersResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'ListPoolOriginationIdentitiesRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'ListPoolOriginationIdentitiesResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'ListRegistrationAssociationsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'ListRegistrationAssociationsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', ], ], 'NonEmptyTagList' => [ 'base' => NULL, 'refs' => [ 'TagResourceRequest$Tags' => '

An array of key and value pair tags that are associated with the resource.

', ], ], 'NumberCapability' => [ 'base' => NULL, 'refs' => [ 'NumberCapabilityList$member' => NULL, ], ], 'NumberCapabilityList' => [ 'base' => NULL, 'refs' => [ 'OriginationIdentityMetadata$NumberCapabilities' => '

Describes if the origination identity can be used for text messages, voice calls or both.

', 'PhoneNumberInformation$NumberCapabilities' => '

Describes if the origination identity can be used for text messages, voice calls or both.

', 'ReleasePhoneNumberResult$NumberCapabilities' => '

Specifies if the number could be used for text messages, voice, or both.

', 'RequestPhoneNumberRequest$NumberCapabilities' => '

Indicates if the phone number will be used for text messages, voice messages, or both.

', 'RequestPhoneNumberResult$NumberCapabilities' => '

Indicates if the phone number will be used for text messages, voice messages or both.

', 'UpdatePhoneNumberResult$NumberCapabilities' => '

Specifies if the number could be used for text messages, voice or both.

', ], ], 'NumberStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberInformation$Status' => '

The current status of the phone number.

', 'ReleasePhoneNumberResult$Status' => '

The current status of the request.

', 'RequestPhoneNumberResult$Status' => '

The current status of the request.

', 'UpdatePhoneNumberResult$Status' => '

The current status of the request.

', ], ], 'NumberType' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberInformation$NumberType' => '

The type of phone number.

', 'ReleasePhoneNumberResult$NumberType' => '

The type of number that was released.

', 'UpdatePhoneNumberResult$NumberType' => '

The type of number that was requested.

', ], ], 'OptOutListInformation' => [ 'base' => '

The information for all OptOutList in an Amazon Web Services account.

', 'refs' => [ 'OptOutListInformationList$member' => NULL, ], ], 'OptOutListInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptOutListsResult$OptOutLists' => '

An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

', ], ], 'OptOutListName' => [ 'base' => NULL, 'refs' => [ 'CreateOptOutListRequest$OptOutListName' => '

The name of the new OptOutList.

', 'CreateOptOutListResult$OptOutListName' => '

The name of the new OptOutList.

', 'CreatePoolResult$OptOutListName' => '

The name of the OptOutList associated with the pool.

', 'DeleteOptOutListResult$OptOutListName' => '

The name of the OptOutList that was removed.

', 'DeleteOptedOutNumberResult$OptOutListName' => '

The OptOutListName that the phone number was removed from.

', 'DeletePoolResult$OptOutListName' => '

The name of the OptOutList that was associated with the deleted pool.

', 'DescribeOptedOutNumbersResult$OptOutListName' => '

The name of the OptOutList.

', 'OptOutListInformation$OptOutListName' => '

The name of the OptOutList.

', 'PhoneNumberInformation$OptOutListName' => '

The name of the OptOutList associated with the phone number.

', 'PoolInformation$OptOutListName' => '

The name of the OptOutList associated with the pool.

', 'PutOptedOutNumberResult$OptOutListName' => '

The OptOutListName that the phone number was removed from.

', 'ReleasePhoneNumberResult$OptOutListName' => '

The name of the OptOutList that was associated with the phone number.

', 'RequestPhoneNumberResult$OptOutListName' => '

The name of the OptOutList that is associated with the requested phone number.

', 'UpdatePhoneNumberResult$OptOutListName' => '

The name of the OptOutList associated with the phone number.

', 'UpdatePoolResult$OptOutListName' => '

The name of the OptOutList associated with the pool.

', ], ], 'OptOutListNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptOutListsRequest$OptOutListNames' => '

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

', ], ], 'OptOutListNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteOptOutListRequest$OptOutListName' => '

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

', 'DeleteOptedOutNumberRequest$OptOutListName' => '

The OptOutListName or OptOutListArn to remove the phone number from.

', 'DescribeOptedOutNumbersRequest$OptOutListName' => '

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

', 'OptOutListNameList$member' => NULL, 'PutOptedOutNumberRequest$OptOutListName' => '

The OptOutListName or OptOutListArn to add the phone number to.

', 'RequestPhoneNumberRequest$OptOutListName' => '

The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.

', 'UpdatePhoneNumberRequest$OptOutListName' => '

The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

', 'UpdatePoolRequest$OptOutListName' => '

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

', ], ], 'OptedOutFilter' => [ 'base' => '

The information for opted out numbers that meet a specified criteria.

', 'refs' => [ 'OptedOutFilterList$member' => NULL, ], ], 'OptedOutFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptedOutNumbersRequest$Filters' => '

An array of OptedOutFilter objects to filter the results on.

', ], ], 'OptedOutFilterName' => [ 'base' => NULL, 'refs' => [ 'OptedOutFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'OptedOutNumberInformation' => [ 'base' => '

The information for an opted out number in an Amazon Web Services account.

', 'refs' => [ 'OptedOutNumberInformationList$member' => NULL, ], ], 'OptedOutNumberInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptedOutNumbersResult$OptedOutNumbers' => '

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

', ], ], 'OptedOutNumberList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptedOutNumbersRequest$OptedOutNumbers' => '

An array of phone numbers to search for in the OptOutList.

', ], ], 'OriginationIdentityMetadata' => [ 'base' => '

The metadata for an origination identity associated with a pool.

', 'refs' => [ 'OriginationIdentityMetadataList$member' => NULL, ], ], 'OriginationIdentityMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListPoolOriginationIdentitiesResult$OriginationIdentities' => '

An array of any OriginationIdentityMetadata objects.

', ], ], 'PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationResult$PhoneNumber' => '

The phone number associated with the registration in E.164 format.

', 'CreateVerifiedDestinationNumberRequest$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'CreateVerifiedDestinationNumberResult$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'DeleteOptedOutNumberRequest$OptedOutNumber' => '

The phone number, in E.164 format, to remove from the OptOutList.

', 'DeleteOptedOutNumberResult$OptedOutNumber' => '

The phone number that was removed from the OptOutList.

', 'DeleteVerifiedDestinationNumberResult$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'DestinationPhoneNumberList$member' => NULL, 'OptedOutNumberInformation$OptedOutNumber' => '

The phone number that is opted out.

', 'OptedOutNumberList$member' => NULL, 'OriginationIdentityMetadata$PhoneNumber' => '

The phone number in E.164 format.

', 'PhoneNumberInformation$PhoneNumber' => '

The phone number in E.164 format.

', 'PutOptedOutNumberRequest$OptedOutNumber' => '

The phone number to add to the OptOutList in E.164 format.

', 'PutOptedOutNumberResult$OptedOutNumber' => '

The phone number that was added to the OptOutList.

', 'RegistrationAssociationMetadata$PhoneNumber' => '

The phone number associated with the registration in E.164 format.

', 'ReleasePhoneNumberResult$PhoneNumber' => '

The phone number that was released.

', 'RequestPhoneNumberResult$PhoneNumber' => '

The new phone number that was requested.

', 'SendTextMessageRequest$DestinationPhoneNumber' => '

The destination phone number in E.164 format.

', 'SendVoiceMessageRequest$DestinationPhoneNumber' => '

The destination phone number in E.164 format.

', 'UpdatePhoneNumberResult$PhoneNumber' => '

The phone number that was updated.

', 'VerifiedDestinationNumberInformation$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'VerifyDestinationNumberResult$DestinationPhoneNumber' => '

The phone number in E.164 format.

', ], ], 'PhoneNumberFilter' => [ 'base' => '

The information for a phone number that meets a specified criteria.

', 'refs' => [ 'PhoneNumberFilterList$member' => NULL, ], ], 'PhoneNumberFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribePhoneNumbersRequest$Filters' => '

An array of PhoneNumberFilter objects to filter the results.

', ], ], 'PhoneNumberFilterName' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'PhoneNumberIdList' => [ 'base' => NULL, 'refs' => [ 'DescribePhoneNumbersRequest$PhoneNumberIds' => '

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

', ], ], 'PhoneNumberIdOrArn' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberIdList$member' => NULL, 'ReleasePhoneNumberRequest$PhoneNumberId' => '

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

', 'UpdatePhoneNumberRequest$PhoneNumberId' => '

The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

', ], ], 'PhoneNumberInformation' => [ 'base' => '

The information for a phone number, in E.164 format, in an Amazon Web Services account.

', 'refs' => [ 'PhoneNumberInformationList$member' => NULL, ], ], 'PhoneNumberInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribePhoneNumbersResult$PhoneNumbers' => '

An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

', ], ], 'PhoneOrPoolIdOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

', 'DescribeKeywordsRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', 'PutKeywordRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', ], ], 'PhoneOrSenderIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$OriginationIdentity' => '

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', 'CreatePoolRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', 'DisassociateOriginationIdentityRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.

', ], ], 'PoolFilter' => [ 'base' => '

The information for a pool that meets a specified criteria.

', 'refs' => [ 'PoolFilterList$member' => NULL, ], ], 'PoolFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribePoolsRequest$Filters' => '

An array of PoolFilter objects to filter the results.

', ], ], 'PoolFilterName' => [ 'base' => NULL, 'refs' => [ 'PoolFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'PoolIdList' => [ 'base' => NULL, 'refs' => [ 'DescribePoolsRequest$PoolIds' => '

The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

', ], ], 'PoolIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$PoolId' => '

The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.

', 'DeletePoolRequest$PoolId' => '

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

', 'DisassociateOriginationIdentityRequest$PoolId' => '

The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

', 'ListPoolOriginationIdentitiesRequest$PoolId' => '

The unique identifier for the pool. This value can be either the PoolId or PoolArn.

', 'PoolIdList$member' => NULL, 'RequestPhoneNumberRequest$PoolId' => '

The pool to associated with the phone number. You can use the PoolId or PoolArn.

', 'UpdatePoolRequest$PoolId' => '

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

', ], ], 'PoolInformation' => [ 'base' => '

The information for a pool in an Amazon Web Services account.

', 'refs' => [ 'PoolInformationList$member' => NULL, ], ], 'PoolInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribePoolsResult$Pools' => '

An array of PoolInformation objects that contain the details for the requested pools.

', ], ], 'PoolOriginationIdentitiesFilter' => [ 'base' => '

Information about origination identities associated with a pool that meets a specified criteria.

', 'refs' => [ 'PoolOriginationIdentitiesFilterList$member' => NULL, ], ], 'PoolOriginationIdentitiesFilterList' => [ 'base' => NULL, 'refs' => [ 'ListPoolOriginationIdentitiesRequest$Filters' => '

An array of PoolOriginationIdentitiesFilter objects to filter the results..

', ], ], 'PoolOriginationIdentitiesFilterName' => [ 'base' => NULL, 'refs' => [ 'PoolOriginationIdentitiesFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'PoolStatus' => [ 'base' => NULL, 'refs' => [ 'CreatePoolResult$Status' => '

The current status of the pool.

', 'DeletePoolResult$Status' => '

The current status of the pool.

', 'PoolInformation$Status' => '

The current status of the pool.

', 'UpdatePoolResult$Status' => '

The current status of the pool update request.

', ], ], 'PrimitiveBoolean' => [ 'base' => NULL, 'refs' => [ 'CreatePoolResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'CreatePoolResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'CreatePoolResult$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'CreatePoolResult$DeletionProtectionEnabled' => '

When set to true deletion protection is enabled. By default this is set to false.

', 'DeleteOptedOutNumberResult$EndUserOptedOut' => '

This is true if it was the end user who requested their phone number be removed.

', 'DeletePoolResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'DeletePoolResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'DeletePoolResult$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'OptedOutNumberInformation$EndUserOptedOut' => '

This is set to true if it was the end recipient that opted out.

', 'PhoneNumberInformation$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

', 'PhoneNumberInformation$SelfManagedOptOutsEnabled' => '

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

', 'PhoneNumberInformation$DeletionProtectionEnabled' => '

When set to true the phone number can\'t be deleted.

', 'PoolInformation$TwoWayEnabled' => '

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

', 'PoolInformation$SelfManagedOptOutsEnabled' => '

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs

', 'PoolInformation$SharedRoutesEnabled' => '

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren\'t allowed to use shared routes and must use a dedicated phone number or short code.

', 'PoolInformation$DeletionProtectionEnabled' => '

When set to true the pool can\'t be deleted.

', 'PutOptedOutNumberResult$EndUserOptedOut' => '

This is true if it was the end user who requested their phone number be removed.

', 'ReleasePhoneNumberResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'ReleasePhoneNumberResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'ReleaseSenderIdResult$Registered' => '

True if the sender ID is registered.

', 'RequestPhoneNumberResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'RequestPhoneNumberResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'RequestPhoneNumberResult$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the phone number can\'t be deleted.

', 'RequestSenderIdResult$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'RequestSenderIdResult$Registered' => '

True if the sender ID is registered.

', 'SendTextMessageRequest$DryRun' => '

When set to true, the message is checked and validated, but isn\'t sent to the end recipient.

', 'SendVoiceMessageRequest$DryRun' => '

When set to true, the message is checked and validated, but isn\'t sent to the end recipient.

', 'SenderIdInformation$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'SenderIdInformation$Registered' => '

True if the sender ID is registered.

', 'SpendLimit$Overridden' => '

When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

', 'UpdatePhoneNumberResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePhoneNumberResult$SelfManagedOptOutsEnabled' => '

This is true if self managed opt-out are enabled.

', 'UpdatePhoneNumberResult$DeletionProtectionEnabled' => '

When set to true the phone number can\'t be deleted.

', 'UpdatePoolResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePoolResult$SelfManagedOptOutsEnabled' => '

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'UpdatePoolResult$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'UpdatePoolResult$DeletionProtectionEnabled' => '

When set to true the pool can\'t be deleted.

', 'UpdateSenderIdResult$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'UpdateSenderIdResult$Registered' => '

True if the sender ID is registered..

', ], ], 'PrimitiveLong' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$Used' => '

The current amount that has been spent, in US dollars.

', 'AccountLimit$Max' => '

The Amazon Web Services set limit for that resource type, in US dollars.

', 'SpendLimit$EnforcedLimit' => '

The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.

', 'SpendLimit$MaxLimit' => '

The maximum amount of money that you are able to spend to send messages each month, in US dollars.

', ], ], 'PutKeywordRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutKeywordResult' => [ 'base' => NULL, 'refs' => [], ], 'PutOptedOutNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOptedOutNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'PutRegistrationFieldValueRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRegistrationFieldValueResult' => [ 'base' => NULL, 'refs' => [], ], 'RegistrationAssociationBehavior' => [ 'base' => NULL, 'refs' => [ 'SupportedAssociation$AssociationBehavior' => '

The association behavior.

', ], ], 'RegistrationAssociationFilter' => [ 'base' => '

The filter definition for filtering registrations that meets a specified criteria.

', 'refs' => [ 'RegistrationAssociationFilterList$member' => NULL, ], ], 'RegistrationAssociationFilterList' => [ 'base' => NULL, 'refs' => [ 'ListRegistrationAssociationsRequest$Filters' => '

An array of RegistrationAssociationFilter to apply to the results that are returned.

', ], ], 'RegistrationAssociationFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationAssociationFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationAssociationMetadata' => [ 'base' => '

Metadata for the origination identity that is associated with the registration.

', 'refs' => [ 'RegistrationAssociationMetadataList$member' => NULL, ], ], 'RegistrationAssociationMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListRegistrationAssociationsResult$RegistrationAssociations' => '

An array of RegistrationAssociationMetadata objects.

', ], ], 'RegistrationAttachmentFilter' => [ 'base' => '

The filter definition for filtering registration attachments that meets a specified criteria.

', 'refs' => [ 'RegistrationAttachmentFilterList$member' => NULL, ], ], 'RegistrationAttachmentFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationAttachmentsRequest$Filters' => '

An array of RegistrationAttachmentFilter objects to filter the results.

', ], ], 'RegistrationAttachmentFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationAttachmentFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationAttachmentIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationAttachmentsRequest$RegistrationAttachmentIds' => '

The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.

', ], ], 'RegistrationAttachmentIdOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationAttachmentRequest$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'PutRegistrationFieldValueRequest$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'RegistrationFieldValueInformation$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', ], ], 'RegistrationAttachmentsInformation' => [ 'base' => '

Provides information on the specified registration attachments.

', 'refs' => [ 'RegistrationAttachmentsInformationList$member' => NULL, ], ], 'RegistrationAttachmentsInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationAttachmentsResult$RegistrationAttachments' => '

An array of RegistrationAttachments objects that contain the details for the requested registration attachments.

', ], ], 'RegistrationDeniedReasonInformation' => [ 'base' => '

Provides the reason a registration was rejected.

', 'refs' => [ 'RegistrationDeniedReasonInformationList$member' => NULL, ], ], 'RegistrationDeniedReasonInformationList' => [ 'base' => NULL, 'refs' => [ 'RegistrationVersionInformation$DeniedReasons' => '

An array of RegistrationDeniedReasonInformation objects.

', ], ], 'RegistrationDisassociationBehavior' => [ 'base' => NULL, 'refs' => [ 'SupportedAssociation$DisassociationBehavior' => '

The disassociation behavior.

', ], ], 'RegistrationFieldDefinition' => [ 'base' => '

Provides a description of the specified field.

', 'refs' => [ 'RegistrationFieldDefinitionList$member' => NULL, ], ], 'RegistrationFieldDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldDefinitionsResult$RegistrationFieldDefinitions' => '

An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.

', ], ], 'RegistrationFieldDisplayHints' => [ 'base' => '

Provides help information on the registration field.

', 'refs' => [ 'RegistrationFieldDefinition$DisplayHints' => '

An array of RegistrationFieldDisplayHints objects for the field.

', ], ], 'RegistrationFieldValueInformation' => [ 'base' => '

Provides the values of the specified field.

', 'refs' => [ 'RegistrationFieldValueInformationList$member' => NULL, ], ], 'RegistrationFieldValueInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldValuesResult$RegistrationFieldValues' => '

An array of RegistrationFieldValues objects that contain the values for the requested registration.

', ], ], 'RegistrationFilter' => [ 'base' => '

The filter definition for filtering registrations that meets a specified criteria.

', 'refs' => [ 'RegistrationFilterList$member' => NULL, ], ], 'RegistrationFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationsRequest$Filters' => '

An array of RegistrationFilter objects to filter the results.

', ], ], 'RegistrationFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationsRequest$RegistrationIds' => '

An array of unique identifiers for each registration.

', ], ], 'RegistrationIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationRequest$RegistrationId' => '

The unique identifier for the registration.

', 'CreateRegistrationVersionRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteRegistrationFieldValueRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteRegistrationRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DescribeRegistrationFieldValuesRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DescribeRegistrationVersionsRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DiscardRegistrationVersionRequest$RegistrationId' => '

The unique identifier for the registration.

', 'ListRegistrationAssociationsRequest$RegistrationId' => '

The unique identifier for the registration.

', 'PutRegistrationFieldValueRequest$RegistrationId' => '

The unique identifier for the registration.

', 'RegistrationAttachmentIdList$member' => NULL, 'RegistrationIdList$member' => NULL, 'RequestPhoneNumberRequest$RegistrationId' => '

Use this field to attach your phone number for an external registration process.

', 'SubmitRegistrationVersionRequest$RegistrationId' => '

The unique identifier for the registration.

', ], ], 'RegistrationInformation' => [ 'base' => '

Provides information about the requested registration.

', 'refs' => [ 'RegistrationInformationList$member' => NULL, ], ], 'RegistrationInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationsResult$Registrations' => '

An array of RegistrationInformation objects.

', ], ], 'RegistrationSectionDefinition' => [ 'base' => '

Provides information on the specified section definition.

', 'refs' => [ 'RegistrationSectionDefinitionList$member' => NULL, ], ], 'RegistrationSectionDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationSectionDefinitionsResult$RegistrationSectionDefinitions' => '

An array of RegistrationSectionDefinition objects.

', ], ], 'RegistrationSectionDisplayHints' => [ 'base' => '

Provides help information on the registration section.

', 'refs' => [ 'RegistrationSectionDefinition$DisplayHints' => '

The path to the section of the registration.

', ], ], 'RegistrationStatus' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationResult$RegistrationStatus' => '

The status of the registration.

', 'DeleteRegistrationResult$RegistrationStatus' => '

The status of the registration.

', 'RegistrationInformation$RegistrationStatus' => '

The status of the registration.

', ], ], 'RegistrationType' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'CreateRegistrationRequest$RegistrationType' => '

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'CreateRegistrationResult$RegistrationType' => '

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DeleteRegistrationResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationFieldDefinitionsRequest$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationFieldDefinitionsResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationSectionDefinitionsRequest$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationSectionDefinitionsResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'ListRegistrationAssociationsResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'RegistrationInformation$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'RegistrationTypeDefinition$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'RegistrationTypeList$member' => NULL, ], ], 'RegistrationTypeDefinition' => [ 'base' => '

Provides information on the supported registration type.

', 'refs' => [ 'RegistrationTypeDefinitionList$member' => NULL, ], ], 'RegistrationTypeDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationTypeDefinitionsResult$RegistrationTypeDefinitions' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', ], ], 'RegistrationTypeDisplayHints' => [ 'base' => '

Provides help information on the registration type.

', 'refs' => [ 'RegistrationTypeDefinition$DisplayHints' => '

Provides help information on the registration.

', ], ], 'RegistrationTypeFilter' => [ 'base' => '

The filter definition for filtering registration types that meets a specified criteria.

', 'refs' => [ 'RegistrationTypeFilterList$member' => NULL, ], ], 'RegistrationTypeFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationTypeDefinitionsRequest$Filters' => '

An array of RegistrationFilter objects to filter the results.

', ], ], 'RegistrationTypeFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationTypeFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationTypeDefinitionsRequest$RegistrationTypes' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', ], ], 'RegistrationVersionFilter' => [ 'base' => '

The filter definition for filtering registration versions that meets a specified criteria.

', 'refs' => [ 'RegistrationVersionFilterList$member' => NULL, ], ], 'RegistrationVersionFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationVersionsRequest$Filters' => '

An array of RegistrationVersionFilter objects to filter the results.

', ], ], 'RegistrationVersionFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationVersionFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationVersionInformation' => [ 'base' => '

Provides information about the specified version of the registration.

', 'refs' => [ 'RegistrationVersionInformationList$member' => NULL, ], ], 'RegistrationVersionInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationVersionsResult$RegistrationVersions' => '

An array of RegistrationVersions objects.

', ], ], 'RegistrationVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationResult$CurrentVersionNumber' => '

The current version number of the registration.

', 'CreateRegistrationVersionResult$VersionNumber' => '

The new version number of the registration.

', 'DeleteRegistrationFieldValueResult$VersionNumber' => '

The version number of the registration.

', 'DeleteRegistrationResult$CurrentVersionNumber' => '

The current version number of the registration.

', 'DeleteRegistrationResult$ApprovedVersionNumber' => '

The version number of the registration that was approved.

', 'DeleteRegistrationResult$LatestDeniedVersionNumber' => '

The latest version number of the registration that was denied.

', 'DescribeRegistrationFieldValuesRequest$VersionNumber' => '

The version number of the registration.

', 'DescribeRegistrationFieldValuesResult$VersionNumber' => '

The current version of the registration.

', 'DiscardRegistrationVersionResult$VersionNumber' => '

The version number of the registration.

', 'PutRegistrationFieldValueResult$VersionNumber' => '

The version number of the registration.

', 'RegistrationInformation$CurrentVersionNumber' => '

The current version number of the registration.

', 'RegistrationInformation$ApprovedVersionNumber' => '

The version number of the registration that was approved.

', 'RegistrationInformation$LatestDeniedVersionNumber' => '

The latest version number of the registration that was denied.

', 'RegistrationVersionInformation$VersionNumber' => '

The version number of the registration.

', 'RegistrationVersionNumberList$member' => NULL, 'SubmitRegistrationVersionResult$VersionNumber' => '

The version number of the registration.

', ], ], 'RegistrationVersionNumberList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationVersionsRequest$VersionNumbers' => '

An array of registration version numbers.

', ], ], 'RegistrationVersionStatus' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationVersionResult$RegistrationVersionStatus' => '

The status of the registration.

', 'DiscardRegistrationVersionResult$RegistrationVersionStatus' => '

The status of the registration version.

', 'RegistrationVersionInformation$RegistrationVersionStatus' => '

The status of the registration.

', 'SubmitRegistrationVersionResult$RegistrationVersionStatus' => '

The status of the registration version.

', ], ], 'RegistrationVersionStatusHistory' => [ 'base' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', 'refs' => [ 'CreateRegistrationVersionResult$RegistrationVersionStatusHistory' => '

A RegistrationVersionStatusHistory object that contains timestamps for the registration.

', 'DiscardRegistrationVersionResult$RegistrationVersionStatusHistory' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', 'RegistrationVersionInformation$RegistrationVersionStatusHistory' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', 'SubmitRegistrationVersionResult$RegistrationVersionStatusHistory' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', ], ], 'ReleasePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleasePhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestPhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestableNumberType' => [ 'base' => NULL, 'refs' => [ 'RequestPhoneNumberRequest$NumberType' => '

The type of phone number to request.

', 'RequestPhoneNumberResult$NumberType' => '

The type of number that was released.

', ], ], 'ResourceIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationRequest$ResourceId' => '

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

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

A requested resource couldn\'t be found.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$ResourceType' => '

The type of resource that caused the exception.

', 'ResourceNotFoundException$ResourceType' => '

The type of resource that caused the exception.

', ], ], 'SectionPath' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldDefinitionsRequest$SectionPath' => '

The path to the section of the registration.

', 'DescribeRegistrationFieldValuesRequest$SectionPath' => '

The path to the section of the registration.

', 'RegistrationFieldDefinition$SectionPath' => '

The section path of the field.

', 'RegistrationSectionDefinition$SectionPath' => '

The path to the section of the registration.

', 'SectionPathList$member' => NULL, ], ], 'SectionPathList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationSectionDefinitionsRequest$SectionPaths' => '

An array of paths for the registration form section.

', ], ], 'SelectChoice' => [ 'base' => NULL, 'refs' => [ 'SelectChoiceList$member' => NULL, ], ], 'SelectChoiceList' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationFieldValueResult$SelectChoices' => '

An array of values for the form field.

', 'PutRegistrationFieldValueRequest$SelectChoices' => '

An array of values for the form field.

', 'PutRegistrationFieldValueResult$SelectChoices' => '

An array of values for the form field.

', 'RegistrationFieldValueInformation$SelectChoices' => '

An array of values for the form field.

', ], ], 'SelectOptionDescription' => [ 'base' => '

A description of each select option.

', 'refs' => [ 'SelectOptionDescriptionsList$member' => NULL, ], ], 'SelectOptionDescriptionsList' => [ 'base' => NULL, 'refs' => [ 'RegistrationFieldDisplayHints$SelectOptionDescriptions' => '

An array of SelectOptionDescription objects.

', ], ], 'SelectValidation' => [ 'base' => '

Validation rules for a select field.

', 'refs' => [ 'RegistrationFieldDefinition$SelectValidation' => '

The validation rules for a select field.

', ], ], 'SendDestinationNumberVerificationCodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendDestinationNumberVerificationCodeResult' => [ 'base' => NULL, 'refs' => [], ], 'SendTextMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendTextMessageResult' => [ 'base' => NULL, 'refs' => [], ], 'SendVoiceMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendVoiceMessageResult' => [ 'base' => NULL, 'refs' => [], ], 'SenderId' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$DefaultSenderId' => '

The default sender ID used by the ConfigurationSet.

', 'DeleteConfigurationSetResult$DefaultSenderId' => '

The default Sender ID of the configuration set that was deleted.

', 'DeleteDefaultSenderIdResult$SenderId' => '

The current sender ID for the configuration set.

', 'ReleaseSenderIdResult$SenderId' => '

The sender ID that was released.

', 'RequestSenderIdRequest$SenderId' => '

The sender ID string to request.

', 'RequestSenderIdResult$SenderId' => '

The sender ID that was requested.

', 'SenderIdInformation$SenderId' => '

The alphanumeric sender ID in a specific country that you\'d like to describe.

', 'SetDefaultSenderIdRequest$SenderId' => '

The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as \'NOTICE\'.

', 'SetDefaultSenderIdResult$SenderId' => '

The default sender ID to set for the ConfigurationSet.

', 'UpdateSenderIdResult$SenderId' => '

The sender ID that was updated.

', ], ], 'SenderIdAndCountry' => [ 'base' => '

The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.

', 'refs' => [ 'SenderIdList$member' => NULL, ], ], 'SenderIdFilter' => [ 'base' => '

The information for a sender ID that meets a specified criteria.

', 'refs' => [ 'SenderIdFilterList$member' => NULL, ], ], 'SenderIdFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeSenderIdsRequest$Filters' => '

An array of SenderIdFilter objects to filter the results.

', ], ], 'SenderIdFilterName' => [ 'base' => NULL, 'refs' => [ 'SenderIdFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'SenderIdInformation' => [ 'base' => '

The information for all SenderIds in an Amazon Web Services account.

', 'refs' => [ 'SenderIdInformationList$member' => NULL, ], ], 'SenderIdInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeSenderIdsResult$SenderIds' => '

An array of SernderIdInformation objects that contain the details for the requested SenderIds.

', ], ], 'SenderIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeSenderIdsRequest$SenderIds' => '

An array of SenderIdAndCountry objects to search for.

', ], ], 'SenderIdOrArn' => [ 'base' => NULL, 'refs' => [ 'ReleaseSenderIdRequest$SenderId' => '

The sender ID to release.

', 'SenderIdAndCountry$SenderId' => '

The unique identifier of the sender.

', 'UpdateSenderIdRequest$SenderId' => '

The sender ID to update.

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

The request would cause a service quota to be exceeded.

', 'refs' => [], ], 'ServiceQuotaExceededExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ServiceQuotaExceededException$Reason' => '

The reason for the exception.

', ], ], 'SetDefaultMessageTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultMessageTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'SetTextMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetTextMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'SetVoiceMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetVoiceMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'SnsDestination' => [ 'base' => '

An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.

', 'refs' => [ 'CreateEventDestinationRequest$SnsDestination' => '

An object that contains information about an event destination for logging to Amazon SNS.

', 'EventDestination$SnsDestination' => '

An object that contains information about an event destination that sends logging events to Amazon SNS.

', 'UpdateEventDestinationRequest$SnsDestination' => '

An object that contains information about an event destination that sends data to Amazon SNS.

', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'SnsDestination$TopicArn' => '

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

', ], ], 'SpendLimit' => [ 'base' => '

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

', 'refs' => [ 'SpendLimitList$member' => NULL, ], ], 'SpendLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeSpendLimitsResult$SpendLimits' => '

An array of SpendLimit objects that contain the details for the requested spend limits.

', ], ], 'SpendLimitName' => [ 'base' => NULL, 'refs' => [ 'SpendLimit$Name' => '

The name for the SpendLimit.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AccountAttribute$Value' => '

The value associated with the account attribute name.

', 'AssociateOriginationIdentityResult$PoolArn' => '

The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.

', 'AssociateOriginationIdentityResult$PoolId' => '

The PoolId of the pool that is now associated with the origination identity.

', 'AssociateOriginationIdentityResult$OriginationIdentityArn' => '

The PhoneNumberArn or SenderIdArn of the origination identity.

', 'AssociateOriginationIdentityResult$OriginationIdentity' => '

The PhoneNumberId or SenderId of the origination identity.

', 'ConfigurationSetInformation$ConfigurationSetArn' => '

The Resource Name (ARN) of the ConfigurationSet.

', 'ConflictException$Message' => NULL, 'ConflictException$ResourceId' => '

The unique identifier of the request.

', 'CreateConfigurationSetResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the newly created configuration set.

', 'CreateEventDestinationResult$ConfigurationSetArn' => '

The ARN of the configuration set.

', 'CreateOptOutListResult$OptOutListArn' => '

The Amazon Resource Name (ARN) for the OptOutList.

', 'CreatePoolResult$PoolArn' => '

The Amazon Resource Name (ARN) for the pool.

', 'CreatePoolResult$PoolId' => '

The unique identifier for the pool.

', 'CreateRegistrationAssociationResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'CreateRegistrationAssociationResult$RegistrationId' => '

The unique identifier for the registration.

', 'CreateRegistrationAssociationResult$ResourceArn' => '

The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

', 'CreateRegistrationAssociationResult$ResourceId' => '

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

', 'CreateRegistrationAssociationResult$ResourceType' => '

The registration type or origination identity type.

', 'CreateRegistrationAttachmentResult$RegistrationAttachmentArn' => '

The Amazon Resource Name (ARN) for the registration attachment.

', 'CreateRegistrationAttachmentResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'CreateRegistrationResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'CreateRegistrationResult$RegistrationId' => '

The unique identifier for the registration.

', 'CreateRegistrationVersionResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'CreateRegistrationVersionResult$RegistrationId' => '

The unique identifier for the registration.

', 'CreateVerifiedDestinationNumberResult$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'CreateVerifiedDestinationNumberResult$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'DeleteConfigurationSetResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the deleted configuration set.

', 'DeleteDefaultMessageTypeResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DeleteDefaultSenderIdResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DeleteEventDestinationResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DeleteKeywordResult$OriginationIdentityArn' => '

The PhoneNumberArn or PoolArn that the keyword was associated with.

', 'DeleteKeywordResult$OriginationIdentity' => '

The PhoneNumberId or PoolId that the keyword was associated with.

', 'DeleteOptOutListResult$OptOutListArn' => '

The Amazon Resource Name (ARN) of the OptOutList that was removed.

', 'DeleteOptedOutNumberResult$OptOutListArn' => '

The OptOutListArn that the phone number was removed from.

', 'DeletePoolResult$PoolArn' => '

The Amazon Resource Name (ARN) of the pool that was deleted.

', 'DeletePoolResult$PoolId' => '

The PoolId of the pool that was deleted.

', 'DeleteRegistrationAttachmentResult$RegistrationAttachmentArn' => '

The Amazon Resource Name (ARN) for the registration attachment.

', 'DeleteRegistrationAttachmentResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'DeleteRegistrationFieldValueResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DeleteRegistrationFieldValueResult$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteRegistrationFieldValueResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'DeleteRegistrationResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DeleteRegistrationResult$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteVerifiedDestinationNumberResult$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'DeleteVerifiedDestinationNumberResult$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'DescribeKeywordsResult$OriginationIdentityArn' => '

The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

', 'DescribeKeywordsResult$OriginationIdentity' => '

The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

', 'DescribeOptedOutNumbersResult$OptOutListArn' => '

The Amazon Resource Name (ARN) of the OptOutList.

', 'DescribeRegistrationFieldValuesResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DescribeRegistrationFieldValuesResult$RegistrationId' => '

The unique identifier for the registration.

', 'DescribeRegistrationVersionsResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DescribeRegistrationVersionsResult$RegistrationId' => '

The unique identifier for the registration.

', 'DisassociateOriginationIdentityResult$PoolArn' => '

The Amazon Resource Name (ARN) of the pool.

', 'DisassociateOriginationIdentityResult$PoolId' => '

The PoolId of the pool no longer associated with the origination identity.

', 'DisassociateOriginationIdentityResult$OriginationIdentityArn' => '

The PhoneNumberArn or SenderIdArn of the origination identity.

', 'DisassociateOriginationIdentityResult$OriginationIdentity' => '

The PhoneNumberId or SenderId of the origination identity.

', 'DiscardRegistrationVersionResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DiscardRegistrationVersionResult$RegistrationId' => '

The unique identifier for the registration.

', 'InternalServerException$Message' => NULL, 'InternalServerException$RequestId' => '

The unique identifier of the request.

', 'ListPoolOriginationIdentitiesResult$PoolArn' => '

The Amazon Resource Name (ARN) for the pool.

', 'ListPoolOriginationIdentitiesResult$PoolId' => '

The unique PoolId of the pool.

', 'ListRegistrationAssociationsResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'ListRegistrationAssociationsResult$RegistrationId' => '

The unique identifier for the registration.

', 'OptOutListInformation$OptOutListArn' => '

The Amazon Resource Name (ARN) of the OptOutList.

', 'OriginationIdentityMetadata$OriginationIdentityArn' => '

The Amazon Resource Name (ARN) associated with the origination identity.

', 'OriginationIdentityMetadata$OriginationIdentity' => '

The unique identifier of the origination identity.

', 'PhoneNumberInformation$PhoneNumberArn' => '

The Amazon Resource Name (ARN) associated with the phone number.

', 'PhoneNumberInformation$PhoneNumberId' => '

The unique identifier for the phone number.

', 'PhoneNumberInformation$MonthlyLeasingPrice' => '

The price, in US dollars, to lease the phone number.

', 'PhoneNumberInformation$PoolId' => '

The unique identifier of the pool associated with the phone number.

', 'PhoneNumberInformation$RegistrationId' => '

The unique identifier for the registration.

', 'PoolInformation$PoolArn' => '

The Amazon Resource Name (ARN) for the pool.

', 'PoolInformation$PoolId' => '

The unique identifier for the pool.

', 'PutKeywordResult$OriginationIdentityArn' => '

The PhoneNumberArn or PoolArn that the keyword was associated with.

', 'PutKeywordResult$OriginationIdentity' => '

The PhoneNumberId or PoolId that the keyword was associated with.

', 'PutOptedOutNumberResult$OptOutListArn' => '

The OptOutListArn that the phone number was removed from.

', 'PutRegistrationFieldValueResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'PutRegistrationFieldValueResult$RegistrationId' => '

The unique identifier for the registration.

', 'PutRegistrationFieldValueResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'RegistrationAssociationMetadata$ResourceArn' => '

The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

', 'RegistrationAssociationMetadata$ResourceId' => '

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

', 'RegistrationAssociationMetadata$ResourceType' => '

The origination identity type.

', 'RegistrationAttachmentsInformation$RegistrationAttachmentArn' => '

The Amazon Resource Name (ARN) for the registration attachment.

', 'RegistrationAttachmentsInformation$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'RegistrationDeniedReasonInformation$Reason' => '

The reason a registration was rejected.

', 'RegistrationDeniedReasonInformation$ShortDescription' => '

A short description of the rejection reason.

', 'RegistrationDeniedReasonInformation$LongDescription' => '

A long description of the rejection reason.

', 'RegistrationDeniedReasonInformation$DocumentationTitle' => '

The title of the document.

', 'RegistrationDeniedReasonInformation$DocumentationLink' => '

The link to the document.

', 'RegistrationFieldDisplayHints$Title' => '

The title of the display hint.

', 'RegistrationFieldDisplayHints$ShortDescription' => '

A short description of the display hint.

', 'RegistrationFieldDisplayHints$LongDescription' => '

A full description of the display hint.

', 'RegistrationFieldDisplayHints$DocumentationTitle' => '

The title of the document the display hint is associated with.

', 'RegistrationFieldDisplayHints$DocumentationLink' => '

The link to the document the display hint is associated with.

', 'RegistrationFieldDisplayHints$TextValidationDescription' => '

The validation rules for the text field.

', 'RegistrationFieldDisplayHints$ExampleTextValue' => '

Example text of what the value of a field should contain.

', 'RegistrationFieldValueInformation$DeniedReason' => '

A description of why the registration was denied.

', 'RegistrationInformation$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'RegistrationInformation$RegistrationId' => '

The unique identifier for the registration.

', 'RegistrationSectionDisplayHints$Title' => '

The title of the display hint.

', 'RegistrationSectionDisplayHints$ShortDescription' => '

A short description of the display hint.

', 'RegistrationSectionDisplayHints$LongDescription' => '

A full description of the display hint.

', 'RegistrationSectionDisplayHints$DocumentationTitle' => '

The title of the document the display hint is associated with.

', 'RegistrationSectionDisplayHints$DocumentationLink' => '

The link to the document the display hint is associated with.

', 'RegistrationTypeDisplayHints$Title' => '

The title of the display hint.

', 'RegistrationTypeDisplayHints$ShortDescription' => '

A short description of the display hint.

', 'RegistrationTypeDisplayHints$LongDescription' => '

A full description of the display hint.

', 'RegistrationTypeDisplayHints$DocumentationTitle' => '

The title of the document the display hint is associated with.

', 'RegistrationTypeDisplayHints$DocumentationLink' => '

The link to the document the display hint is associated with.

', 'ReleasePhoneNumberResult$PhoneNumberArn' => '

The PhoneNumberArn of the phone number that was released.

', 'ReleasePhoneNumberResult$PhoneNumberId' => '

The PhoneNumberId of the phone number that was released.

', 'ReleasePhoneNumberResult$MonthlyLeasingPrice' => '

The monthly price of the phone number, in US dollars.

', 'ReleasePhoneNumberResult$RegistrationId' => '

The unique identifier for the registration.

', 'ReleaseSenderIdResult$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'ReleaseSenderIdResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the sender ID.

', 'ReleaseSenderIdResult$RegistrationId' => '

The unique identifier for the registration.

', 'RequestPhoneNumberResult$PhoneNumberArn' => '

The Amazon Resource Name (ARN) of the requested phone number.

', 'RequestPhoneNumberResult$PhoneNumberId' => '

The unique identifier of the new phone number.

', 'RequestPhoneNumberResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the phone number.

', 'RequestPhoneNumberResult$PoolId' => '

The unique identifier of the pool associated with the phone number

', 'RequestPhoneNumberResult$RegistrationId' => '

The unique identifier for the registration.

', 'RequestSenderIdResult$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'RequestSenderIdResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the sender ID.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$ResourceId' => '

The unique identifier of the resource.

', 'SelectOptionDescription$Option' => '

The value of the option.

', 'SelectOptionDescription$Title' => '

The title of the select option.

', 'SelectOptionDescription$Description' => '

A description of the option meaning.

', 'SendDestinationNumberVerificationCodeResult$MessageId' => '

The unique identifier for the message.

', 'SendTextMessageResult$MessageId' => '

The unique identifier for the message.

', 'SendVoiceMessageResult$MessageId' => '

The unique identifier for the message.

', 'SenderIdInformation$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'SenderIdInformation$MonthlyLeasingPrice' => '

The monthly leasing price, in US dollars.

', 'SenderIdInformation$RegistrationId' => '

The unique identifier for the registration.

', 'ServiceQuotaExceededException$Message' => NULL, 'SetDefaultMessageTypeResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the updated configuration set.

', 'SetDefaultSenderIdResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the updated configuration set.

', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitRegistrationVersionResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'SubmitRegistrationVersionResult$RegistrationId' => '

The unique identifier for the registration.

', 'SupportedAssociation$ResourceType' => '

Defines the behavior of when an origination identity and registration can be associated with each other.

', 'TextValidation$Pattern' => '

The regular expression used to validate the text field.

', 'ThrottlingException$Message' => NULL, 'UpdateEventDestinationResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.

', 'UpdatePhoneNumberResult$PhoneNumberArn' => '

The Amazon Resource Name (ARN) of the updated phone number.

', 'UpdatePhoneNumberResult$PhoneNumberId' => '

The unique identifier of the phone number.

', 'UpdatePhoneNumberResult$MonthlyLeasingPrice' => '

The monthly leasing price of the phone number, in US dollars.

', 'UpdatePhoneNumberResult$RegistrationId' => '

The unique identifier for the registration.

', 'UpdatePoolResult$PoolArn' => '

The ARN of the pool.

', 'UpdatePoolResult$PoolId' => '

The unique identifier of the pool.

', 'UpdateSenderIdResult$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'UpdateSenderIdResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the sender ID.

', 'UpdateSenderIdResult$RegistrationId' => '

The unique identifier for the registration.

', 'ValidationException$Message' => NULL, 'ValidationExceptionField$Name' => '

The name of the field.

', 'ValidationExceptionField$Message' => '

The message associated with the validation exception with information to help determine its cause.

', 'VerifiedDestinationNumberInformation$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'VerifiedDestinationNumberInformation$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'VerifyDestinationNumberResult$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'VerifyDestinationNumberResult$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'SelectValidation$Options' => '

An array of strings for the possible selection options.

', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationResult$AdditionalAttributes' => '

Metadata about a given registration which is specific to that registration type.

', 'DeleteRegistrationResult$AdditionalAttributes' => '

Metadata about a given registration which is specific to that registration type.

', 'RegistrationInformation$AdditionalAttributes' => '

Metadata about a given registration which is specific to that registration type.

', ], ], 'SubmitRegistrationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitRegistrationVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'SupportedAssociation' => [ 'base' => '

The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.

', 'refs' => [ 'SupportedAssociationList$member' => NULL, ], ], 'SupportedAssociationList' => [ 'base' => NULL, 'refs' => [ 'RegistrationTypeDefinition$SupportedAssociations' => '

The supported association behavior for the registration type.

', ], ], 'Tag' => [ 'base' => '

The list of tags to be added to the specified topic.

', 'refs' => [ 'NonEmptyTagList$member' => NULL, 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The key identifier, or name, of the tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

An array of tag key values to unassociate with the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateConfigurationSetRequest$Tags' => '

An array of key and value pair tags that\'s associated with the new configuration set.

', 'CreateConfigurationSetResult$Tags' => '

An array of key and value pair tags that\'s associated with the configuration set.

', 'CreateOptOutListRequest$Tags' => '

An array of tags (key and value pairs) to associate with the new OptOutList.

', 'CreateOptOutListResult$Tags' => '

An array of tags (key and value pairs) associated with the new OptOutList.

', 'CreatePoolRequest$Tags' => '

An array of tags (key and value pairs) associated with the pool.

', 'CreatePoolResult$Tags' => '

An array of tags (key and value pairs) associated with the pool.

', 'CreateRegistrationAttachmentRequest$Tags' => '

An array of tags (key and value pairs) to associate with the registration attachment.

', 'CreateRegistrationAttachmentResult$Tags' => '

An array of tags (key and value pairs) to associate with the registration attachment.

', 'CreateRegistrationRequest$Tags' => '

An array of tags (key and value pairs) to associate with the registration.

', 'CreateRegistrationResult$Tags' => '

An array of tags (key and value pairs) to associate with the registration.

', 'CreateVerifiedDestinationNumberRequest$Tags' => '

An array of tags (key and value pairs) to associate with the destination number.

', 'CreateVerifiedDestinationNumberResult$Tags' => '

An array of tags (key and value pairs) to associate with the destination number.

', 'ListTagsForResourceResult$Tags' => '

An array of key and value pair tags that are associated with the resource.

', 'RequestPhoneNumberRequest$Tags' => '

An array of tags (key and value pairs) associate with the requested phone number.

', 'RequestPhoneNumberResult$Tags' => '

An array of key and value pair tags that are associated with the phone number.

', 'RequestSenderIdRequest$Tags' => '

An array of tags (key and value pairs) to associate with the sender ID.

', 'RequestSenderIdResult$Tags' => '

An array of tags (key and value pairs) to associate with the sender ID.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The string value associated with the key of the tag.

', ], ], 'TextMessageBody' => [ 'base' => NULL, 'refs' => [ 'SendTextMessageRequest$MessageBody' => '

The body of the text message.

', ], ], 'TextMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendTextMessageRequest$OriginationIdentity' => '

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

', ], ], 'TextValidation' => [ 'base' => '

Validation rules for a text field.

', 'refs' => [ 'RegistrationFieldDefinition$TextValidation' => '

The validation rules for a text field.

', ], ], 'TextValue' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationFieldValueResult$TextValue' => '

The text data for a free form field.

', 'PutRegistrationFieldValueRequest$TextValue' => '

The text data for a free form field.

', 'PutRegistrationFieldValueResult$TextValue' => '

The text data for a free form field.

', 'RegistrationFieldValueInformation$TextValue' => '

The text data for a free form field.

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

An error that occurred because too many requests were sent during a certain amount of time.

', 'refs' => [], ], 'TimeToLive' => [ 'base' => NULL, 'refs' => [ 'SendTextMessageRequest$TimeToLive' => '

How long the text message is valid for. By default this is 72 hours.

', 'SendVoiceMessageRequest$TimeToLive' => '

How long the voice message is valid for. By default this is 72 hours.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$CreatedTimestamp' => '

The time when the ConfigurationSet was created, in UNIX epoch time format.

', 'CreateConfigurationSetResult$CreatedTimestamp' => '

The time when the configuration set was created, in UNIX epoch time format.

', 'CreateOptOutListResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'CreatePoolResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'CreateRegistrationAttachmentResult$CreatedTimestamp' => '

The time when the registration attachment was created, in UNIX epoch time format.

', 'CreateRegistrationResult$CreatedTimestamp' => '

The time when the registration was created, in UNIX epoch time format.

', 'CreateVerifiedDestinationNumberResult$CreatedTimestamp' => '

The time when the verified phone number was created, in UNIX epoch time format.

', 'DeleteConfigurationSetResult$CreatedTimestamp' => '

The time that the deleted configuration set was created in UNIX epoch time format.

', 'DeleteOptOutListResult$CreatedTimestamp' => '

The time when the OptOutList was created, in UNIX epoch time format.

', 'DeleteOptedOutNumberResult$OptedOutTimestamp' => '

The time that the number was removed at, in UNIX epoch time format.

', 'DeletePoolResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'DeleteRegistrationAttachmentResult$CreatedTimestamp' => '

The time when the registration attachment was created, in UNIX epoch time format.

', 'DeleteRegistrationResult$CreatedTimestamp' => '

The time when the registration was created, in UNIX epoch time format.

', 'DeleteVerifiedDestinationNumberResult$CreatedTimestamp' => '

The time when the destination phone number was created, in UNIX epoch time format.

', 'OptOutListInformation$CreatedTimestamp' => '

The time when the OutOutList was created, in UNIX epoch time format.

', 'OptedOutNumberInformation$OptedOutTimestamp' => '

The time that the op tout occurred, in UNIX epoch time format.

', 'PhoneNumberInformation$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'PoolInformation$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'PutOptedOutNumberResult$OptedOutTimestamp' => '

The time that the phone number was added to the OptOutList, in UNIX epoch time format.

', 'RegistrationAttachmentsInformation$CreatedTimestamp' => '

The time when the registration attachment was created, in UNIX epoch time format.

', 'RegistrationInformation$CreatedTimestamp' => '

The time when the registration was created, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$DraftTimestamp' => '

The time when the registration was in the draft state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$SubmittedTimestamp' => '

The time when the registration was in the submitted state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$ReviewingTimestamp' => '

The time when the registration was in the reviewing state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$ApprovedTimestamp' => '

The time when the registration was in the approved state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$DiscardedTimestamp' => '

The time when the registration was in the discarded state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$DeniedTimestamp' => '

The time when the registration was in the denied state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$RevokedTimestamp' => '

The time when the registration was in the revoked state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$ArchivedTimestamp' => '

The time when the registration was in the archived state, in UNIX epoch time format.

', 'ReleasePhoneNumberResult$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'RequestPhoneNumberResult$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'UpdatePhoneNumberResult$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'UpdatePoolResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'VerifiedDestinationNumberInformation$CreatedTimestamp' => '

The time when the destination phone number was created, in UNIX epoch time format.

', 'VerifyDestinationNumberResult$CreatedTimestamp' => '

The time when the destination phone number was created, in UNIX epoch time format.

', ], ], 'TwoWayChannelArn' => [ 'base' => NULL, 'refs' => [ 'CreatePoolResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'DeletePoolResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the TwoWayChannel.

', 'PhoneNumberInformation$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'PoolInformation$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'ReleasePhoneNumberResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the TwoWayChannel.

', 'RequestPhoneNumberResult$TwoWayChannelArn' => '

The ARN used to identify the two way channel.

', 'UpdatePhoneNumberRequest$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'UpdatePhoneNumberResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'UpdatePoolRequest$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'UpdatePoolResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventDestinationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePoolResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

A validation exception for a field.

', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '

The field associated with the validation exception.

', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Fields' => '

The field that failed validation.

', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Reason' => '

The reason for the exception.

', ], ], 'VerificationChannel' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$VerificationChannel' => '

Choose to send the verification code as an SMS or voice message.

', ], ], 'VerificationCode' => [ 'base' => NULL, 'refs' => [ 'VerifyDestinationNumberRequest$VerificationCode' => '

The verification code that was received by the verified destination phone number.

', ], ], 'VerificationMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$OriginationIdentity' => '

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

', ], ], 'VerificationStatus' => [ 'base' => NULL, 'refs' => [ 'CreateVerifiedDestinationNumberResult$Status' => '

The status of the verified destination phone number.

', 'VerifiedDestinationNumberInformation$Status' => '

The status of the verified destination phone number.

', 'VerifyDestinationNumberResult$Status' => '

The status for being able to send messages to the phone number.

', ], ], 'VerifiedDestinationNumberFilter' => [ 'base' => '

The filter definition for filtering verified destination phone numbers that meets a specified criteria.

', 'refs' => [ 'VerifiedDestinationNumberFilterList$member' => NULL, ], ], 'VerifiedDestinationNumberFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersRequest$Filters' => '

An array of VerifiedDestinationNumberFilter objects to filter the results.

', ], ], 'VerifiedDestinationNumberFilterName' => [ 'base' => NULL, 'refs' => [ 'VerifiedDestinationNumberFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'VerifiedDestinationNumberIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersRequest$VerifiedDestinationNumberIds' => '

An array of VerifiedDestinationNumberid to retreive.

', ], ], 'VerifiedDestinationNumberIdOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteVerifiedDestinationNumberRequest$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'SendDestinationNumberVerificationCodeRequest$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'VerifiedDestinationNumberIdList$member' => NULL, 'VerifyDestinationNumberRequest$VerifiedDestinationNumberId' => '

The unique identifier for the verififed destination phone number.

', ], ], 'VerifiedDestinationNumberInformation' => [ 'base' => '

Provides information about the requested verified destintion phone number.

', 'refs' => [ 'VerifiedDestinationNumberInformationList$member' => NULL, ], ], 'VerifiedDestinationNumberInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersResult$VerifiedDestinationNumbers' => '

An array of VerifiedDestinationNumberInformation objects

', ], ], 'VerifyDestinationNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'VerifyDestinationNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'VoiceId' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$VoiceId' => '

The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

', ], ], 'VoiceMessageBody' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$MessageBody' => '

The text to convert to a voice message.

', ], ], 'VoiceMessageBodyTextType' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$MessageBodyTextType' => '

Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

', ], ], 'VoiceMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$OriginationIdentity' => '

The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

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

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.

If you\'re new to Amazon Pinpoint SMS, it\'s also helpful to review the Amazon Pinpoint SMS User Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

', 'operations' => [ 'AssociateOriginationIdentity' => '

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn\'t match the pool\'s configuration, an error is returned.

', 'AssociateProtectConfiguration' => '

Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.

', 'CreateConfigurationSet' => '

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

', 'CreateEventDestination' => '

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

', 'CreateOptOutList' => '

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can\'t send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.

', 'CreatePool' => '

Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn\'t inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

', 'CreateProtectConfiguration' => '

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

', 'CreateRegistration' => '

Creates a new registration based on the RegistrationType field.

', 'CreateRegistrationAssociation' => '

Associate the registration with an origination identity such as a phone number or sender ID.

', 'CreateRegistrationAttachment' => '

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

', 'CreateRegistrationVersion' => '

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

', 'CreateVerifiedDestinationNumber' => '

You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.

', 'DeleteAccountDefaultProtectConfiguration' => '

Removes the current account default protect configuration.

', 'DeleteConfigurationSet' => '

Deletes an existing configuration set.

A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

', 'DeleteDefaultMessageType' => '

Deletes an existing default message type on a configuration set.

A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

', 'DeleteDefaultSenderId' => '

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients\' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

', 'DeleteEventDestination' => '

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

', 'DeleteKeyword' => '

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords "HELP" and "STOP" can\'t be deleted or modified.

', 'DeleteMediaMessageSpendLimitOverride' => '

Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.

', 'DeleteOptOutList' => '

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn\'t exist or is in-use by an origination phone number or pool, an error is returned.

', 'DeleteOptedOutNumber' => '

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn\'t exist or if the opt-out list doesn\'t exist, an error is returned.

', 'DeletePool' => '

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn\'t active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

', 'DeleteProtectConfiguration' => '

Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.

', 'DeleteRegistration' => '

Permanently delete an existing registration from your account.

', 'DeleteRegistrationAttachment' => '

Permanently delete the specified registration attachment.

', 'DeleteRegistrationFieldValue' => '

Delete the value in a registration form field.

', 'DeleteTextMessageSpendLimitOverride' => '

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

', 'DeleteVerifiedDestinationNumber' => '

Delete a verified destination phone number.

', 'DeleteVoiceMessageSpendLimitOverride' => '

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

', 'DescribeAccountAttributes' => '

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you\'re ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

', 'DescribeAccountLimits' => '

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

', 'DescribeConfigurationSets' => '

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don\'t specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn\'t valid, an error is returned.

', 'DescribeKeywords' => '

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn\'t valid, an error is returned.

', 'DescribeOptOutLists' => '

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don\'t specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn\'t valid, an error is returned.

', 'DescribeOptedOutNumbers' => '

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don\'t specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn\'t valid, an error is returned.

', 'DescribePhoneNumbers' => '

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don\'t specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn\'t valid, an error is returned.

', 'DescribePools' => '

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don\'t specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn\'t valid, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

', 'DescribeProtectConfigurations' => '

Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

', 'DescribeRegistrationAttachments' => '

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

', 'DescribeRegistrationFieldDefinitions' => '

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

', 'DescribeRegistrationFieldValues' => '

Retrieves the specified registration field values.

', 'DescribeRegistrationSectionDefinitions' => '

Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.

', 'DescribeRegistrationTypeDefinitions' => '

Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.

', 'DescribeRegistrationVersions' => '

Retrieves the specified registration version.

', 'DescribeRegistrations' => '

Retrieves the specified registrations.

', 'DescribeSenderIds' => '

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don\'t specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn\'t valid, an error is returned.

', 'DescribeSpendLimits' => '

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

', 'DescribeVerifiedDestinationNumbers' => '

Retrieves the specified verified destiona numbers.

', 'DisassociateOriginationIdentity' => '

Removes the specified origination identity from an existing pool.

If the origination identity isn\'t associated with the specified pool, an error is returned.

', 'DisassociateProtectConfiguration' => '

Disassociate a protect configuration from a configuration set.

', 'DiscardRegistrationVersion' => '

Discard the current version of the registration.

', 'GetProtectConfigurationCountryRuleSet' => '

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

', 'ListPoolOriginationIdentities' => '

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

', 'ListRegistrationAssociations' => '

Retreive all of the origination identies that are associated with a registration.

', 'ListTagsForResource' => '

List all tags associated with a resource.

', 'PutKeyword' => '

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn\'t valid, an error is returned.

', 'PutOptedOutNumber' => '

Creates an opted out destination phone number in the opt-out list.

If the destination phone number isn\'t valid or if the specified opt-out list doesn\'t exist, an error is returned.

', 'PutRegistrationFieldValue' => '

Creates or updates a field value for a registration.

', 'ReleasePhoneNumber' => '

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.

', 'ReleaseSenderId' => '

Releases an existing sender ID in your account.

', 'RequestPhoneNumber' => '

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.

', 'RequestSenderId' => '

Request a new sender ID that doesn\'t require registration.

', 'SendDestinationNumberVerificationCode' => '

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.

', 'SendMediaMessage' => '

Creates a new multimedia message (MMS) and sends it to a recipient\'s phone number.

', 'SendTextMessage' => '

Creates a new text message and sends it to a recipient\'s phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

', 'SendVoiceMessage' => '

Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.

', 'SetAccountDefaultProtectConfiguration' => '

Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.

', 'SetDefaultMessageType' => '

Sets the default message type on a configuration set.

Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

', 'SetDefaultSenderId' => '

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

', 'SetMediaMessageSpendLimitOverride' => '

Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

', 'SetTextMessageSpendLimitOverride' => '

Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

', 'SetVoiceMessageSpendLimitOverride' => '

Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

', 'SubmitRegistrationVersion' => '

Submit the specified registration for review and approval.

', 'TagResource' => '

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

', 'UntagResource' => '

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

', 'UpdateEventDestination' => '

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can\'t change an event destination\'s type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

', 'UpdatePhoneNumber' => '

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an error is returned.

', 'UpdatePool' => '

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

', 'UpdateProtectConfiguration' => '

Update the setting for an existing protect configuration.

', 'UpdateProtectConfigurationCountryRuleSet' => '

Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.

', 'UpdateSenderId' => '

Updates the configuration of an existing sender ID.

', 'VerifyDestinationNumber' => '

Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

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

The request was denied because you don\'t have sufficient permissions to access the resource.

', 'refs' => [], ], 'AccessDeniedExceptionReason' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Reason' => '

The reason for the exception.

', ], ], 'AccountAttribute' => [ 'base' => '

Displays the attributes associated with a single Amazon Web Services account.

', 'refs' => [ 'AccountAttributeList$member' => NULL, ], ], 'AccountAttributeList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountAttributesResult$AccountAttributes' => '

An array of AccountAttributes objects.

', ], ], 'AccountAttributeName' => [ 'base' => NULL, 'refs' => [ 'AccountAttribute$Name' => '

The name of the account attribute.

', ], ], 'AccountLimit' => [ 'base' => '

The current resource quotas associated with an Amazon Web Services account.

', 'refs' => [ 'AccountLimitList$member' => NULL, ], ], 'AccountLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsResult$AccountLimits' => '

An array of AccountLimit objects that show the current spend limits.

', ], ], 'AccountLimitName' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$Name' => '

The name of the attribute to apply the account limit to.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to query for.

', 'ListTagsForResourceResult$ResourceArn' => '

The ARN of the resource.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', ], ], 'AssociateOriginationIdentityRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateOriginationIdentityResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociateProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachmentBody' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAttachmentRequest$AttachmentBody' => '

The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.

', ], ], 'AttachmentStatus' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAttachmentResult$AttachmentStatus' => '

The status of the registration attachment.

', 'DeleteRegistrationAttachmentResult$AttachmentStatus' => '

The status of the registration attachment.

', 'RegistrationAttachmentsInformation$AttachmentStatus' => '

The status of the registration attachment.

', ], ], 'AttachmentUploadErrorReason' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationAttachmentResult$AttachmentUploadErrorReason' => '

The error message if the upload failed.

', 'RegistrationAttachmentsInformation$AttachmentUploadErrorReason' => '

A description of why the upload didn\'t successfully complete.

', ], ], 'AttachmentUrl' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAttachmentRequest$AttachmentUrl' => '

A URL to the required registration file. For example, you can provide the S3 object URL.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreatePoolRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the pool can\'t be deleted. You can change this value using the UpdatePool action.

', 'CreateProtectConfigurationRequest$DeletionProtectionEnabled' => '

When set to true deletion protection is enabled. By default this is set to false.

', 'EventDestination$Enabled' => '

When set to true events will be logged.

', 'RequestPhoneNumberRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the phone number can\'t be deleted.

', 'RequestSenderIdRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'UpdateEventDestinationRequest$Enabled' => '

When set to true logging is enabled.

', 'UpdatePhoneNumberRequest$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePhoneNumberRequest$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'UpdatePhoneNumberRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the phone number can\'t be deleted.

', 'UpdatePoolRequest$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePoolRequest$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'UpdatePoolRequest$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'UpdatePoolRequest$DeletionProtectionEnabled' => '

When set to true the pool can\'t be deleted.

', 'UpdateProtectConfigurationRequest$DeletionProtectionEnabled' => '

When set to true deletion protection is enabled. By default this is set to false.

', 'UpdateSenderIdRequest$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateConfigurationSetRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateEventDestinationRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateOptOutListRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreatePoolRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateProtectConfigurationRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateRegistrationAttachmentRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateRegistrationRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'CreateVerifiedDestinationNumberRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'DisassociateOriginationIdentityRequest$ClientToken' => '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'RequestPhoneNumberRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', 'RequestSenderIdRequest$ClientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don\'t specify a client token, a randomly generated token is used for the request to ensure idempotency.

', ], ], 'CloudWatchLogsDestination' => [ 'base' => '

Contains the destination configuration to use when publishing message sending events.

', 'refs' => [ 'CreateEventDestinationRequest$CloudWatchLogsDestination' => '

An object that contains information about an event destination for logging to Amazon CloudWatch Logs.

', 'EventDestination$CloudWatchLogsDestination' => '

An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

', 'UpdateEventDestinationRequest$CloudWatchLogsDestination' => '

An object that contains information about an event destination that sends data to CloudWatch Logs.

', ], ], 'ConfigurationSetFilter' => [ 'base' => '

The information for configuration sets that meet a specified criteria.

', 'refs' => [ 'ConfigurationSetFilterList$member' => NULL, ], ], 'ConfigurationSetFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationSetsRequest$Filters' => '

An array of filters to apply to the results that are returned.

', ], ], 'ConfigurationSetFilterName' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'ConfigurationSetInformation' => [ 'base' => '

Information related to a given configuration set in your Amazon Web Services account.

', 'refs' => [ 'ConfigurationSetInformationList$member' => NULL, ], ], 'ConfigurationSetInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationSetsResult$ConfigurationSets' => '

An array of ConfigurationSets objects.

', ], ], 'ConfigurationSetName' => [ 'base' => NULL, 'refs' => [ 'AssociateProtectConfigurationResult$ConfigurationSetName' => '

The name of the ConfigurationSet.

', 'ConfigurationSetInformation$ConfigurationSetName' => '

The name of the ConfigurationSet.

', 'CreateConfigurationSetRequest$ConfigurationSetName' => '

The name to use for the new configuration set.

', 'CreateConfigurationSetResult$ConfigurationSetName' => '

The name of the new configuration set.

', 'CreateEventDestinationResult$ConfigurationSetName' => '

The name of the configuration set.

', 'DeleteConfigurationSetResult$ConfigurationSetName' => '

The name of the deleted configuration set.

', 'DeleteDefaultMessageTypeResult$ConfigurationSetName' => '

The name of the configuration set.

', 'DeleteDefaultSenderIdResult$ConfigurationSetName' => '

The name of the configuration set.

', 'DeleteEventDestinationResult$ConfigurationSetName' => '

The name of the configuration set the event destination was deleted from.

', 'DisassociateProtectConfigurationResult$ConfigurationSetName' => '

The name of the ConfigurationSet.

', 'SetDefaultMessageTypeResult$ConfigurationSetName' => '

The name of the configuration set that was updated.

', 'SetDefaultSenderIdResult$ConfigurationSetName' => '

The name of the configuration set that was updated.

', 'UpdateEventDestinationResult$ConfigurationSetName' => '

The name of the configuration set.

', ], ], 'ConfigurationSetNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationSetsRequest$ConfigurationSetNames' => '

An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

', ], ], 'ConfigurationSetNameOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateProtectConfigurationRequest$ConfigurationSetName' => '

The name of the ConfigurationSet.

', 'ConfigurationSetNameList$member' => NULL, 'CreateEventDestinationRequest$ConfigurationSetName' => '

Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteConfigurationSetRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteDefaultMessageTypeRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteDefaultSenderIdRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DeleteEventDestinationRequest$ConfigurationSetName' => '

The name of the configuration set or the configuration set\'s Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

', 'DisassociateProtectConfigurationRequest$ConfigurationSetName' => '

The name of the ConfigurationSet.

', 'SendDestinationNumberVerificationCodeRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SendMediaMessageRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SendTextMessageRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SendVoiceMessageRequest$ConfigurationSetName' => '

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

', 'SetDefaultMessageTypeRequest$ConfigurationSetName' => '

The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

', 'SetDefaultSenderIdRequest$ConfigurationSetName' => '

The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

', 'UpdateEventDestinationRequest$ConfigurationSetName' => '

The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.

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

Your request has conflicting operations. This can occur if you\'re trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn\'t valid for the current state or configuration of the resource.

', 'refs' => [], ], 'ConflictExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Reason' => '

The reason for the exception.

', ], ], 'ContextKey' => [ 'base' => NULL, 'refs' => [ 'ContextMap$key' => NULL, ], ], 'ContextMap' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', 'SendMediaMessageRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', 'SendTextMessageRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', 'SendVoiceMessageRequest$Context' => '

You can specify custom data in this field. If you do, that data is logged to the event destination.

', ], ], 'ContextValue' => [ 'base' => NULL, 'refs' => [ 'ContextMap$value' => NULL, ], ], 'CreateConfigurationSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConfigurationSetResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventDestinationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptOutListRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptOutListResult' => [ 'base' => NULL, 'refs' => [], ], 'CreatePoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePoolResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationAttachmentResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegistrationVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateVerifiedDestinationNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVerifiedDestinationNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountDefaultProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountDefaultProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigurationSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigurationSetResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultMessageTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultMessageTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDefaultSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventDestinationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeywordRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeywordResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMediaMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMediaMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptOutListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptOutListResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptedOutNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptedOutNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePoolResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationAttachmentResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationFieldValueRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationFieldValueResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistrationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTextMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTextMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVerifiedDestinationNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVerifiedDestinationNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVoiceMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'DeliveryStreamArn' => [ 'base' => NULL, 'refs' => [ 'KinesisFirehoseDestination$DeliveryStreamArn' => '

The Amazon Resource Name (ARN) of the delivery stream.

', ], ], 'DescribeAccountAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationSetsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeywordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeywordsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptOutListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptOutListsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptedOutNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptedOutNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePoolsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePoolsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProtectConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProtectConfigurationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationAttachmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationAttachmentsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldDefinitionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldValuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationFieldValuesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationSectionDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationSectionDefinitionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationTypeDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationTypeDefinitionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegistrationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSenderIdsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSenderIdsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpendLimitsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpendLimitsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVerifiedDestinationNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVerifiedDestinationNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'DestinationCountryParameterKey' => [ 'base' => NULL, 'refs' => [ 'DestinationCountryParameters$key' => NULL, ], ], 'DestinationCountryParameterValue' => [ 'base' => NULL, 'refs' => [ 'DestinationCountryParameters$value' => NULL, ], ], 'DestinationCountryParameters' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$DestinationCountryParameters' => '

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

', 'SendTextMessageRequest$DestinationCountryParameters' => '

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

', ], ], 'DestinationPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersRequest$DestinationPhoneNumbers' => '

An array of verified destination phone number, in E.164 format.

', ], ], 'DisassociateOriginationIdentityRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateOriginationIdentityResult' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'DiscardRegistrationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscardRegistrationVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'EventDestination' => [ 'base' => '

Contains information about an event destination.

Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.

', 'refs' => [ 'CreateEventDestinationResult$EventDestination' => '

The details of the destination where events are logged.

', 'DeleteEventDestinationResult$EventDestination' => '

The event destination object that was deleted.

', 'EventDestinationList$member' => NULL, 'UpdateEventDestinationResult$EventDestination' => '

An EventDestination object containing the details of where events will be logged.

', ], ], 'EventDestinationList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$EventDestinations' => '

An array of EventDestination objects that describe any events to log and where to log them.

', 'DeleteConfigurationSetResult$EventDestinations' => '

An array of any EventDestination objects that were associated with the deleted configuration set.

', ], ], 'EventDestinationName' => [ 'base' => NULL, 'refs' => [ 'CreateEventDestinationRequest$EventDestinationName' => '

The name that identifies the event destination.

', 'DeleteEventDestinationRequest$EventDestinationName' => '

The name of the event destination to delete.

', 'EventDestination$EventDestinationName' => '

The name of the EventDestination.

', 'UpdateEventDestinationRequest$EventDestinationName' => '

The name to use for the event destination.

', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'EventTypeList$member' => NULL, ], ], 'EventTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateEventDestinationRequest$MatchingEventTypes' => '

An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.

The TEXT_SENT event type is not supported.

', 'EventDestination$MatchingEventTypes' => '

An array of event types that determine which events to log.

The TEXT_SENT event type is not supported.

', 'UpdateEventDestinationRequest$MatchingEventTypes' => '

An array of event types that determine which events to log.

The TEXT_SENT event type is not supported.

', ], ], 'FieldPath' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationFieldValueRequest$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'DeleteRegistrationFieldValueResult$FieldPath' => '

The path to the registration form field.

', 'FieldPathList$member' => NULL, 'PutRegistrationFieldValueRequest$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'PutRegistrationFieldValueResult$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'RegistrationFieldDefinition$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', 'RegistrationFieldValueInformation$FieldPath' => '

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

', ], ], 'FieldPathList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldDefinitionsRequest$FieldPaths' => '

An array of paths to the registration form field.

', 'DescribeRegistrationFieldValuesRequest$FieldPaths' => '

An array of paths to the registration form field.

', ], ], 'FieldRequirement' => [ 'base' => NULL, 'refs' => [ 'RegistrationFieldDefinition$FieldRequirement' => '

Specifies if the field for the registration form is required, conditional or optional.

', ], ], 'FieldType' => [ 'base' => NULL, 'refs' => [ 'RegistrationFieldDefinition$FieldType' => '

The type of field.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValueList$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetFilter$Values' => '

An array values to filter for.

', 'KeywordFilter$Values' => '

An array values to filter for.

', 'OptedOutFilter$Values' => '

An array of values to filter for.

', 'PhoneNumberFilter$Values' => '

An array values to filter for.

', 'PoolFilter$Values' => '

An array values to filter for.

', 'PoolOriginationIdentitiesFilter$Values' => '

An array values to filter for.

', 'ProtectConfigurationFilter$Values' => '

An array of values to filter for.

', 'RegistrationAssociationFilter$Values' => '

An array of values to filter for.

', 'RegistrationAttachmentFilter$Values' => '

An array of values to filter on.

', 'RegistrationFilter$Values' => '

An array of values to filter on.

', 'RegistrationTypeFilter$Values' => '

An array of values to filter on.

', 'RegistrationVersionFilter$Values' => '

An array of values to filter on.

', 'SenderIdFilter$Values' => '

An array of values to filter for.

', 'VerifiedDestinationNumberFilter$Values' => '

An array of values to filter on.

', ], ], 'GetProtectConfigurationCountryRuleSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProtectConfigurationCountryRuleSetResult' => [ 'base' => NULL, 'refs' => [], ], 'IamRoleArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogsDestination$IamRoleArn' => '

The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.

', 'CreatePoolResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'DeletePoolResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'KinesisFirehoseDestination$IamRoleArn' => '

The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.

', 'PhoneNumberInformation$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'PoolInformation$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'ReleasePhoneNumberResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'RequestPhoneNumberResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePhoneNumberRequest$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePhoneNumberResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePoolRequest$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', 'UpdatePoolResult$TwoWayChannelRole' => '

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'SelectValidation$MinChoices' => '

The minimum number of choices for the select.

', 'SelectValidation$MaxChoices' => '

The maximum number of choices for the select.

', 'TextValidation$MinLength' => '

The minimum number of characters for the text field.

', 'TextValidation$MaxLength' => '

The maximum number of characters for the text field.

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

The API encountered an unexpected error and couldn\'t complete the request. You might be able to successfully issue the request again in the future.

', 'refs' => [], ], 'IsoCountryCode' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$IsoCountryCode' => '

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.

', 'AssociateOriginationIdentityResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'CreatePoolRequest$IsoCountryCode' => '

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

', 'CreateRegistrationAssociationResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'DisassociateOriginationIdentityRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'DisassociateOriginationIdentityResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'OriginationIdentityMetadata$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'PhoneNumberInformation$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ProtectConfigurationCountryRuleSet$key' => NULL, 'RegistrationAssociationMetadata$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ReleasePhoneNumberResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ReleaseSenderIdRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'ReleaseSenderIdResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestPhoneNumberRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestPhoneNumberResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestSenderIdRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'RequestSenderIdResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'SenderIdAndCountry$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'SenderIdInformation$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'SupportedAssociation$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'UpdatePhoneNumberResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'UpdateSenderIdRequest$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', 'UpdateSenderIdResult$IsoCountryCode' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

', ], ], 'Keyword' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordRequest$Keyword' => '

The keyword to delete.

', 'DeleteKeywordResult$Keyword' => '

The keyword that was deleted.

', 'KeywordInformation$Keyword' => '

The keyword as a string.

', 'KeywordList$member' => NULL, 'PutKeywordRequest$Keyword' => '

The new keyword to add.

', 'PutKeywordResult$Keyword' => '

The keyword that was added.

', 'SendTextMessageRequest$Keyword' => '

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

', ], ], 'KeywordAction' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordResult$KeywordAction' => '

The action that was associated with the deleted keyword.

', 'KeywordInformation$KeywordAction' => '

The action to perform for the keyword.

', 'PutKeywordRequest$KeywordAction' => '

The action to perform for the new keyword when it is received.

', 'PutKeywordResult$KeywordAction' => '

The action to perform when the keyword is used.

', ], ], 'KeywordFilter' => [ 'base' => '

The information for keywords that meet a specified criteria.

', 'refs' => [ 'KeywordFilterList$member' => NULL, ], ], 'KeywordFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeKeywordsRequest$Filters' => '

An array of keyword filters to filter the results.

', ], ], 'KeywordFilterName' => [ 'base' => NULL, 'refs' => [ 'KeywordFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'KeywordInformation' => [ 'base' => '

The information for all keywords in a pool.

', 'refs' => [ 'KeywordInformationList$member' => NULL, ], ], 'KeywordInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeKeywordsResult$Keywords' => '

An array of KeywordInformation objects that contain the results.

', ], ], 'KeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeKeywordsRequest$Keywords' => '

An array of keywords to search for.

', ], ], 'KeywordMessage' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordResult$KeywordMessage' => '

The message that was associated with the deleted keyword.

', 'KeywordInformation$KeywordMessage' => '

A custom message that can be used with the keyword.

', 'PutKeywordRequest$KeywordMessage' => '

The message associated with the keyword.

', 'PutKeywordResult$KeywordMessage' => '

The message associated with the keyword.

', ], ], 'KinesisFirehoseDestination' => [ 'base' => '

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event destination.

Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.

', 'refs' => [ 'CreateEventDestinationRequest$KinesisFirehoseDestination' => '

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

', 'EventDestination$KinesisFirehoseDestination' => '

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

', 'UpdateEventDestinationRequest$KinesisFirehoseDestination' => '

An object that contains information about an event destination for logging to Kinesis Data Firehose.

', ], ], 'LanguageCode' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$LanguageCode' => '

Choose the language to use for the message.

', ], ], 'ListPoolOriginationIdentitiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPoolOriginationIdentitiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistrationAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistrationAssociationsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'LogGroupArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogsDestination$LogGroupArn' => '

The name of the Amazon CloudWatch log group that you want to record events in.

', ], ], 'MaxPrice' => [ 'base' => NULL, 'refs' => [ 'SendMediaMessageRequest$MaxPrice' => '

The maximum amount that you want to spend, in US dollars, per each MMS message.

', 'SendTextMessageRequest$MaxPrice' => '

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

', 'SendVoiceMessageRequest$MaxPricePerMinute' => '

The maximum amount to spend per voice message, in US dollars.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountAttributesRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeAccountLimitsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeConfigurationSetsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeKeywordsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeOptOutListsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeOptedOutNumbersRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribePhoneNumbersRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribePoolsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeProtectConfigurationsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationAttachmentsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationFieldDefinitionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationFieldValuesRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationSectionDefinitionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationTypeDefinitionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationVersionsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeRegistrationsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeSenderIdsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeSpendLimitsRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'DescribeVerifiedDestinationNumbersRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'ListPoolOriginationIdentitiesRequest$MaxResults' => '

The maximum number of results to return per each request.

', 'ListRegistrationAssociationsRequest$MaxResults' => '

The maximum number of results to return per each request.

', ], ], 'MediaMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendMediaMessageRequest$OriginationIdentity' => '

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

', ], ], 'MediaUrlList' => [ 'base' => NULL, 'refs' => [ 'SendMediaMessageRequest$MediaUrls' => '

An array of URLs to each media file to send.

The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.

', ], ], 'MediaUrlValue' => [ 'base' => NULL, 'refs' => [ 'MediaUrlList$member' => NULL, ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$DefaultMessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'CreatePoolRequest$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'CreatePoolResult$MessageType' => '

The type of message for the pool to use.

', 'DeleteConfigurationSetResult$DefaultMessageType' => '

The default message type of the configuration set that was deleted.

', 'DeleteDefaultMessageTypeResult$MessageType' => '

The current message type for the configuration set.

', 'DeletePoolResult$MessageType' => '

The message type that was associated with the deleted pool.

', 'MessageTypeList$member' => NULL, 'PhoneNumberInformation$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'PoolInformation$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'ReleasePhoneNumberResult$MessageType' => '

The message type that was associated with the phone number.

', 'RequestPhoneNumberRequest$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'RequestPhoneNumberResult$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SendTextMessageRequest$MessageType' => '

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SetDefaultMessageTypeRequest$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SetDefaultMessageTypeResult$MessageType' => '

The new default message type of the configuration set.

', 'UpdatePhoneNumberResult$MessageType' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'UpdatePoolResult$MessageType' => '

The type of message for the pool to use.

', ], ], 'MessageTypeList' => [ 'base' => NULL, 'refs' => [ 'ReleaseSenderIdResult$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'RequestSenderIdRequest$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'RequestSenderIdResult$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'SenderIdInformation$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', 'UpdateSenderIdResult$MessageTypes' => '

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren\'t critical or time-sensitive.

', ], ], 'MonthlyLimit' => [ 'base' => NULL, 'refs' => [ 'DeleteMediaMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit, in US dollars.

', 'DeleteTextMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit, in US dollars.

', 'DeleteVoiceMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit, in US dollars.

', 'SetMediaMessageSpendLimitOverrideRequest$MonthlyLimit' => '

The new monthly limit to enforce on text messages.

', 'SetMediaMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit to enforce on sending text messages.

', 'SetTextMessageSpendLimitOverrideRequest$MonthlyLimit' => '

The new monthly limit to enforce on text messages.

', 'SetTextMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit to enforce on sending text messages.

', 'SetVoiceMessageSpendLimitOverrideRequest$MonthlyLimit' => '

The new monthly limit to enforce on voice messages.

', 'SetVoiceMessageSpendLimitOverrideResult$MonthlyLimit' => '

The current monthly limit to enforce on sending voice messages.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountAttributesRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeAccountAttributesResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeAccountLimitsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeAccountLimitsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeConfigurationSetsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeConfigurationSetsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeKeywordsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeKeywordsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeOptOutListsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeOptOutListsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeOptedOutNumbersRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeOptedOutNumbersResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribePhoneNumbersRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribePhoneNumbersResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribePoolsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribePoolsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeProtectConfigurationsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeProtectConfigurationsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationAttachmentsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationAttachmentsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldDefinitionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldDefinitionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldValuesRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationFieldValuesResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationSectionDefinitionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationSectionDefinitionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationTypeDefinitionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationTypeDefinitionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationVersionsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationVersionsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeRegistrationsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeSenderIdsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeSenderIdsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeSpendLimitsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeSpendLimitsResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'DescribeVerifiedDestinationNumbersRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'DescribeVerifiedDestinationNumbersResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'ListPoolOriginationIdentitiesRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'ListPoolOriginationIdentitiesResult$NextToken' => '

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

', 'ListRegistrationAssociationsRequest$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', 'ListRegistrationAssociationsResult$NextToken' => '

The token to be used for the next set of paginated results. You don\'t need to supply a value for this field in the initial request.

', ], ], 'NonEmptyTagList' => [ 'base' => NULL, 'refs' => [ 'TagResourceRequest$Tags' => '

An array of key and value pair tags that are associated with the resource.

', ], ], 'NumberCapability' => [ 'base' => NULL, 'refs' => [ 'GetProtectConfigurationCountryRuleSetRequest$NumberCapability' => '

The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.

', 'GetProtectConfigurationCountryRuleSetResult$NumberCapability' => '

The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.

', 'NumberCapabilityList$member' => NULL, 'UpdateProtectConfigurationCountryRuleSetRequest$NumberCapability' => '

The number capability to apply the CountryRuleSetUpdates updates to.

', 'UpdateProtectConfigurationCountryRuleSetResult$NumberCapability' => '

The number capability that was updated

', ], ], 'NumberCapabilityList' => [ 'base' => NULL, 'refs' => [ 'OriginationIdentityMetadata$NumberCapabilities' => '

Describes if the origination identity can be used for text messages, voice calls or both.

', 'PhoneNumberInformation$NumberCapabilities' => '

Describes if the origination identity can be used for text messages, voice calls or both.

', 'ReleasePhoneNumberResult$NumberCapabilities' => '

Specifies if the number could be used for text messages, voice, or both.

', 'RequestPhoneNumberRequest$NumberCapabilities' => '

Indicates if the phone number will be used for text messages, voice messages, or both.

', 'RequestPhoneNumberResult$NumberCapabilities' => '

Indicates if the phone number will be used for text messages, voice messages or both.

', 'UpdatePhoneNumberResult$NumberCapabilities' => '

Specifies if the number could be used for text messages, voice or both.

', ], ], 'NumberStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberInformation$Status' => '

The current status of the phone number.

', 'ReleasePhoneNumberResult$Status' => '

The current status of the request.

', 'RequestPhoneNumberResult$Status' => '

The current status of the request.

', 'UpdatePhoneNumberResult$Status' => '

The current status of the request.

', ], ], 'NumberType' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberInformation$NumberType' => '

The type of phone number.

', 'ReleasePhoneNumberResult$NumberType' => '

The type of number that was released.

', 'UpdatePhoneNumberResult$NumberType' => '

The type of number that was requested.

', ], ], 'OptOutListInformation' => [ 'base' => '

The information for all OptOutList in an Amazon Web Services account.

', 'refs' => [ 'OptOutListInformationList$member' => NULL, ], ], 'OptOutListInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptOutListsResult$OptOutLists' => '

An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

', ], ], 'OptOutListName' => [ 'base' => NULL, 'refs' => [ 'CreateOptOutListRequest$OptOutListName' => '

The name of the new OptOutList.

', 'CreateOptOutListResult$OptOutListName' => '

The name of the new OptOutList.

', 'CreatePoolResult$OptOutListName' => '

The name of the OptOutList associated with the pool.

', 'DeleteOptOutListResult$OptOutListName' => '

The name of the OptOutList that was removed.

', 'DeleteOptedOutNumberResult$OptOutListName' => '

The OptOutListName that the phone number was removed from.

', 'DeletePoolResult$OptOutListName' => '

The name of the OptOutList that was associated with the deleted pool.

', 'DescribeOptedOutNumbersResult$OptOutListName' => '

The name of the OptOutList.

', 'OptOutListInformation$OptOutListName' => '

The name of the OptOutList.

', 'PhoneNumberInformation$OptOutListName' => '

The name of the OptOutList associated with the phone number.

', 'PoolInformation$OptOutListName' => '

The name of the OptOutList associated with the pool.

', 'PutOptedOutNumberResult$OptOutListName' => '

The OptOutListName that the phone number was removed from.

', 'ReleasePhoneNumberResult$OptOutListName' => '

The name of the OptOutList that was associated with the phone number.

', 'RequestPhoneNumberResult$OptOutListName' => '

The name of the OptOutList that is associated with the requested phone number.

', 'UpdatePhoneNumberResult$OptOutListName' => '

The name of the OptOutList associated with the phone number.

', 'UpdatePoolResult$OptOutListName' => '

The name of the OptOutList associated with the pool.

', ], ], 'OptOutListNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptOutListsRequest$OptOutListNames' => '

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

', ], ], 'OptOutListNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteOptOutListRequest$OptOutListName' => '

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

', 'DeleteOptedOutNumberRequest$OptOutListName' => '

The OptOutListName or OptOutListArn to remove the phone number from.

', 'DescribeOptedOutNumbersRequest$OptOutListName' => '

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

', 'OptOutListNameList$member' => NULL, 'PutOptedOutNumberRequest$OptOutListName' => '

The OptOutListName or OptOutListArn to add the phone number to.

', 'RequestPhoneNumberRequest$OptOutListName' => '

The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.

', 'UpdatePhoneNumberRequest$OptOutListName' => '

The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

', 'UpdatePoolRequest$OptOutListName' => '

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

', ], ], 'OptedOutFilter' => [ 'base' => '

The information for opted out numbers that meet a specified criteria.

', 'refs' => [ 'OptedOutFilterList$member' => NULL, ], ], 'OptedOutFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptedOutNumbersRequest$Filters' => '

An array of OptedOutFilter objects to filter the results on.

', ], ], 'OptedOutFilterName' => [ 'base' => NULL, 'refs' => [ 'OptedOutFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'OptedOutNumberInformation' => [ 'base' => '

The information for an opted out number in an Amazon Web Services account.

', 'refs' => [ 'OptedOutNumberInformationList$member' => NULL, ], ], 'OptedOutNumberInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptedOutNumbersResult$OptedOutNumbers' => '

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

', ], ], 'OptedOutNumberList' => [ 'base' => NULL, 'refs' => [ 'DescribeOptedOutNumbersRequest$OptedOutNumbers' => '

An array of phone numbers to search for in the OptOutList.

', ], ], 'OriginationIdentityMetadata' => [ 'base' => '

The metadata for an origination identity associated with a pool.

', 'refs' => [ 'OriginationIdentityMetadataList$member' => NULL, ], ], 'OriginationIdentityMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListPoolOriginationIdentitiesResult$OriginationIdentities' => '

An array of any OriginationIdentityMetadata objects.

', ], ], 'PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationResult$PhoneNumber' => '

The phone number associated with the registration in E.164 format.

', 'CreateVerifiedDestinationNumberRequest$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'CreateVerifiedDestinationNumberResult$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'DeleteOptedOutNumberRequest$OptedOutNumber' => '

The phone number, in E.164 format, to remove from the OptOutList.

', 'DeleteOptedOutNumberResult$OptedOutNumber' => '

The phone number that was removed from the OptOutList.

', 'DeleteVerifiedDestinationNumberResult$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'DestinationPhoneNumberList$member' => NULL, 'OptedOutNumberInformation$OptedOutNumber' => '

The phone number that is opted out.

', 'OptedOutNumberList$member' => NULL, 'OriginationIdentityMetadata$PhoneNumber' => '

The phone number in E.164 format.

', 'PhoneNumberInformation$PhoneNumber' => '

The phone number in E.164 format.

', 'PutOptedOutNumberRequest$OptedOutNumber' => '

The phone number to add to the OptOutList in E.164 format.

', 'PutOptedOutNumberResult$OptedOutNumber' => '

The phone number that was added to the OptOutList.

', 'RegistrationAssociationMetadata$PhoneNumber' => '

The phone number associated with the registration in E.164 format.

', 'ReleasePhoneNumberResult$PhoneNumber' => '

The phone number that was released.

', 'RequestPhoneNumberResult$PhoneNumber' => '

The new phone number that was requested.

', 'SendMediaMessageRequest$DestinationPhoneNumber' => '

The destination phone number in E.164 format.

', 'SendTextMessageRequest$DestinationPhoneNumber' => '

The destination phone number in E.164 format.

', 'SendVoiceMessageRequest$DestinationPhoneNumber' => '

The destination phone number in E.164 format.

', 'UpdatePhoneNumberResult$PhoneNumber' => '

The phone number that was updated.

', 'VerifiedDestinationNumberInformation$DestinationPhoneNumber' => '

The verified destination phone number, in E.164 format.

', 'VerifyDestinationNumberResult$DestinationPhoneNumber' => '

The phone number in E.164 format.

', ], ], 'PhoneNumberFilter' => [ 'base' => '

The information for a phone number that meets a specified criteria.

', 'refs' => [ 'PhoneNumberFilterList$member' => NULL, ], ], 'PhoneNumberFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribePhoneNumbersRequest$Filters' => '

An array of PhoneNumberFilter objects to filter the results.

', ], ], 'PhoneNumberFilterName' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'PhoneNumberIdList' => [ 'base' => NULL, 'refs' => [ 'DescribePhoneNumbersRequest$PhoneNumberIds' => '

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

', ], ], 'PhoneNumberIdOrArn' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberIdList$member' => NULL, 'ReleasePhoneNumberRequest$PhoneNumberId' => '

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

', 'UpdatePhoneNumberRequest$PhoneNumberId' => '

The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

', ], ], 'PhoneNumberInformation' => [ 'base' => '

The information for a phone number, in E.164 format, in an Amazon Web Services account.

', 'refs' => [ 'PhoneNumberInformationList$member' => NULL, ], ], 'PhoneNumberInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribePhoneNumbersResult$PhoneNumbers' => '

An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

', ], ], 'PhoneOrPoolIdOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteKeywordRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

', 'DescribeKeywordsRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', 'PutKeywordRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', ], ], 'PhoneOrSenderIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$OriginationIdentity' => '

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', 'CreatePoolRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

', 'DisassociateOriginationIdentityRequest$OriginationIdentity' => '

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.

', ], ], 'PoolFilter' => [ 'base' => '

The information for a pool that meets a specified criteria.

', 'refs' => [ 'PoolFilterList$member' => NULL, ], ], 'PoolFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribePoolsRequest$Filters' => '

An array of PoolFilter objects to filter the results.

', ], ], 'PoolFilterName' => [ 'base' => NULL, 'refs' => [ 'PoolFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'PoolIdList' => [ 'base' => NULL, 'refs' => [ 'DescribePoolsRequest$PoolIds' => '

The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

', ], ], 'PoolIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateOriginationIdentityRequest$PoolId' => '

The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.

', 'DeletePoolRequest$PoolId' => '

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

', 'DisassociateOriginationIdentityRequest$PoolId' => '

The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

', 'ListPoolOriginationIdentitiesRequest$PoolId' => '

The unique identifier for the pool. This value can be either the PoolId or PoolArn.

', 'PoolIdList$member' => NULL, 'RequestPhoneNumberRequest$PoolId' => '

The pool to associated with the phone number. You can use the PoolId or PoolArn.

', 'UpdatePoolRequest$PoolId' => '

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

', ], ], 'PoolInformation' => [ 'base' => '

The information for a pool in an Amazon Web Services account.

', 'refs' => [ 'PoolInformationList$member' => NULL, ], ], 'PoolInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribePoolsResult$Pools' => '

An array of PoolInformation objects that contain the details for the requested pools.

', ], ], 'PoolOriginationIdentitiesFilter' => [ 'base' => '

Information about origination identities associated with a pool that meets a specified criteria.

', 'refs' => [ 'PoolOriginationIdentitiesFilterList$member' => NULL, ], ], 'PoolOriginationIdentitiesFilterList' => [ 'base' => NULL, 'refs' => [ 'ListPoolOriginationIdentitiesRequest$Filters' => '

An array of PoolOriginationIdentitiesFilter objects to filter the results..

', ], ], 'PoolOriginationIdentitiesFilterName' => [ 'base' => NULL, 'refs' => [ 'PoolOriginationIdentitiesFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'PoolStatus' => [ 'base' => NULL, 'refs' => [ 'CreatePoolResult$Status' => '

The current status of the pool.

', 'DeletePoolResult$Status' => '

The current status of the pool.

', 'PoolInformation$Status' => '

The current status of the pool.

', 'UpdatePoolResult$Status' => '

The current status of the pool update request.

', ], ], 'PrimitiveBoolean' => [ 'base' => NULL, 'refs' => [ 'CreatePoolResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'CreatePoolResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'CreatePoolResult$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'CreatePoolResult$DeletionProtectionEnabled' => '

When set to true deletion protection is enabled. By default this is set to false.

', 'CreateProtectConfigurationResult$AccountDefault' => '

This is true if the protect configuration is set as your account default protect configuration.

', 'CreateProtectConfigurationResult$DeletionProtectionEnabled' => '

When set to true deletion protection is enabled. By default this is set to false.

', 'DeleteOptedOutNumberResult$EndUserOptedOut' => '

This is true if it was the end user who requested their phone number be removed.

', 'DeletePoolResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'DeletePoolResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'DeletePoolResult$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'DeleteProtectConfigurationResult$AccountDefault' => '

This is true if the protect configuration is set as your account default protect configuration.

', 'DeleteProtectConfigurationResult$DeletionProtectionEnabled' => '

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

', 'OptedOutNumberInformation$EndUserOptedOut' => '

This is set to true if it was the end recipient that opted out.

', 'PhoneNumberInformation$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

', 'PhoneNumberInformation$SelfManagedOptOutsEnabled' => '

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

', 'PhoneNumberInformation$DeletionProtectionEnabled' => '

When set to true the phone number can\'t be deleted.

', 'PoolInformation$TwoWayEnabled' => '

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

', 'PoolInformation$SelfManagedOptOutsEnabled' => '

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs

', 'PoolInformation$SharedRoutesEnabled' => '

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren\'t allowed to use shared routes and must use a dedicated phone number or short code.

', 'PoolInformation$DeletionProtectionEnabled' => '

When set to true the pool can\'t be deleted.

', 'ProtectConfigurationInformation$AccountDefault' => '

This is true if the protect configuration is set as your account default protect configuration.

', 'ProtectConfigurationInformation$DeletionProtectionEnabled' => '

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

', 'PutOptedOutNumberResult$EndUserOptedOut' => '

This is true if it was the end user who requested their phone number be removed.

', 'ReleasePhoneNumberResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'ReleasePhoneNumberResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'ReleaseSenderIdResult$Registered' => '

True if the sender ID is registered.

', 'RequestPhoneNumberResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'RequestPhoneNumberResult$SelfManagedOptOutsEnabled' => '

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'RequestPhoneNumberResult$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the phone number can\'t be deleted.

', 'RequestSenderIdResult$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'RequestSenderIdResult$Registered' => '

True if the sender ID is registered.

', 'SendMediaMessageRequest$DryRun' => '

When set to true, the message is checked and validated, but isn\'t sent to the end recipient.

', 'SendTextMessageRequest$DryRun' => '

When set to true, the message is checked and validated, but isn\'t sent to the end recipient.

', 'SendVoiceMessageRequest$DryRun' => '

When set to true, the message is checked and validated, but isn\'t sent to the end recipient.

', 'SenderIdInformation$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'SenderIdInformation$Registered' => '

True if the sender ID is registered.

', 'SpendLimit$Overridden' => '

When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

', 'UpdatePhoneNumberResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePhoneNumberResult$SelfManagedOptOutsEnabled' => '

This is true if self managed opt-out are enabled.

', 'UpdatePhoneNumberResult$DeletionProtectionEnabled' => '

When set to true the phone number can\'t be deleted.

', 'UpdatePoolResult$TwoWayEnabled' => '

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

', 'UpdatePoolResult$SelfManagedOptOutsEnabled' => '

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you\'re responsible for responding to HELP and STOP requests. You\'re also responsible for tracking and honoring opt-out requests.

', 'UpdatePoolResult$SharedRoutesEnabled' => '

Indicates whether shared routes are enabled for the pool.

', 'UpdatePoolResult$DeletionProtectionEnabled' => '

When set to true the pool can\'t be deleted.

', 'UpdateProtectConfigurationResult$AccountDefault' => '

This is true if the protect configuration is set as your account default protect configuration.

', 'UpdateProtectConfigurationResult$DeletionProtectionEnabled' => '

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

', 'UpdateSenderIdResult$DeletionProtectionEnabled' => '

By default this is set to false. When set to true the sender ID can\'t be deleted.

', 'UpdateSenderIdResult$Registered' => '

True if the sender ID is registered..

', ], ], 'PrimitiveLong' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$Used' => '

The current amount that has been spent, in US dollars.

', 'AccountLimit$Max' => '

The Amazon Web Services set limit for that resource type, in US dollars.

', 'SpendLimit$EnforcedLimit' => '

The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.

', 'SpendLimit$MaxLimit' => '

The maximum amount of money that you are able to spend to send messages each month, in US dollars.

', ], ], 'ProtectConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'AssociateProtectConfigurationResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'CreateProtectConfigurationResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'DeleteAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the account default protect configuration.

', 'DeleteProtectConfigurationResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'DisassociateProtectConfigurationResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'GetProtectConfigurationCountryRuleSetResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'ProtectConfigurationInformation$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'SetAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the account default protect configuration.

', 'UpdateProtectConfigurationCountryRuleSetResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', 'UpdateProtectConfigurationResult$ProtectConfigurationArn' => '

The Amazon Resource Name (ARN) of the protect configuration.

', ], ], 'ProtectConfigurationCountryRuleSet' => [ 'base' => NULL, 'refs' => [ 'GetProtectConfigurationCountryRuleSetResult$CountryRuleSet' => '

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

', 'UpdateProtectConfigurationCountryRuleSetRequest$CountryRuleSetUpdates' => '

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

', 'UpdateProtectConfigurationCountryRuleSetResult$CountryRuleSet' => '

An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.

', ], ], 'ProtectConfigurationCountryRuleSetInformation' => [ 'base' => '

The types of statuses that can be used.

', 'refs' => [ 'ProtectConfigurationCountryRuleSet$value' => NULL, ], ], 'ProtectConfigurationFilter' => [ 'base' => '

The filter definition for filtering protect configurations that meet a specified criteria.

', 'refs' => [ 'ProtectConfigurationFilterList$member' => NULL, ], ], 'ProtectConfigurationFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeProtectConfigurationsRequest$Filters' => '

An array of ProtectConfigurationFilter objects to filter the results.

', ], ], 'ProtectConfigurationFilterName' => [ 'base' => NULL, 'refs' => [ 'ProtectConfigurationFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'ProtectConfigurationId' => [ 'base' => NULL, 'refs' => [ 'AssociateProtectConfigurationResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'CreateProtectConfigurationResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'DeleteAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationId' => '

The unique identifier of the account default protect configuration.

', 'DeleteProtectConfigurationResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'DisassociateProtectConfigurationResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'GetProtectConfigurationCountryRuleSetResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'ProtectConfigurationInformation$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'SetAccountDefaultProtectConfigurationResult$DefaultProtectConfigurationId' => '

The unique identifier of the account default protect configuration.

', 'UpdateProtectConfigurationCountryRuleSetResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'UpdateProtectConfigurationResult$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', ], ], 'ProtectConfigurationIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeProtectConfigurationsRequest$ProtectConfigurationIds' => '

An array of protect configuration identifiers to search for.

', ], ], 'ProtectConfigurationIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateProtectConfigurationRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'ConfigurationSetInformation$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'DeleteProtectConfigurationRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'DisassociateProtectConfigurationRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'GetProtectConfigurationCountryRuleSetRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'ProtectConfigurationIdList$member' => NULL, 'SendMediaMessageRequest$ProtectConfigurationId' => '

The unique identifier of the protect configuration to use.

', 'SendTextMessageRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'SendVoiceMessageRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'SetAccountDefaultProtectConfigurationRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'UpdateProtectConfigurationCountryRuleSetRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', 'UpdateProtectConfigurationRequest$ProtectConfigurationId' => '

The unique identifier for the protect configuration.

', ], ], 'ProtectConfigurationInformation' => [ 'base' => '

Provides information on the specified protect configuration.

', 'refs' => [ 'ProtectConfigurationInformationList$member' => NULL, ], ], 'ProtectConfigurationInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeProtectConfigurationsResult$ProtectConfigurations' => '

An array of ProtectConfigurationInformation objects that contain the details for the request.

', ], ], 'ProtectStatus' => [ 'base' => NULL, 'refs' => [ 'ProtectConfigurationCountryRuleSetInformation$ProtectStatus' => '

The types of protection that can be used.

', ], ], 'PutKeywordRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutKeywordResult' => [ 'base' => NULL, 'refs' => [], ], 'PutOptedOutNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOptedOutNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'PutRegistrationFieldValueRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRegistrationFieldValueResult' => [ 'base' => NULL, 'refs' => [], ], 'RegistrationAssociationBehavior' => [ 'base' => NULL, 'refs' => [ 'SupportedAssociation$AssociationBehavior' => '

The association behavior.

', ], ], 'RegistrationAssociationFilter' => [ 'base' => '

The filter definition for filtering registrations that meets a specified criteria.

', 'refs' => [ 'RegistrationAssociationFilterList$member' => NULL, ], ], 'RegistrationAssociationFilterList' => [ 'base' => NULL, 'refs' => [ 'ListRegistrationAssociationsRequest$Filters' => '

An array of RegistrationAssociationFilter to apply to the results that are returned.

', ], ], 'RegistrationAssociationFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationAssociationFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationAssociationMetadata' => [ 'base' => '

Metadata for the origination identity that is associated with the registration.

', 'refs' => [ 'RegistrationAssociationMetadataList$member' => NULL, ], ], 'RegistrationAssociationMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListRegistrationAssociationsResult$RegistrationAssociations' => '

An array of RegistrationAssociationMetadata objects.

', ], ], 'RegistrationAttachmentFilter' => [ 'base' => '

The filter definition for filtering registration attachments that meets a specified criteria.

', 'refs' => [ 'RegistrationAttachmentFilterList$member' => NULL, ], ], 'RegistrationAttachmentFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationAttachmentsRequest$Filters' => '

An array of RegistrationAttachmentFilter objects to filter the results.

', ], ], 'RegistrationAttachmentFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationAttachmentFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationAttachmentIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationAttachmentsRequest$RegistrationAttachmentIds' => '

The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.

', ], ], 'RegistrationAttachmentIdOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationAttachmentRequest$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'PutRegistrationFieldValueRequest$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'RegistrationFieldValueInformation$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', ], ], 'RegistrationAttachmentsInformation' => [ 'base' => '

Provides information on the specified registration attachments.

', 'refs' => [ 'RegistrationAttachmentsInformationList$member' => NULL, ], ], 'RegistrationAttachmentsInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationAttachmentsResult$RegistrationAttachments' => '

An array of RegistrationAttachments objects that contain the details for the requested registration attachments.

', ], ], 'RegistrationDeniedReasonInformation' => [ 'base' => '

Provides the reason a registration was rejected.

', 'refs' => [ 'RegistrationDeniedReasonInformationList$member' => NULL, ], ], 'RegistrationDeniedReasonInformationList' => [ 'base' => NULL, 'refs' => [ 'RegistrationVersionInformation$DeniedReasons' => '

An array of RegistrationDeniedReasonInformation objects.

', ], ], 'RegistrationDisassociationBehavior' => [ 'base' => NULL, 'refs' => [ 'SupportedAssociation$DisassociationBehavior' => '

The disassociation behavior.

', ], ], 'RegistrationFieldDefinition' => [ 'base' => '

Provides a description of the specified field.

', 'refs' => [ 'RegistrationFieldDefinitionList$member' => NULL, ], ], 'RegistrationFieldDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldDefinitionsResult$RegistrationFieldDefinitions' => '

An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.

', ], ], 'RegistrationFieldDisplayHints' => [ 'base' => '

Provides help information on the registration field.

', 'refs' => [ 'RegistrationFieldDefinition$DisplayHints' => '

An array of RegistrationFieldDisplayHints objects for the field.

', ], ], 'RegistrationFieldValueInformation' => [ 'base' => '

Provides the values of the specified field.

', 'refs' => [ 'RegistrationFieldValueInformationList$member' => NULL, ], ], 'RegistrationFieldValueInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldValuesResult$RegistrationFieldValues' => '

An array of RegistrationFieldValues objects that contain the values for the requested registration.

', ], ], 'RegistrationFilter' => [ 'base' => '

The filter definition for filtering registrations that meets a specified criteria.

', 'refs' => [ 'RegistrationFilterList$member' => NULL, ], ], 'RegistrationFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationsRequest$Filters' => '

An array of RegistrationFilter objects to filter the results.

', ], ], 'RegistrationFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationsRequest$RegistrationIds' => '

An array of unique identifiers for each registration.

', ], ], 'RegistrationIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationRequest$RegistrationId' => '

The unique identifier for the registration.

', 'CreateRegistrationVersionRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteRegistrationFieldValueRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteRegistrationRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DescribeRegistrationFieldValuesRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DescribeRegistrationVersionsRequest$RegistrationId' => '

The unique identifier for the registration.

', 'DiscardRegistrationVersionRequest$RegistrationId' => '

The unique identifier for the registration.

', 'ListRegistrationAssociationsRequest$RegistrationId' => '

The unique identifier for the registration.

', 'PutRegistrationFieldValueRequest$RegistrationId' => '

The unique identifier for the registration.

', 'RegistrationAttachmentIdList$member' => NULL, 'RegistrationIdList$member' => NULL, 'RequestPhoneNumberRequest$RegistrationId' => '

Use this field to attach your phone number for an external registration process.

', 'SubmitRegistrationVersionRequest$RegistrationId' => '

The unique identifier for the registration.

', ], ], 'RegistrationInformation' => [ 'base' => '

Provides information about the requested registration.

', 'refs' => [ 'RegistrationInformationList$member' => NULL, ], ], 'RegistrationInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationsResult$Registrations' => '

An array of RegistrationInformation objects.

', ], ], 'RegistrationSectionDefinition' => [ 'base' => '

Provides information on the specified section definition.

', 'refs' => [ 'RegistrationSectionDefinitionList$member' => NULL, ], ], 'RegistrationSectionDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationSectionDefinitionsResult$RegistrationSectionDefinitions' => '

An array of RegistrationSectionDefinition objects.

', ], ], 'RegistrationSectionDisplayHints' => [ 'base' => '

Provides help information on the registration section.

', 'refs' => [ 'RegistrationSectionDefinition$DisplayHints' => '

The path to the section of the registration.

', ], ], 'RegistrationStatus' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationResult$RegistrationStatus' => '

The status of the registration.

', 'DeleteRegistrationResult$RegistrationStatus' => '

The status of the registration.

', 'RegistrationInformation$RegistrationStatus' => '

The status of the registration.

', ], ], 'RegistrationType' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'CreateRegistrationRequest$RegistrationType' => '

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'CreateRegistrationResult$RegistrationType' => '

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DeleteRegistrationResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationFieldDefinitionsRequest$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationFieldDefinitionsResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationSectionDefinitionsRequest$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'DescribeRegistrationSectionDefinitionsResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'ListRegistrationAssociationsResult$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'RegistrationInformation$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'RegistrationTypeDefinition$RegistrationType' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', 'RegistrationTypeList$member' => NULL, ], ], 'RegistrationTypeDefinition' => [ 'base' => '

Provides information on the supported registration type.

', 'refs' => [ 'RegistrationTypeDefinitionList$member' => NULL, ], ], 'RegistrationTypeDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationTypeDefinitionsResult$RegistrationTypeDefinitions' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', ], ], 'RegistrationTypeDisplayHints' => [ 'base' => '

Provides help information on the registration type.

', 'refs' => [ 'RegistrationTypeDefinition$DisplayHints' => '

Provides help information on the registration.

', ], ], 'RegistrationTypeFilter' => [ 'base' => '

The filter definition for filtering registration types that meets a specified criteria.

', 'refs' => [ 'RegistrationTypeFilterList$member' => NULL, ], ], 'RegistrationTypeFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationTypeDefinitionsRequest$Filters' => '

An array of RegistrationFilter objects to filter the results.

', ], ], 'RegistrationTypeFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationTypeFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationTypeDefinitionsRequest$RegistrationTypes' => '

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

', ], ], 'RegistrationVersionFilter' => [ 'base' => '

The filter definition for filtering registration versions that meets a specified criteria.

', 'refs' => [ 'RegistrationVersionFilterList$member' => NULL, ], ], 'RegistrationVersionFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationVersionsRequest$Filters' => '

An array of RegistrationVersionFilter objects to filter the results.

', ], ], 'RegistrationVersionFilterName' => [ 'base' => NULL, 'refs' => [ 'RegistrationVersionFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'RegistrationVersionInformation' => [ 'base' => '

Provides information about the specified version of the registration.

', 'refs' => [ 'RegistrationVersionInformationList$member' => NULL, ], ], 'RegistrationVersionInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationVersionsResult$RegistrationVersions' => '

An array of RegistrationVersions objects.

', ], ], 'RegistrationVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationResult$CurrentVersionNumber' => '

The current version number of the registration.

', 'CreateRegistrationVersionResult$VersionNumber' => '

The new version number of the registration.

', 'DeleteRegistrationFieldValueResult$VersionNumber' => '

The version number of the registration.

', 'DeleteRegistrationResult$CurrentVersionNumber' => '

The current version number of the registration.

', 'DeleteRegistrationResult$ApprovedVersionNumber' => '

The version number of the registration that was approved.

', 'DeleteRegistrationResult$LatestDeniedVersionNumber' => '

The latest version number of the registration that was denied.

', 'DescribeRegistrationFieldValuesRequest$VersionNumber' => '

The version number of the registration.

', 'DescribeRegistrationFieldValuesResult$VersionNumber' => '

The current version of the registration.

', 'DiscardRegistrationVersionResult$VersionNumber' => '

The version number of the registration.

', 'PutRegistrationFieldValueResult$VersionNumber' => '

The version number of the registration.

', 'RegistrationInformation$CurrentVersionNumber' => '

The current version number of the registration.

', 'RegistrationInformation$ApprovedVersionNumber' => '

The version number of the registration that was approved.

', 'RegistrationInformation$LatestDeniedVersionNumber' => '

The latest version number of the registration that was denied.

', 'RegistrationVersionInformation$VersionNumber' => '

The version number of the registration.

', 'RegistrationVersionNumberList$member' => NULL, 'SubmitRegistrationVersionResult$VersionNumber' => '

The version number of the registration.

', ], ], 'RegistrationVersionNumberList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationVersionsRequest$VersionNumbers' => '

An array of registration version numbers.

', ], ], 'RegistrationVersionStatus' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationVersionResult$RegistrationVersionStatus' => '

The status of the registration.

', 'DiscardRegistrationVersionResult$RegistrationVersionStatus' => '

The status of the registration version.

', 'RegistrationVersionInformation$RegistrationVersionStatus' => '

The status of the registration.

', 'SubmitRegistrationVersionResult$RegistrationVersionStatus' => '

The status of the registration version.

', ], ], 'RegistrationVersionStatusHistory' => [ 'base' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', 'refs' => [ 'CreateRegistrationVersionResult$RegistrationVersionStatusHistory' => '

A RegistrationVersionStatusHistory object that contains timestamps for the registration.

', 'DiscardRegistrationVersionResult$RegistrationVersionStatusHistory' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', 'RegistrationVersionInformation$RegistrationVersionStatusHistory' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', 'SubmitRegistrationVersionResult$RegistrationVersionStatusHistory' => '

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

', ], ], 'ReleasePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleasePhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestPhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestableNumberType' => [ 'base' => NULL, 'refs' => [ 'RequestPhoneNumberRequest$NumberType' => '

The type of phone number to request.

', 'RequestPhoneNumberResult$NumberType' => '

The type of number that was released.

', ], ], 'ResourceIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationAssociationRequest$ResourceId' => '

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

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

A requested resource couldn\'t be found.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$ResourceType' => '

The type of resource that caused the exception.

', 'ResourceNotFoundException$ResourceType' => '

The type of resource that caused the exception.

', ], ], 'SectionPath' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationFieldDefinitionsRequest$SectionPath' => '

The path to the section of the registration.

', 'DescribeRegistrationFieldValuesRequest$SectionPath' => '

The path to the section of the registration.

', 'RegistrationFieldDefinition$SectionPath' => '

The section path of the field.

', 'RegistrationSectionDefinition$SectionPath' => '

The path to the section of the registration.

', 'SectionPathList$member' => NULL, ], ], 'SectionPathList' => [ 'base' => NULL, 'refs' => [ 'DescribeRegistrationSectionDefinitionsRequest$SectionPaths' => '

An array of paths for the registration form section.

', ], ], 'SelectChoice' => [ 'base' => NULL, 'refs' => [ 'SelectChoiceList$member' => NULL, ], ], 'SelectChoiceList' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationFieldValueResult$SelectChoices' => '

An array of values for the form field.

', 'PutRegistrationFieldValueRequest$SelectChoices' => '

An array of values for the form field.

', 'PutRegistrationFieldValueResult$SelectChoices' => '

An array of values for the form field.

', 'RegistrationFieldValueInformation$SelectChoices' => '

An array of values for the form field.

', ], ], 'SelectOptionDescription' => [ 'base' => '

A description of each select option.

', 'refs' => [ 'SelectOptionDescriptionsList$member' => NULL, ], ], 'SelectOptionDescriptionsList' => [ 'base' => NULL, 'refs' => [ 'RegistrationFieldDisplayHints$SelectOptionDescriptions' => '

An array of SelectOptionDescription objects.

', ], ], 'SelectValidation' => [ 'base' => '

Validation rules for a select field.

', 'refs' => [ 'RegistrationFieldDefinition$SelectValidation' => '

The validation rules for a select field.

', ], ], 'SendDestinationNumberVerificationCodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendDestinationNumberVerificationCodeResult' => [ 'base' => NULL, 'refs' => [], ], 'SendMediaMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendMediaMessageResult' => [ 'base' => NULL, 'refs' => [], ], 'SendTextMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendTextMessageResult' => [ 'base' => NULL, 'refs' => [], ], 'SendVoiceMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendVoiceMessageResult' => [ 'base' => NULL, 'refs' => [], ], 'SenderId' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$DefaultSenderId' => '

The default sender ID used by the ConfigurationSet.

', 'DeleteConfigurationSetResult$DefaultSenderId' => '

The default Sender ID of the configuration set that was deleted.

', 'DeleteDefaultSenderIdResult$SenderId' => '

The current sender ID for the configuration set.

', 'ReleaseSenderIdResult$SenderId' => '

The sender ID that was released.

', 'RequestSenderIdRequest$SenderId' => '

The sender ID string to request.

', 'RequestSenderIdResult$SenderId' => '

The sender ID that was requested.

', 'SenderIdInformation$SenderId' => '

The alphanumeric sender ID in a specific country that you\'d like to describe.

', 'SetDefaultSenderIdRequest$SenderId' => '

The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as \'NOTICE\'.

', 'SetDefaultSenderIdResult$SenderId' => '

The default sender ID to set for the ConfigurationSet.

', 'UpdateSenderIdResult$SenderId' => '

The sender ID that was updated.

', ], ], 'SenderIdAndCountry' => [ 'base' => '

The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.

', 'refs' => [ 'SenderIdList$member' => NULL, ], ], 'SenderIdFilter' => [ 'base' => '

The information for a sender ID that meets a specified criteria.

', 'refs' => [ 'SenderIdFilterList$member' => NULL, ], ], 'SenderIdFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeSenderIdsRequest$Filters' => '

An array of SenderIdFilter objects to filter the results.

', ], ], 'SenderIdFilterName' => [ 'base' => NULL, 'refs' => [ 'SenderIdFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'SenderIdInformation' => [ 'base' => '

The information for all SenderIds in an Amazon Web Services account.

', 'refs' => [ 'SenderIdInformationList$member' => NULL, ], ], 'SenderIdInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeSenderIdsResult$SenderIds' => '

An array of SernderIdInformation objects that contain the details for the requested SenderIds.

', ], ], 'SenderIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeSenderIdsRequest$SenderIds' => '

An array of SenderIdAndCountry objects to search for.

', ], ], 'SenderIdOrArn' => [ 'base' => NULL, 'refs' => [ 'ReleaseSenderIdRequest$SenderId' => '

The sender ID to release.

', 'SenderIdAndCountry$SenderId' => '

The unique identifier of the sender.

', 'UpdateSenderIdRequest$SenderId' => '

The sender ID to update.

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

The request would cause a service quota to be exceeded.

', 'refs' => [], ], 'ServiceQuotaExceededExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ServiceQuotaExceededException$Reason' => '

The reason for the exception.

', ], ], 'SetAccountDefaultProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetAccountDefaultProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultMessageTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultMessageTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetDefaultSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'SetMediaMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetMediaMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'SetTextMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetTextMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'SetVoiceMessageSpendLimitOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetVoiceMessageSpendLimitOverrideResult' => [ 'base' => NULL, 'refs' => [], ], 'SnsDestination' => [ 'base' => '

An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.

', 'refs' => [ 'CreateEventDestinationRequest$SnsDestination' => '

An object that contains information about an event destination for logging to Amazon SNS.

', 'EventDestination$SnsDestination' => '

An object that contains information about an event destination that sends logging events to Amazon SNS.

', 'UpdateEventDestinationRequest$SnsDestination' => '

An object that contains information about an event destination that sends data to Amazon SNS.

', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'SnsDestination$TopicArn' => '

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

', ], ], 'SpendLimit' => [ 'base' => '

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

', 'refs' => [ 'SpendLimitList$member' => NULL, ], ], 'SpendLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeSpendLimitsResult$SpendLimits' => '

An array of SpendLimit objects that contain the details for the requested spend limits.

', ], ], 'SpendLimitName' => [ 'base' => NULL, 'refs' => [ 'SpendLimit$Name' => '

The name for the SpendLimit.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AccountAttribute$Value' => '

The value associated with the account attribute name.

', 'AssociateOriginationIdentityResult$PoolArn' => '

The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.

', 'AssociateOriginationIdentityResult$PoolId' => '

The PoolId of the pool that is now associated with the origination identity.

', 'AssociateOriginationIdentityResult$OriginationIdentityArn' => '

The PhoneNumberArn or SenderIdArn of the origination identity.

', 'AssociateOriginationIdentityResult$OriginationIdentity' => '

The PhoneNumberId or SenderId of the origination identity.

', 'AssociateProtectConfigurationResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'ConfigurationSetInformation$ConfigurationSetArn' => '

The Resource Name (ARN) of the ConfigurationSet.

', 'ConflictException$Message' => NULL, 'ConflictException$ResourceId' => '

The unique identifier of the request.

', 'CreateConfigurationSetResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the newly created configuration set.

', 'CreateEventDestinationResult$ConfigurationSetArn' => '

The ARN of the configuration set.

', 'CreateOptOutListResult$OptOutListArn' => '

The Amazon Resource Name (ARN) for the OptOutList.

', 'CreatePoolResult$PoolArn' => '

The Amazon Resource Name (ARN) for the pool.

', 'CreatePoolResult$PoolId' => '

The unique identifier for the pool.

', 'CreateRegistrationAssociationResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'CreateRegistrationAssociationResult$RegistrationId' => '

The unique identifier for the registration.

', 'CreateRegistrationAssociationResult$ResourceArn' => '

The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

', 'CreateRegistrationAssociationResult$ResourceId' => '

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

', 'CreateRegistrationAssociationResult$ResourceType' => '

The registration type or origination identity type.

', 'CreateRegistrationAttachmentResult$RegistrationAttachmentArn' => '

The Amazon Resource Name (ARN) for the registration attachment.

', 'CreateRegistrationAttachmentResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'CreateRegistrationResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'CreateRegistrationResult$RegistrationId' => '

The unique identifier for the registration.

', 'CreateRegistrationVersionResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'CreateRegistrationVersionResult$RegistrationId' => '

The unique identifier for the registration.

', 'CreateVerifiedDestinationNumberResult$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'CreateVerifiedDestinationNumberResult$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'DeleteConfigurationSetResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the deleted configuration set.

', 'DeleteDefaultMessageTypeResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DeleteDefaultSenderIdResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DeleteEventDestinationResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DeleteKeywordResult$OriginationIdentityArn' => '

The PhoneNumberArn or PoolArn that the keyword was associated with.

', 'DeleteKeywordResult$OriginationIdentity' => '

The PhoneNumberId or PoolId that the keyword was associated with.

', 'DeleteOptOutListResult$OptOutListArn' => '

The Amazon Resource Name (ARN) of the OptOutList that was removed.

', 'DeleteOptedOutNumberResult$OptOutListArn' => '

The OptOutListArn that the phone number was removed from.

', 'DeletePoolResult$PoolArn' => '

The Amazon Resource Name (ARN) of the pool that was deleted.

', 'DeletePoolResult$PoolId' => '

The PoolId of the pool that was deleted.

', 'DeleteRegistrationAttachmentResult$RegistrationAttachmentArn' => '

The Amazon Resource Name (ARN) for the registration attachment.

', 'DeleteRegistrationAttachmentResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'DeleteRegistrationFieldValueResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DeleteRegistrationFieldValueResult$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteRegistrationFieldValueResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'DeleteRegistrationResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DeleteRegistrationResult$RegistrationId' => '

The unique identifier for the registration.

', 'DeleteVerifiedDestinationNumberResult$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'DeleteVerifiedDestinationNumberResult$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'DescribeKeywordsResult$OriginationIdentityArn' => '

The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

', 'DescribeKeywordsResult$OriginationIdentity' => '

The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

', 'DescribeOptedOutNumbersResult$OptOutListArn' => '

The Amazon Resource Name (ARN) of the OptOutList.

', 'DescribeRegistrationFieldValuesResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DescribeRegistrationFieldValuesResult$RegistrationId' => '

The unique identifier for the registration.

', 'DescribeRegistrationVersionsResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DescribeRegistrationVersionsResult$RegistrationId' => '

The unique identifier for the registration.

', 'DisassociateOriginationIdentityResult$PoolArn' => '

The Amazon Resource Name (ARN) of the pool.

', 'DisassociateOriginationIdentityResult$PoolId' => '

The PoolId of the pool no longer associated with the origination identity.

', 'DisassociateOriginationIdentityResult$OriginationIdentityArn' => '

The PhoneNumberArn or SenderIdArn of the origination identity.

', 'DisassociateOriginationIdentityResult$OriginationIdentity' => '

The PhoneNumberId or SenderId of the origination identity.

', 'DisassociateProtectConfigurationResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the configuration set.

', 'DiscardRegistrationVersionResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'DiscardRegistrationVersionResult$RegistrationId' => '

The unique identifier for the registration.

', 'InternalServerException$Message' => NULL, 'InternalServerException$RequestId' => '

The unique identifier of the request.

', 'ListPoolOriginationIdentitiesResult$PoolArn' => '

The Amazon Resource Name (ARN) for the pool.

', 'ListPoolOriginationIdentitiesResult$PoolId' => '

The unique PoolId of the pool.

', 'ListRegistrationAssociationsResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'ListRegistrationAssociationsResult$RegistrationId' => '

The unique identifier for the registration.

', 'OptOutListInformation$OptOutListArn' => '

The Amazon Resource Name (ARN) of the OptOutList.

', 'OriginationIdentityMetadata$OriginationIdentityArn' => '

The Amazon Resource Name (ARN) associated with the origination identity.

', 'OriginationIdentityMetadata$OriginationIdentity' => '

The unique identifier of the origination identity.

', 'PhoneNumberInformation$PhoneNumberArn' => '

The Amazon Resource Name (ARN) associated with the phone number.

', 'PhoneNumberInformation$PhoneNumberId' => '

The unique identifier for the phone number.

', 'PhoneNumberInformation$MonthlyLeasingPrice' => '

The price, in US dollars, to lease the phone number.

', 'PhoneNumberInformation$PoolId' => '

The unique identifier of the pool associated with the phone number.

', 'PhoneNumberInformation$RegistrationId' => '

The unique identifier for the registration.

', 'PoolInformation$PoolArn' => '

The Amazon Resource Name (ARN) for the pool.

', 'PoolInformation$PoolId' => '

The unique identifier for the pool.

', 'PutKeywordResult$OriginationIdentityArn' => '

The PhoneNumberArn or PoolArn that the keyword was associated with.

', 'PutKeywordResult$OriginationIdentity' => '

The PhoneNumberId or PoolId that the keyword was associated with.

', 'PutOptedOutNumberResult$OptOutListArn' => '

The OptOutListArn that the phone number was removed from.

', 'PutRegistrationFieldValueResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'PutRegistrationFieldValueResult$RegistrationId' => '

The unique identifier for the registration.

', 'PutRegistrationFieldValueResult$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'RegistrationAssociationMetadata$ResourceArn' => '

The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

', 'RegistrationAssociationMetadata$ResourceId' => '

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

', 'RegistrationAssociationMetadata$ResourceType' => '

The origination identity type.

', 'RegistrationAttachmentsInformation$RegistrationAttachmentArn' => '

The Amazon Resource Name (ARN) for the registration attachment.

', 'RegistrationAttachmentsInformation$RegistrationAttachmentId' => '

The unique identifier for the registration attachment.

', 'RegistrationDeniedReasonInformation$Reason' => '

The reason a registration was rejected.

', 'RegistrationDeniedReasonInformation$ShortDescription' => '

A short description of the rejection reason.

', 'RegistrationDeniedReasonInformation$LongDescription' => '

A long description of the rejection reason.

', 'RegistrationDeniedReasonInformation$DocumentationTitle' => '

The title of the document.

', 'RegistrationDeniedReasonInformation$DocumentationLink' => '

The link to the document.

', 'RegistrationFieldDisplayHints$Title' => '

The title of the display hint.

', 'RegistrationFieldDisplayHints$ShortDescription' => '

A short description of the display hint.

', 'RegistrationFieldDisplayHints$LongDescription' => '

A full description of the display hint.

', 'RegistrationFieldDisplayHints$DocumentationTitle' => '

The title of the document the display hint is associated with.

', 'RegistrationFieldDisplayHints$DocumentationLink' => '

The link to the document the display hint is associated with.

', 'RegistrationFieldDisplayHints$TextValidationDescription' => '

The validation rules for the text field.

', 'RegistrationFieldDisplayHints$ExampleTextValue' => '

Example text of what the value of a field should contain.

', 'RegistrationFieldValueInformation$DeniedReason' => '

A description of why the registration was denied.

', 'RegistrationInformation$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'RegistrationInformation$RegistrationId' => '

The unique identifier for the registration.

', 'RegistrationSectionDisplayHints$Title' => '

The title of the display hint.

', 'RegistrationSectionDisplayHints$ShortDescription' => '

A short description of the display hint.

', 'RegistrationSectionDisplayHints$LongDescription' => '

A full description of the display hint.

', 'RegistrationSectionDisplayHints$DocumentationTitle' => '

The title of the document the display hint is associated with.

', 'RegistrationSectionDisplayHints$DocumentationLink' => '

The link to the document the display hint is associated with.

', 'RegistrationTypeDisplayHints$Title' => '

The title of the display hint.

', 'RegistrationTypeDisplayHints$ShortDescription' => '

A short description of the display hint.

', 'RegistrationTypeDisplayHints$LongDescription' => '

A full description of the display hint.

', 'RegistrationTypeDisplayHints$DocumentationTitle' => '

The title of the document the display hint is associated with.

', 'RegistrationTypeDisplayHints$DocumentationLink' => '

The link to the document the display hint is associated with.

', 'ReleasePhoneNumberResult$PhoneNumberArn' => '

The PhoneNumberArn of the phone number that was released.

', 'ReleasePhoneNumberResult$PhoneNumberId' => '

The PhoneNumberId of the phone number that was released.

', 'ReleasePhoneNumberResult$MonthlyLeasingPrice' => '

The monthly price of the phone number, in US dollars.

', 'ReleasePhoneNumberResult$RegistrationId' => '

The unique identifier for the registration.

', 'ReleaseSenderIdResult$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'ReleaseSenderIdResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the sender ID.

', 'ReleaseSenderIdResult$RegistrationId' => '

The unique identifier for the registration.

', 'RequestPhoneNumberResult$PhoneNumberArn' => '

The Amazon Resource Name (ARN) of the requested phone number.

', 'RequestPhoneNumberResult$PhoneNumberId' => '

The unique identifier of the new phone number.

', 'RequestPhoneNumberResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the phone number.

', 'RequestPhoneNumberResult$PoolId' => '

The unique identifier of the pool associated with the phone number

', 'RequestPhoneNumberResult$RegistrationId' => '

The unique identifier for the registration.

', 'RequestSenderIdResult$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'RequestSenderIdResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the sender ID.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$ResourceId' => '

The unique identifier of the resource.

', 'SelectOptionDescription$Option' => '

The value of the option.

', 'SelectOptionDescription$Title' => '

The title of the select option.

', 'SelectOptionDescription$Description' => '

A description of the option meaning.

', 'SendDestinationNumberVerificationCodeResult$MessageId' => '

The unique identifier for the message.

', 'SendMediaMessageResult$MessageId' => '

The unique identifier for the message.

', 'SendTextMessageResult$MessageId' => '

The unique identifier for the message.

', 'SendVoiceMessageResult$MessageId' => '

The unique identifier for the message.

', 'SenderIdInformation$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'SenderIdInformation$MonthlyLeasingPrice' => '

The monthly leasing price, in US dollars.

', 'SenderIdInformation$RegistrationId' => '

The unique identifier for the registration.

', 'ServiceQuotaExceededException$Message' => NULL, 'SetDefaultMessageTypeResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the updated configuration set.

', 'SetDefaultSenderIdResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) of the updated configuration set.

', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitRegistrationVersionResult$RegistrationArn' => '

The Amazon Resource Name (ARN) for the registration.

', 'SubmitRegistrationVersionResult$RegistrationId' => '

The unique identifier for the registration.

', 'SupportedAssociation$ResourceType' => '

Defines the behavior of when an origination identity and registration can be associated with each other.

', 'TextValidation$Pattern' => '

The regular expression used to validate the text field.

', 'ThrottlingException$Message' => NULL, 'UpdateEventDestinationResult$ConfigurationSetArn' => '

The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.

', 'UpdatePhoneNumberResult$PhoneNumberArn' => '

The Amazon Resource Name (ARN) of the updated phone number.

', 'UpdatePhoneNumberResult$PhoneNumberId' => '

The unique identifier of the phone number.

', 'UpdatePhoneNumberResult$MonthlyLeasingPrice' => '

The monthly leasing price of the phone number, in US dollars.

', 'UpdatePhoneNumberResult$RegistrationId' => '

The unique identifier for the registration.

', 'UpdatePoolResult$PoolArn' => '

The ARN of the pool.

', 'UpdatePoolResult$PoolId' => '

The unique identifier of the pool.

', 'UpdateSenderIdResult$SenderIdArn' => '

The Amazon Resource Name (ARN) associated with the SenderId.

', 'UpdateSenderIdResult$MonthlyLeasingPrice' => '

The monthly price, in US dollars, to lease the sender ID.

', 'UpdateSenderIdResult$RegistrationId' => '

The unique identifier for the registration.

', 'ValidationException$Message' => NULL, 'ValidationExceptionField$Name' => '

The name of the field.

', 'ValidationExceptionField$Message' => '

The message associated with the validation exception with information to help determine its cause.

', 'VerifiedDestinationNumberInformation$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'VerifiedDestinationNumberInformation$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'VerifyDestinationNumberResult$VerifiedDestinationNumberArn' => '

The Amazon Resource Name (ARN) for the verified destination phone number.

', 'VerifyDestinationNumberResult$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'SelectValidation$Options' => '

An array of strings for the possible selection options.

', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'CreateRegistrationResult$AdditionalAttributes' => '

Metadata about a given registration which is specific to that registration type.

', 'DeleteRegistrationResult$AdditionalAttributes' => '

Metadata about a given registration which is specific to that registration type.

', 'RegistrationInformation$AdditionalAttributes' => '

Metadata about a given registration which is specific to that registration type.

', ], ], 'SubmitRegistrationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitRegistrationVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'SupportedAssociation' => [ 'base' => '

The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.

', 'refs' => [ 'SupportedAssociationList$member' => NULL, ], ], 'SupportedAssociationList' => [ 'base' => NULL, 'refs' => [ 'RegistrationTypeDefinition$SupportedAssociations' => '

The supported association behavior for the registration type.

', ], ], 'Tag' => [ 'base' => '

The list of tags to be added to the specified topic.

', 'refs' => [ 'NonEmptyTagList$member' => NULL, 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The key identifier, or name, of the tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

An array of tag key values to unassociate with the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateConfigurationSetRequest$Tags' => '

An array of key and value pair tags that\'s associated with the new configuration set.

', 'CreateConfigurationSetResult$Tags' => '

An array of key and value pair tags that\'s associated with the configuration set.

', 'CreateOptOutListRequest$Tags' => '

An array of tags (key and value pairs) to associate with the new OptOutList.

', 'CreateOptOutListResult$Tags' => '

An array of tags (key and value pairs) associated with the new OptOutList.

', 'CreatePoolRequest$Tags' => '

An array of tags (key and value pairs) associated with the pool.

', 'CreatePoolResult$Tags' => '

An array of tags (key and value pairs) associated with the pool.

', 'CreateProtectConfigurationRequest$Tags' => '

An array of key and value pair tags that are associated with the resource.

', 'CreateProtectConfigurationResult$Tags' => '

An array of key and value pair tags that are associated with the resource.

', 'CreateRegistrationAttachmentRequest$Tags' => '

An array of tags (key and value pairs) to associate with the registration attachment.

', 'CreateRegistrationAttachmentResult$Tags' => '

An array of tags (key and value pairs) to associate with the registration attachment.

', 'CreateRegistrationRequest$Tags' => '

An array of tags (key and value pairs) to associate with the registration.

', 'CreateRegistrationResult$Tags' => '

An array of tags (key and value pairs) to associate with the registration.

', 'CreateVerifiedDestinationNumberRequest$Tags' => '

An array of tags (key and value pairs) to associate with the destination number.

', 'CreateVerifiedDestinationNumberResult$Tags' => '

An array of tags (key and value pairs) to associate with the destination number.

', 'ListTagsForResourceResult$Tags' => '

An array of key and value pair tags that are associated with the resource.

', 'RequestPhoneNumberRequest$Tags' => '

An array of tags (key and value pairs) associate with the requested phone number.

', 'RequestPhoneNumberResult$Tags' => '

An array of key and value pair tags that are associated with the phone number.

', 'RequestSenderIdRequest$Tags' => '

An array of tags (key and value pairs) to associate with the sender ID.

', 'RequestSenderIdResult$Tags' => '

An array of tags (key and value pairs) to associate with the sender ID.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The string value associated with the key of the tag.

', ], ], 'TextMessageBody' => [ 'base' => NULL, 'refs' => [ 'SendMediaMessageRequest$MessageBody' => '

The text body of the message.

', 'SendTextMessageRequest$MessageBody' => '

The body of the text message.

', ], ], 'TextMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendTextMessageRequest$OriginationIdentity' => '

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

', ], ], 'TextValidation' => [ 'base' => '

Validation rules for a text field.

', 'refs' => [ 'RegistrationFieldDefinition$TextValidation' => '

The validation rules for a text field.

', ], ], 'TextValue' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistrationFieldValueResult$TextValue' => '

The text data for a free form field.

', 'PutRegistrationFieldValueRequest$TextValue' => '

The text data for a free form field.

', 'PutRegistrationFieldValueResult$TextValue' => '

The text data for a free form field.

', 'RegistrationFieldValueInformation$TextValue' => '

The text data for a free form field.

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

An error that occurred because too many requests were sent during a certain amount of time.

', 'refs' => [], ], 'TimeToLive' => [ 'base' => NULL, 'refs' => [ 'SendMediaMessageRequest$TimeToLive' => '

How long the text message is valid for. By default this is 72 hours.

', 'SendTextMessageRequest$TimeToLive' => '

How long the text message is valid for. By default this is 72 hours.

', 'SendVoiceMessageRequest$TimeToLive' => '

How long the voice message is valid for. By default this is 72 hours.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ConfigurationSetInformation$CreatedTimestamp' => '

The time when the ConfigurationSet was created, in UNIX epoch time format.

', 'CreateConfigurationSetResult$CreatedTimestamp' => '

The time when the configuration set was created, in UNIX epoch time format.

', 'CreateOptOutListResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'CreatePoolResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'CreateProtectConfigurationResult$CreatedTimestamp' => '

The time when the protect configuration was created, in UNIX epoch time format.

', 'CreateRegistrationAttachmentResult$CreatedTimestamp' => '

The time when the registration attachment was created, in UNIX epoch time format.

', 'CreateRegistrationResult$CreatedTimestamp' => '

The time when the registration was created, in UNIX epoch time format.

', 'CreateVerifiedDestinationNumberResult$CreatedTimestamp' => '

The time when the verified phone number was created, in UNIX epoch time format.

', 'DeleteConfigurationSetResult$CreatedTimestamp' => '

The time that the deleted configuration set was created in UNIX epoch time format.

', 'DeleteOptOutListResult$CreatedTimestamp' => '

The time when the OptOutList was created, in UNIX epoch time format.

', 'DeleteOptedOutNumberResult$OptedOutTimestamp' => '

The time that the number was removed at, in UNIX epoch time format.

', 'DeletePoolResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'DeleteProtectConfigurationResult$CreatedTimestamp' => '

The time when the protect configuration was created, in UNIX epoch time format.

', 'DeleteRegistrationAttachmentResult$CreatedTimestamp' => '

The time when the registration attachment was created, in UNIX epoch time format.

', 'DeleteRegistrationResult$CreatedTimestamp' => '

The time when the registration was created, in UNIX epoch time format.

', 'DeleteVerifiedDestinationNumberResult$CreatedTimestamp' => '

The time when the destination phone number was created, in UNIX epoch time format.

', 'OptOutListInformation$CreatedTimestamp' => '

The time when the OutOutList was created, in UNIX epoch time format.

', 'OptedOutNumberInformation$OptedOutTimestamp' => '

The time that the op tout occurred, in UNIX epoch time format.

', 'PhoneNumberInformation$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'PoolInformation$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'ProtectConfigurationInformation$CreatedTimestamp' => '

The time when the protect configuration was created, in UNIX epoch time format.

', 'PutOptedOutNumberResult$OptedOutTimestamp' => '

The time that the phone number was added to the OptOutList, in UNIX epoch time format.

', 'RegistrationAttachmentsInformation$CreatedTimestamp' => '

The time when the registration attachment was created, in UNIX epoch time format.

', 'RegistrationInformation$CreatedTimestamp' => '

The time when the registration was created, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$DraftTimestamp' => '

The time when the registration was in the draft state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$SubmittedTimestamp' => '

The time when the registration was in the submitted state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$ReviewingTimestamp' => '

The time when the registration was in the reviewing state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$ApprovedTimestamp' => '

The time when the registration was in the approved state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$DiscardedTimestamp' => '

The time when the registration was in the discarded state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$DeniedTimestamp' => '

The time when the registration was in the denied state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$RevokedTimestamp' => '

The time when the registration was in the revoked state, in UNIX epoch time format.

', 'RegistrationVersionStatusHistory$ArchivedTimestamp' => '

The time when the registration was in the archived state, in UNIX epoch time format.

', 'ReleasePhoneNumberResult$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'RequestPhoneNumberResult$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'UpdatePhoneNumberResult$CreatedTimestamp' => '

The time when the phone number was created, in UNIX epoch time format.

', 'UpdatePoolResult$CreatedTimestamp' => '

The time when the pool was created, in UNIX epoch time format.

', 'UpdateProtectConfigurationResult$CreatedTimestamp' => '

The time when the protect configuration was created, in UNIX epoch time format.

', 'VerifiedDestinationNumberInformation$CreatedTimestamp' => '

The time when the destination phone number was created, in UNIX epoch time format.

', 'VerifyDestinationNumberResult$CreatedTimestamp' => '

The time when the destination phone number was created, in UNIX epoch time format.

', ], ], 'TwoWayChannelArn' => [ 'base' => NULL, 'refs' => [ 'CreatePoolResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'DeletePoolResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the TwoWayChannel.

', 'PhoneNumberInformation$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'PoolInformation$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'ReleasePhoneNumberResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the TwoWayChannel.

', 'RequestPhoneNumberResult$TwoWayChannelArn' => '

The ARN used to identify the two way channel.

', 'UpdatePhoneNumberRequest$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'UpdatePhoneNumberResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'UpdatePoolRequest$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', 'UpdatePoolResult$TwoWayChannelArn' => '

The Amazon Resource Name (ARN) of the two way channel.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventDestinationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePoolResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProtectConfigurationCountryRuleSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProtectConfigurationCountryRuleSetResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProtectConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProtectConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSenderIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSenderIdResult' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

A validation exception for a field.

', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '

The field associated with the validation exception.

', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Fields' => '

The field that failed validation.

', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Reason' => '

The reason for the exception.

', ], ], 'VerificationChannel' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$VerificationChannel' => '

Choose to send the verification code as an SMS or voice message.

', ], ], 'VerificationCode' => [ 'base' => NULL, 'refs' => [ 'VerifyDestinationNumberRequest$VerificationCode' => '

The verification code that was received by the verified destination phone number.

', ], ], 'VerificationMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendDestinationNumberVerificationCodeRequest$OriginationIdentity' => '

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

', ], ], 'VerificationStatus' => [ 'base' => NULL, 'refs' => [ 'CreateVerifiedDestinationNumberResult$Status' => '

The status of the verified destination phone number.

', 'VerifiedDestinationNumberInformation$Status' => '

The status of the verified destination phone number.

', 'VerifyDestinationNumberResult$Status' => '

The status for being able to send messages to the phone number.

', ], ], 'VerifiedDestinationNumberFilter' => [ 'base' => '

The filter definition for filtering verified destination phone numbers that meets a specified criteria.

', 'refs' => [ 'VerifiedDestinationNumberFilterList$member' => NULL, ], ], 'VerifiedDestinationNumberFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersRequest$Filters' => '

An array of VerifiedDestinationNumberFilter objects to filter the results.

', ], ], 'VerifiedDestinationNumberFilterName' => [ 'base' => NULL, 'refs' => [ 'VerifiedDestinationNumberFilter$Name' => '

The name of the attribute to filter on.

', ], ], 'VerifiedDestinationNumberIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersRequest$VerifiedDestinationNumberIds' => '

An array of VerifiedDestinationNumberid to retreive.

', ], ], 'VerifiedDestinationNumberIdOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteVerifiedDestinationNumberRequest$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'SendDestinationNumberVerificationCodeRequest$VerifiedDestinationNumberId' => '

The unique identifier for the verified destination phone number.

', 'VerifiedDestinationNumberIdList$member' => NULL, 'VerifyDestinationNumberRequest$VerifiedDestinationNumberId' => '

The unique identifier for the verififed destination phone number.

', ], ], 'VerifiedDestinationNumberInformation' => [ 'base' => '

Provides information about the requested verified destintion phone number.

', 'refs' => [ 'VerifiedDestinationNumberInformationList$member' => NULL, ], ], 'VerifiedDestinationNumberInformationList' => [ 'base' => NULL, 'refs' => [ 'DescribeVerifiedDestinationNumbersResult$VerifiedDestinationNumbers' => '

An array of VerifiedDestinationNumberInformation objects

', ], ], 'VerifyDestinationNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'VerifyDestinationNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'VoiceId' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$VoiceId' => '

The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

', ], ], 'VoiceMessageBody' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$MessageBody' => '

The text to convert to a voice message.

', ], ], 'VoiceMessageBodyTextType' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$MessageBodyTextType' => '

Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

', ], ], 'VoiceMessageOriginationIdentity' => [ 'base' => NULL, 'refs' => [ 'SendVoiceMessageRequest$OriginationIdentity' => '

The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

', ], ], ],]; diff --git a/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json b/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json index 6a4fd39a6e..d118a21f8f 100644 --- a/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json +++ b/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json @@ -48,6 +48,12 @@ "limit_key": "MaxResults", "result_key": "Pools" }, + "DescribeProtectConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ProtectConfigurations" + }, "DescribeRegistrationAttachments": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json.php b/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json.php index d837e45aa5..8f80248129 100644 --- a/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json.php +++ b/src/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json.php @@ -1,3 +1,3 @@ [ 'DescribeAccountAttributes' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'AccountAttributes', ], 'DescribeAccountLimits' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'AccountLimits', ], 'DescribeConfigurationSets' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'ConfigurationSets', ], 'DescribeKeywords' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'Keywords', ], 'DescribeOptOutLists' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'OptOutLists', ], 'DescribeOptedOutNumbers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'OptedOutNumbers', ], 'DescribePhoneNumbers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'PhoneNumbers', ], 'DescribePools' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'Pools', ], 'DescribeRegistrationAttachments' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationAttachments', ], 'DescribeRegistrationFieldDefinitions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationFieldDefinitions', ], 'DescribeRegistrationFieldValues' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationFieldValues', ], 'DescribeRegistrationSectionDefinitions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationSectionDefinitions', ], 'DescribeRegistrationTypeDefinitions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationTypeDefinitions', ], 'DescribeRegistrationVersions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationVersions', ], 'DescribeRegistrations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'Registrations', ], 'DescribeSenderIds' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'SenderIds', ], 'DescribeSpendLimits' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'SpendLimits', ], 'DescribeVerifiedDestinationNumbers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'VerifiedDestinationNumbers', ], 'ListPoolOriginationIdentities' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'OriginationIdentities', ], 'ListRegistrationAssociations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationAssociations', ], ],]; +return [ 'pagination' => [ 'DescribeAccountAttributes' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'AccountAttributes', ], 'DescribeAccountLimits' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'AccountLimits', ], 'DescribeConfigurationSets' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'ConfigurationSets', ], 'DescribeKeywords' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'Keywords', ], 'DescribeOptOutLists' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'OptOutLists', ], 'DescribeOptedOutNumbers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'OptedOutNumbers', ], 'DescribePhoneNumbers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'PhoneNumbers', ], 'DescribePools' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'Pools', ], 'DescribeProtectConfigurations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'ProtectConfigurations', ], 'DescribeRegistrationAttachments' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationAttachments', ], 'DescribeRegistrationFieldDefinitions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationFieldDefinitions', ], 'DescribeRegistrationFieldValues' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationFieldValues', ], 'DescribeRegistrationSectionDefinitions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationSectionDefinitions', ], 'DescribeRegistrationTypeDefinitions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationTypeDefinitions', ], 'DescribeRegistrationVersions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationVersions', ], 'DescribeRegistrations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'Registrations', ], 'DescribeSenderIds' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'SenderIds', ], 'DescribeSpendLimits' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'SpendLimits', ], 'DescribeVerifiedDestinationNumbers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'VerifiedDestinationNumbers', ], 'ListPoolOriginationIdentities' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'OriginationIdentities', ], 'ListRegistrationAssociations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'RegistrationAssociations', ], ],]; diff --git a/src/data/qbusiness/2023-11-27/api-2.json b/src/data/qbusiness/2023-11-27/api-2.json index 2452113da7..42d8d0b204 100644 --- a/src/data/qbusiness/2023-11-27/api-2.json +++ b/src/data/qbusiness/2023-11-27/api-2.json @@ -1,4591 +1,7024 @@ { - "version":"2.0", - "metadata":{ - "apiVersion":"2023-11-27", - "endpointPrefix":"qbusiness", - "jsonVersion":"1.1", - "protocol":"rest-json", - "serviceFullName":"QBusiness", - "serviceId":"QBusiness", - "signatureVersion":"v4", - "signingName":"qbusiness", - "uid":"qbusiness-2023-11-27" - }, - "operations":{ - "BatchDeleteDocument":{ - "name":"BatchDeleteDocument", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/indices/{indexId}/documents/delete", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteDocumentRequest"}, - "output":{"shape":"BatchDeleteDocumentResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "BatchPutDocument":{ - "name":"BatchPutDocument", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/indices/{indexId}/documents", - "responseCode":200 - }, - "input":{"shape":"BatchPutDocumentRequest"}, - "output":{"shape":"BatchPutDocumentResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "ChatSync":{ - "name":"ChatSync", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/conversations?sync", - "responseCode":200 - }, - "input":{"shape":"ChatSyncInput"}, - "output":{"shape":"ChatSyncOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"LicenseNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "CreateApplication":{ - "name":"CreateApplication", - "http":{ - "method":"POST", - "requestUri":"/applications", - "responseCode":200 - }, - "input":{"shape":"CreateApplicationRequest"}, - "output":{"shape":"CreateApplicationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "CreateDataSource":{ - "name":"CreateDataSource", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources", - "responseCode":200 - }, - "input":{"shape":"CreateDataSourceRequest"}, - "output":{"shape":"CreateDataSourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "CreateIndex":{ - "name":"CreateIndex", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/indices", - "responseCode":200 - }, - "input":{"shape":"CreateIndexRequest"}, - "output":{"shape":"CreateIndexResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "CreatePlugin":{ - "name":"CreatePlugin", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/plugins", - "responseCode":200 - }, - "input":{"shape":"CreatePluginRequest"}, - "output":{"shape":"CreatePluginResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "CreateRetriever":{ - "name":"CreateRetriever", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/retrievers", - "responseCode":200 - }, - "input":{"shape":"CreateRetrieverRequest"}, - "output":{"shape":"CreateRetrieverResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "CreateUser":{ - "name":"CreateUser", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/users", - "responseCode":200 - }, - "input":{"shape":"CreateUserRequest"}, - "output":{"shape":"CreateUserResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "CreateWebExperience":{ - "name":"CreateWebExperience", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/experiences", - "responseCode":200 - }, - "input":{"shape":"CreateWebExperienceRequest"}, - "output":{"shape":"CreateWebExperienceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "DeleteApplication":{ - "name":"DeleteApplication", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}", - "responseCode":200 - }, - "input":{"shape":"DeleteApplicationRequest"}, - "output":{"shape":"DeleteApplicationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteChatControlsConfiguration":{ - "name":"DeleteChatControlsConfiguration", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/chatcontrols", - "responseCode":200 - }, - "input":{"shape":"DeleteChatControlsConfigurationRequest"}, - "output":{"shape":"DeleteChatControlsConfigurationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteConversation":{ - "name":"DeleteConversation", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/conversations/{conversationId}", - "responseCode":200 - }, - "input":{"shape":"DeleteConversationRequest"}, - "output":{"shape":"DeleteConversationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"LicenseNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteDataSource":{ - "name":"DeleteDataSource", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", - "responseCode":200 - }, - "input":{"shape":"DeleteDataSourceRequest"}, - "output":{"shape":"DeleteDataSourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteGroup":{ - "name":"DeleteGroup", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/indices/{indexId}/groups/{groupName}", - "responseCode":200 - }, - "input":{"shape":"DeleteGroupRequest"}, - "output":{"shape":"DeleteGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteIndex":{ - "name":"DeleteIndex", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/indices/{indexId}", - "responseCode":200 - }, - "input":{"shape":"DeleteIndexRequest"}, - "output":{"shape":"DeleteIndexResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeletePlugin":{ - "name":"DeletePlugin", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/plugins/{pluginId}", - "responseCode":200 - }, - "input":{"shape":"DeletePluginRequest"}, - "output":{"shape":"DeletePluginResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteRetriever":{ - "name":"DeleteRetriever", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", - "responseCode":200 - }, - "input":{"shape":"DeleteRetrieverRequest"}, - "output":{"shape":"DeleteRetrieverResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteUser":{ - "name":"DeleteUser", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/users/{userId}", - "responseCode":200 - }, - "input":{"shape":"DeleteUserRequest"}, - "output":{"shape":"DeleteUserResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteWebExperience":{ - "name":"DeleteWebExperience", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", - "responseCode":200 - }, - "input":{"shape":"DeleteWebExperienceRequest"}, - "output":{"shape":"DeleteWebExperienceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "GetApplication":{ - "name":"GetApplication", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}", - "responseCode":200 - }, - "input":{"shape":"GetApplicationRequest"}, - "output":{"shape":"GetApplicationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetChatControlsConfiguration":{ - "name":"GetChatControlsConfiguration", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/chatcontrols", - "responseCode":200 - }, - "input":{"shape":"GetChatControlsConfigurationRequest"}, - "output":{"shape":"GetChatControlsConfigurationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetDataSource":{ - "name":"GetDataSource", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", - "responseCode":200 - }, - "input":{"shape":"GetDataSourceRequest"}, - "output":{"shape":"GetDataSourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetGroup":{ - "name":"GetGroup", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices/{indexId}/groups/{groupName}", - "responseCode":200 - }, - "input":{"shape":"GetGroupRequest"}, - "output":{"shape":"GetGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetIndex":{ - "name":"GetIndex", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices/{indexId}", - "responseCode":200 - }, - "input":{"shape":"GetIndexRequest"}, - "output":{"shape":"GetIndexResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetPlugin":{ - "name":"GetPlugin", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/plugins/{pluginId}", - "responseCode":200 - }, - "input":{"shape":"GetPluginRequest"}, - "output":{"shape":"GetPluginResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetRetriever":{ - "name":"GetRetriever", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", - "responseCode":200 - }, - "input":{"shape":"GetRetrieverRequest"}, - "output":{"shape":"GetRetrieverResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetUser":{ - "name":"GetUser", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/users/{userId}", - "responseCode":200 - }, - "input":{"shape":"GetUserRequest"}, - "output":{"shape":"GetUserResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetWebExperience":{ - "name":"GetWebExperience", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", - "responseCode":200 - }, - "input":{"shape":"GetWebExperienceRequest"}, - "output":{"shape":"GetWebExperienceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListApplications":{ - "name":"ListApplications", - "http":{ - "method":"GET", - "requestUri":"/applications", - "responseCode":200 - }, - "input":{"shape":"ListApplicationsRequest"}, - "output":{"shape":"ListApplicationsResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListConversations":{ - "name":"ListConversations", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/conversations", - "responseCode":200 - }, - "input":{"shape":"ListConversationsRequest"}, - "output":{"shape":"ListConversationsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"LicenseNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListDataSourceSyncJobs":{ - "name":"ListDataSourceSyncJobs", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs", - "responseCode":200 - }, - "input":{"shape":"ListDataSourceSyncJobsRequest"}, - "output":{"shape":"ListDataSourceSyncJobsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListDataSources":{ - "name":"ListDataSources", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources", - "responseCode":200 - }, - "input":{"shape":"ListDataSourcesRequest"}, - "output":{"shape":"ListDataSourcesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListDocuments":{ - "name":"ListDocuments", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/index/{indexId}/documents", - "responseCode":200 - }, - "input":{"shape":"ListDocumentsRequest"}, - "output":{"shape":"ListDocumentsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListGroups":{ - "name":"ListGroups", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices/{indexId}/groups", - "responseCode":200 - }, - "input":{"shape":"ListGroupsRequest"}, - "output":{"shape":"ListGroupsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListIndices":{ - "name":"ListIndices", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/indices", - "responseCode":200 - }, - "input":{"shape":"ListIndicesRequest"}, - "output":{"shape":"ListIndicesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListMessages":{ - "name":"ListMessages", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/conversations/{conversationId}", - "responseCode":200 - }, - "input":{"shape":"ListMessagesRequest"}, - "output":{"shape":"ListMessagesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"LicenseNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListPlugins":{ - "name":"ListPlugins", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/plugins", - "responseCode":200 - }, - "input":{"shape":"ListPluginsRequest"}, - "output":{"shape":"ListPluginsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListRetrievers":{ - "name":"ListRetrievers", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/retrievers", - "responseCode":200 - }, - "input":{"shape":"ListRetrieversRequest"}, - "output":{"shape":"ListRetrieversResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/v1/tags/{resourceARN}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListWebExperiences":{ - "name":"ListWebExperiences", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}/experiences", - "responseCode":200 - }, - "input":{"shape":"ListWebExperiencesRequest"}, - "output":{"shape":"ListWebExperiencesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "PutFeedback":{ - "name":"PutFeedback", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", - "responseCode":200 - }, - "input":{"shape":"PutFeedbackRequest"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "PutGroup":{ - "name":"PutGroup", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/indices/{indexId}/groups", - "responseCode":200 - }, - "input":{"shape":"PutGroupRequest"}, - "output":{"shape":"PutGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "StartDataSourceSyncJob":{ - "name":"StartDataSourceSyncJob", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync", - "responseCode":200 - }, - "input":{"shape":"StartDataSourceSyncJobRequest"}, - "output":{"shape":"StartDataSourceSyncJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "StopDataSourceSyncJob":{ - "name":"StopDataSourceSyncJob", - "http":{ - "method":"POST", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", - "responseCode":200 - }, - "input":{"shape":"StopDataSourceSyncJobRequest"}, - "output":{"shape":"StopDataSourceSyncJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ] - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/v1/tags/{resourceARN}", - "responseCode":200 - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/v1/tags/{resourceARN}", - "responseCode":200 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "UpdateApplication":{ - "name":"UpdateApplication", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}", - "responseCode":200 - }, - "input":{"shape":"UpdateApplicationRequest"}, - "output":{"shape":"UpdateApplicationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "UpdateChatControlsConfiguration":{ - "name":"UpdateChatControlsConfiguration", - "http":{ - "method":"PATCH", - "requestUri":"/applications/{applicationId}/chatcontrols", - "responseCode":200 - }, - "input":{"shape":"UpdateChatControlsConfigurationRequest"}, - "output":{"shape":"UpdateChatControlsConfigurationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "UpdateDataSource":{ - "name":"UpdateDataSource", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", - "responseCode":200 - }, - "input":{"shape":"UpdateDataSourceRequest"}, - "output":{"shape":"UpdateDataSourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "UpdateIndex":{ - "name":"UpdateIndex", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/indices/{indexId}", - "responseCode":200 - }, - "input":{"shape":"UpdateIndexRequest"}, - "output":{"shape":"UpdateIndexResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "UpdatePlugin":{ - "name":"UpdatePlugin", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/plugins/{pluginId}", - "responseCode":200 - }, - "input":{"shape":"UpdatePluginRequest"}, - "output":{"shape":"UpdatePluginResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "UpdateRetriever":{ - "name":"UpdateRetriever", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", - "responseCode":200 - }, - "input":{"shape":"UpdateRetrieverRequest"}, - "output":{"shape":"UpdateRetrieverResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "UpdateUser":{ - "name":"UpdateUser", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/users/{userId}", - "responseCode":200 - }, - "input":{"shape":"UpdateUserRequest"}, - "output":{"shape":"UpdateUserResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "idempotent":true - }, - "UpdateWebExperience":{ - "name":"UpdateWebExperience", - "http":{ - "method":"PUT", - "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", - "responseCode":200 - }, - "input":{"shape":"UpdateWebExperienceRequest"}, - "output":{"shape":"UpdateWebExperienceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - } - }, - "shapes":{ - "AccessConfiguration":{ - "type":"structure", - "required":["accessControls"], - "members":{ - "accessControls":{"shape":"AccessControls"}, - "memberRelation":{"shape":"MemberRelation"} - } - }, - "AccessControl":{ - "type":"structure", - "required":["principals"], - "members":{ - "memberRelation":{"shape":"MemberRelation"}, - "principals":{"shape":"Principals"} - } - }, - "AccessControls":{ - "type":"list", - "member":{"shape":"AccessControl"} - }, - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "ActionExecution":{ - "type":"structure", - "required":[ - "payload", - "payloadFieldNameSeparator", - "pluginId" - ], - "members":{ - "payload":{"shape":"ActionExecutionPayload"}, - "payloadFieldNameSeparator":{"shape":"ActionPayloadFieldNameSeparator"}, - "pluginId":{"shape":"PluginId"} - } - }, - "ActionExecutionPayload":{ - "type":"map", - "key":{"shape":"ActionPayloadFieldKey"}, - "value":{"shape":"ActionExecutionPayloadField"} - }, - "ActionExecutionPayloadField":{ - "type":"structure", - "required":["value"], - "members":{ - "value":{"shape":"ActionPayloadFieldValue"} - } - }, - "ActionPayloadFieldKey":{ - "type":"string", - "min":1 - }, - "ActionPayloadFieldNameSeparator":{ - "type":"string", - "max":1, - "min":1 - }, - "ActionPayloadFieldType":{ - "type":"string", - "enum":[ - "STRING", - "NUMBER", - "ARRAY", - "BOOLEAN" - ] - }, - "ActionPayloadFieldValue":{ - "type":"structure", - "members":{ - }, - "document":true - }, - "ActionReview":{ - "type":"structure", - "members":{ - "payload":{"shape":"ActionReviewPayload"}, - "payloadFieldNameSeparator":{"shape":"ActionPayloadFieldNameSeparator"}, - "pluginId":{"shape":"PluginId"}, - "pluginType":{"shape":"PluginType"} - } - }, - "ActionReviewPayload":{ - "type":"map", - "key":{"shape":"ActionPayloadFieldKey"}, - "value":{"shape":"ActionReviewPayloadField"} - }, - "ActionReviewPayloadField":{ - "type":"structure", - "members":{ - "allowedValues":{"shape":"ActionReviewPayloadFieldAllowedValues"}, - "displayName":{"shape":"String"}, - "displayOrder":{"shape":"Integer"}, - "required":{"shape":"Boolean"}, - "type":{"shape":"ActionPayloadFieldType"}, - "value":{"shape":"ActionPayloadFieldValue"} - } - }, - "ActionReviewPayloadFieldAllowedValue":{ - "type":"structure", - "members":{ - "displayValue":{"shape":"ActionPayloadFieldValue"}, - "value":{"shape":"ActionPayloadFieldValue"} - } - }, - "ActionReviewPayloadFieldAllowedValues":{ - "type":"list", - "member":{"shape":"ActionReviewPayloadFieldAllowedValue"} - }, - "AmazonResourceName":{ - "type":"string", - "max":1011, - "min":1 - }, - "Application":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "createdAt":{"shape":"Timestamp"}, - "displayName":{"shape":"ApplicationName"}, - "status":{"shape":"ApplicationStatus"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "ApplicationArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "ApplicationId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "ApplicationName":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" - }, - "ApplicationStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "UPDATING" - ] - }, - "Applications":{ - "type":"list", - "member":{"shape":"Application"} - }, - "AppliedAttachmentsConfiguration":{ - "type":"structure", - "members":{ - "attachmentsControlMode":{"shape":"AttachmentsControlMode"} - } - }, - "AppliedCreatorModeConfiguration":{ - "type":"structure", - "required":["creatorModeControl"], - "members":{ - "creatorModeControl":{"shape":"CreatorModeControl"} - } - }, - "AttachmentInput":{ - "type":"structure", - "required":[ - "data", - "name" - ], - "members":{ - "data":{"shape":"Blob"}, - "name":{"shape":"AttachmentName"} - } - }, - "AttachmentName":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"^\\P{C}*$" - }, - "AttachmentOutput":{ - "type":"structure", - "members":{ - "error":{"shape":"ErrorDetail"}, - "name":{"shape":"AttachmentName"}, - "status":{"shape":"AttachmentStatus"} - } - }, - "AttachmentStatus":{ - "type":"string", - "enum":[ - "FAILED", - "SUCCEEDED" - ] - }, - "AttachmentsConfiguration":{ - "type":"structure", - "required":["attachmentsControlMode"], - "members":{ - "attachmentsControlMode":{"shape":"AttachmentsControlMode"} - } - }, - "AttachmentsControlMode":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "AttachmentsInput":{ - "type":"list", - "member":{"shape":"AttachmentInput"}, - "min":1 - }, - "AttachmentsOutput":{ - "type":"list", - "member":{"shape":"AttachmentOutput"} - }, - "AttributeFilter":{ - "type":"structure", - "members":{ - "andAllFilters":{"shape":"AttributeFilters"}, - "containsAll":{"shape":"DocumentAttribute"}, - "containsAny":{"shape":"DocumentAttribute"}, - "equalsTo":{"shape":"DocumentAttribute"}, - "greaterThan":{"shape":"DocumentAttribute"}, - "greaterThanOrEquals":{"shape":"DocumentAttribute"}, - "lessThan":{"shape":"DocumentAttribute"}, - "lessThanOrEquals":{"shape":"DocumentAttribute"}, - "notFilter":{"shape":"AttributeFilter"}, - "orAllFilters":{"shape":"AttributeFilters"} - } - }, - "AttributeFilters":{ - "type":"list", - "member":{"shape":"AttributeFilter"} - }, - "AttributeType":{ - "type":"string", - "enum":[ - "STRING", - "STRING_LIST", - "NUMBER", - "DATE" - ] - }, - "AttributeValueOperator":{ - "type":"string", - "enum":["DELETE"] - }, - "BasicAuthConfiguration":{ - "type":"structure", - "required":[ - "roleArn", - "secretArn" - ], - "members":{ - "roleArn":{"shape":"RoleArn"}, - "secretArn":{"shape":"SecretArn"} - } - }, - "BatchDeleteDocumentRequest":{ - "type":"structure", - "required":[ - "applicationId", - "documents", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceSyncId":{"shape":"ExecutionId"}, - "documents":{"shape":"DeleteDocuments"}, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "BatchDeleteDocumentResponse":{ - "type":"structure", - "members":{ - "failedDocuments":{"shape":"FailedDocuments"} - } - }, - "BatchPutDocumentRequest":{ - "type":"structure", - "required":[ - "applicationId", - "documents", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceSyncId":{"shape":"ExecutionId"}, - "documents":{"shape":"Documents"}, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "roleArn":{"shape":"RoleArn"} - } - }, - "BatchPutDocumentResponse":{ - "type":"structure", - "members":{ - "failedDocuments":{"shape":"FailedDocuments"} - } - }, - "Blob":{"type":"blob"}, - "BlockedPhrase":{ - "type":"string", - "max":36, - "min":0, - "pattern":"^\\P{C}*$" - }, - "BlockedPhrases":{ - "type":"list", - "member":{"shape":"BlockedPhrase"}, - "max":5, - "min":0 - }, - "BlockedPhrasesConfiguration":{ - "type":"structure", - "members":{ - "blockedPhrases":{"shape":"BlockedPhrases"}, - "systemMessageOverride":{"shape":"SystemMessageOverride"} - } - }, - "BlockedPhrasesConfigurationUpdate":{ - "type":"structure", - "members":{ - "blockedPhrasesToCreateOrUpdate":{"shape":"BlockedPhrases"}, - "blockedPhrasesToDelete":{"shape":"BlockedPhrases"}, - "systemMessageOverride":{"shape":"SystemMessageOverride"} - } - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "BoostingDurationInSeconds":{ - "type":"long", - "box":true, - "max":999999999, - "min":0 - }, - "ChatMode":{ - "type":"string", - "enum":[ - "RETRIEVAL_MODE", - "CREATOR_MODE", - "PLUGIN_MODE" - ] - }, - "ChatModeConfiguration":{ - "type":"structure", - "members":{ - "pluginConfiguration":{"shape":"PluginConfiguration"} - }, - "union":true - }, - "ChatSyncInput":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "actionExecution":{"shape":"ActionExecution"}, - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "attachments":{"shape":"AttachmentsInput"}, - "attributeFilter":{"shape":"AttributeFilter"}, - "chatMode":{"shape":"ChatMode"}, - "chatModeConfiguration":{"shape":"ChatModeConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "conversationId":{"shape":"ConversationId"}, - "parentMessageId":{"shape":"MessageId"}, - "userGroups":{ - "shape":"UserGroups", - "location":"querystring", - "locationName":"userGroups" - }, - "userId":{ - "shape":"UserId", - "location":"querystring", - "locationName":"userId" - }, - "userMessage":{"shape":"UserMessage"} - } - }, - "ChatSyncOutput":{ - "type":"structure", - "members":{ - "actionReview":{"shape":"ActionReview"}, - "conversationId":{"shape":"ConversationId"}, - "failedAttachments":{"shape":"AttachmentsOutput"}, - "sourceAttributions":{"shape":"SourceAttributions"}, - "systemMessage":{"shape":"String"}, - "systemMessageId":{"shape":"MessageId"}, - "userMessageId":{"shape":"MessageId"} - } - }, - "ClientToken":{ - "type":"string", - "max":100, - "min":1 - }, - "ConflictException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"ErrorMessage"}, - "resourceId":{"shape":"String"}, - "resourceType":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ContentBlockerRule":{ - "type":"structure", - "members":{ - "systemMessageOverride":{"shape":"SystemMessageOverride"} - } - }, - "ContentRetrievalRule":{ - "type":"structure", - "members":{ - "eligibleDataSources":{"shape":"EligibleDataSources"} - } - }, - "ContentType":{ - "type":"string", - "enum":[ - "PDF", - "HTML", - "MS_WORD", - "PLAIN_TEXT", - "PPT", - "RTF", - "XML", - "XSLT", - "MS_EXCEL", - "CSV", - "JSON", - "MD" - ] - }, - "Conversation":{ - "type":"structure", - "members":{ - "conversationId":{"shape":"ConversationId"}, - "startTime":{"shape":"Timestamp"}, - "title":{"shape":"ConversationTitle"} - } - }, - "ConversationId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "ConversationTitle":{"type":"string"}, - "Conversations":{ - "type":"list", - "member":{"shape":"Conversation"} - }, - "CreateApplicationRequest":{ - "type":"structure", - "required":[ - "displayName", - "roleArn" - ], - "members":{ - "attachmentsConfiguration":{"shape":"AttachmentsConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "description":{"shape":"Description"}, - "displayName":{"shape":"ApplicationName"}, - "encryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "identityCenterInstanceArn":{"shape":"InstanceArn"}, - "roleArn":{"shape":"RoleArn"}, - "tags":{"shape":"Tags"} - } - }, - "CreateApplicationResponse":{ - "type":"structure", - "members":{ - "applicationArn":{"shape":"ApplicationArn"}, - "applicationId":{"shape":"ApplicationId"} - } - }, - "CreateDataSourceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "configuration", - "displayName", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "configuration":{"shape":"DataSourceConfiguration"}, - "description":{"shape":"Description"}, - "displayName":{"shape":"DataSourceName"}, - "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "roleArn":{"shape":"RoleArn"}, - "syncSchedule":{"shape":"SyncSchedule"}, - "tags":{"shape":"Tags"}, - "vpcConfiguration":{"shape":"DataSourceVpcConfiguration"} - } - }, - "CreateDataSourceResponse":{ - "type":"structure", - "members":{ - "dataSourceArn":{"shape":"DataSourceArn"}, - "dataSourceId":{"shape":"DataSourceId"} - } - }, - "CreateIndexRequest":{ - "type":"structure", - "required":[ - "applicationId", - "displayName" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "capacityConfiguration":{"shape":"IndexCapacityConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "description":{"shape":"Description"}, - "displayName":{"shape":"IndexName"}, - "tags":{"shape":"Tags"} - } - }, - "CreateIndexResponse":{ - "type":"structure", - "members":{ - "indexArn":{"shape":"IndexArn"}, - "indexId":{"shape":"IndexId"} - } - }, - "CreatePluginRequest":{ - "type":"structure", - "required":[ - "applicationId", - "authConfiguration", - "displayName", - "serverUrl", - "type" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "authConfiguration":{"shape":"PluginAuthConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "displayName":{"shape":"PluginName"}, - "serverUrl":{"shape":"Url"}, - "tags":{"shape":"Tags"}, - "type":{"shape":"PluginType"} - } - }, - "CreatePluginResponse":{ - "type":"structure", - "members":{ - "pluginArn":{"shape":"PluginArn"}, - "pluginId":{"shape":"PluginId"} - } - }, - "CreateRetrieverRequest":{ - "type":"structure", - "required":[ - "applicationId", - "configuration", - "displayName", - "type" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "configuration":{"shape":"RetrieverConfiguration"}, - "displayName":{"shape":"RetrieverName"}, - "roleArn":{"shape":"RoleArn"}, - "tags":{"shape":"Tags"}, - "type":{"shape":"RetrieverType"} - } - }, - "CreateRetrieverResponse":{ - "type":"structure", - "members":{ - "retrieverArn":{"shape":"RetrieverArn"}, - "retrieverId":{"shape":"RetrieverId"} - } - }, - "CreateUserRequest":{ - "type":"structure", - "required":[ - "applicationId", - "userId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "userAliases":{"shape":"CreateUserRequestUserAliasesList"}, - "userId":{"shape":"String"} - } - }, - "CreateUserRequestUserAliasesList":{ - "type":"list", - "member":{"shape":"UserAlias"}, - "max":100, - "min":0 - }, - "CreateUserResponse":{ - "type":"structure", - "members":{ - } - }, - "CreateWebExperienceRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "roleArn":{"shape":"RoleArn"}, - "samplePromptsControlMode":{"shape":"WebExperienceSamplePromptsControlMode"}, - "subtitle":{"shape":"WebExperienceSubtitle"}, - "tags":{"shape":"Tags"}, - "title":{"shape":"WebExperienceTitle"}, - "welcomeMessage":{"shape":"WebExperienceWelcomeMessage"} - } - }, - "CreateWebExperienceResponse":{ - "type":"structure", - "members":{ - "webExperienceArn":{"shape":"WebExperienceArn"}, - "webExperienceId":{"shape":"WebExperienceId"} - } - }, - "CreatorModeConfiguration":{ - "type":"structure", - "required":["creatorModeControl"], - "members":{ - "creatorModeControl":{"shape":"CreatorModeControl"} - } - }, - "CreatorModeControl":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "DataSource":{ - "type":"structure", - "members":{ - "createdAt":{"shape":"Timestamp"}, - "dataSourceId":{"shape":"DataSourceId"}, - "displayName":{"shape":"DataSourceName"}, - "status":{"shape":"DataSourceStatus"}, - "type":{"shape":"String"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "DataSourceArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "DataSourceConfiguration":{ - "type":"structure", - "members":{ - }, - "document":true - }, - "DataSourceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "DataSourceIds":{ - "type":"list", - "member":{"shape":"DataSourceId"}, - "max":1, - "min":1 - }, - "DataSourceName":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" - }, - "DataSourceStatus":{ - "type":"string", - "enum":[ - "PENDING_CREATION", - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "UPDATING" - ] - }, - "DataSourceSyncJob":{ - "type":"structure", - "members":{ - "dataSourceErrorCode":{"shape":"String"}, - "endTime":{"shape":"Timestamp"}, - "error":{"shape":"ErrorDetail"}, - "executionId":{"shape":"ExecutionId"}, - "metrics":{"shape":"DataSourceSyncJobMetrics"}, - "startTime":{"shape":"Timestamp"}, - "status":{"shape":"DataSourceSyncJobStatus"} - } - }, - "DataSourceSyncJobMetrics":{ - "type":"structure", - "members":{ - "documentsAdded":{"shape":"MetricValue"}, - "documentsDeleted":{"shape":"MetricValue"}, - "documentsFailed":{"shape":"MetricValue"}, - "documentsModified":{"shape":"MetricValue"}, - "documentsScanned":{"shape":"MetricValue"} - } - }, - "DataSourceSyncJobStatus":{ - "type":"string", - "enum":[ - "FAILED", - "SUCCEEDED", - "SYNCING", - "INCOMPLETE", - "STOPPING", - "ABORTED", - "SYNCING_INDEXING" - ] - }, - "DataSourceSyncJobs":{ - "type":"list", - "member":{"shape":"DataSourceSyncJob"} - }, - "DataSourceUserId":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^\\P{C}*$" - }, - "DataSourceVpcConfiguration":{ - "type":"structure", - "required":[ - "securityGroupIds", - "subnetIds" - ], - "members":{ - "securityGroupIds":{"shape":"SecurityGroupIds"}, - "subnetIds":{"shape":"SubnetIds"} - } - }, - "DataSources":{ - "type":"list", - "member":{"shape":"DataSource"} - }, - "DateAttributeBoostingConfiguration":{ - "type":"structure", - "required":["boostingLevel"], - "members":{ - "boostingDurationInSeconds":{"shape":"BoostingDurationInSeconds"}, - "boostingLevel":{"shape":"DocumentAttributeBoostingLevel"} - } - }, - "DeleteApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - } - } - }, - "DeleteApplicationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteChatControlsConfigurationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - } - } - }, - "DeleteChatControlsConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteConversationRequest":{ - "type":"structure", - "required":[ - "applicationId", - "conversationId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "conversationId":{ - "shape":"ConversationId", - "location":"uri", - "locationName":"conversationId" - }, - "userId":{ - "shape":"UserId", - "location":"querystring", - "locationName":"userId" - } - } - }, - "DeleteConversationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteDataSourceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "dataSourceId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"uri", - "locationName":"dataSourceId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "DeleteDataSourceResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteDocument":{ - "type":"structure", - "required":["documentId"], - "members":{ - "documentId":{"shape":"DocumentId"} - } - }, - "DeleteDocuments":{ - "type":"list", - "member":{"shape":"DeleteDocument"} - }, - "DeleteGroupRequest":{ - "type":"structure", - "required":[ - "applicationId", - "groupName", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"querystring", - "locationName":"dataSourceId" - }, - "groupName":{ - "shape":"GroupName", - "location":"uri", - "locationName":"groupName" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "DeleteGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteIndexRequest":{ - "type":"structure", - "required":[ - "applicationId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "DeleteIndexResponse":{ - "type":"structure", - "members":{ - } - }, - "DeletePluginRequest":{ - "type":"structure", - "required":[ - "applicationId", - "pluginId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "pluginId":{ - "shape":"PluginId", - "location":"uri", - "locationName":"pluginId" - } - } - }, - "DeletePluginResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteRetrieverRequest":{ - "type":"structure", - "required":[ - "applicationId", - "retrieverId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "retrieverId":{ - "shape":"RetrieverId", - "location":"uri", - "locationName":"retrieverId" - } - } - }, - "DeleteRetrieverResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteUserRequest":{ - "type":"structure", - "required":[ - "applicationId", - "userId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "userId":{ - "shape":"String", - "location":"uri", - "locationName":"userId" - } - } - }, - "DeleteUserResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteWebExperienceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "webExperienceId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "webExperienceId":{ - "shape":"WebExperienceId", - "location":"uri", - "locationName":"webExperienceId" + "version": "2.0", + "metadata": { + "apiVersion": "2023-11-27", + "endpointPrefix": "qbusiness", + "protocol": "rest-json", + "protocolSettings": { + "h2": "eventstream" + }, + "protocols": [ + "rest-json" + ], + "serviceFullName": "QBusiness", + "serviceId": "QBusiness", + "signatureVersion": "v4", + "signingName": "qbusiness", + "uid": "qbusiness-2023-11-27" + }, + "operations": { + "BatchDeleteDocument": { + "name": "BatchDeleteDocument", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/documents\/delete", + "responseCode": 200 + }, + "input": { + "shape": "BatchDeleteDocumentRequest" + }, + "output": { + "shape": "BatchDeleteDocumentResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "BatchPutDocument": { + "name": "BatchPutDocument", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/documents", + "responseCode": 200 + }, + "input": { + "shape": "BatchPutDocumentRequest" + }, + "output": { + "shape": "BatchPutDocumentResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ] + }, + "ChatSync": { + "name": "ChatSync", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/conversations?sync", + "responseCode": 200 + }, + "input": { + "shape": "ChatSyncInput" + }, + "output": { + "shape": "ChatSyncOutput" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "LicenseNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "CreateApplication": { + "name": "CreateApplication", + "http": { + "method": "POST", + "requestUri": "\/applications", + "responseCode": 200 + }, + "input": { + "shape": "CreateApplicationRequest" + }, + "output": { + "shape": "CreateApplicationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "CreateDataSource": { + "name": "CreateDataSource", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources", + "responseCode": 200 + }, + "input": { + "shape": "CreateDataSourceRequest" + }, + "output": { + "shape": "CreateDataSourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "CreateIndex": { + "name": "CreateIndex", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/indices", + "responseCode": 200 + }, + "input": { + "shape": "CreateIndexRequest" + }, + "output": { + "shape": "CreateIndexResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ] + }, + "CreatePlugin": { + "name": "CreatePlugin", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/plugins", + "responseCode": 200 + }, + "input": { + "shape": "CreatePluginRequest" + }, + "output": { + "shape": "CreatePluginResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "CreateRetriever": { + "name": "CreateRetriever", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/retrievers", + "responseCode": 200 + }, + "input": { + "shape": "CreateRetrieverRequest" + }, + "output": { + "shape": "CreateRetrieverResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ] + }, + "CreateUser": { + "name": "CreateUser", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/users", + "responseCode": 200 + }, + "input": { + "shape": "CreateUserRequest" + }, + "output": { + "shape": "CreateUserResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "CreateWebExperience": { + "name": "CreateWebExperience", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/experiences", + "responseCode": 200 + }, + "input": { + "shape": "CreateWebExperienceRequest" + }, + "output": { + "shape": "CreateWebExperienceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ] + }, + "DeleteApplication": { + "name": "DeleteApplication", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteApplicationRequest" + }, + "output": { + "shape": "DeleteApplicationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteChatControlsConfiguration": { + "name": "DeleteChatControlsConfiguration", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/chatcontrols", + "responseCode": 200 + }, + "input": { + "shape": "DeleteChatControlsConfigurationRequest" + }, + "output": { + "shape": "DeleteChatControlsConfigurationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteConversation": { + "name": "DeleteConversation", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/conversations\/{conversationId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteConversationRequest" + }, + "output": { + "shape": "DeleteConversationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "LicenseNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteDataSource": { + "name": "DeleteDataSource", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources\/{dataSourceId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteDataSourceRequest" + }, + "output": { + "shape": "DeleteDataSourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteGroup": { + "name": "DeleteGroup", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/groups\/{groupName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteGroupRequest" + }, + "output": { + "shape": "DeleteGroupResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteIndex": { + "name": "DeleteIndex", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteIndexRequest" + }, + "output": { + "shape": "DeleteIndexResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeletePlugin": { + "name": "DeletePlugin", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/plugins\/{pluginId}", + "responseCode": 200 + }, + "input": { + "shape": "DeletePluginRequest" + }, + "output": { + "shape": "DeletePluginResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteRetriever": { + "name": "DeleteRetriever", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/retrievers\/{retrieverId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteRetrieverRequest" + }, + "output": { + "shape": "DeleteRetrieverResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteUser": { + "name": "DeleteUser", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/users\/{userId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteUserRequest" + }, + "output": { + "shape": "DeleteUserResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "DeleteWebExperience": { + "name": "DeleteWebExperience", + "http": { + "method": "DELETE", + "requestUri": "\/applications\/{applicationId}\/experiences\/{webExperienceId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteWebExperienceRequest" + }, + "output": { + "shape": "DeleteWebExperienceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "GetApplication": { + "name": "GetApplication", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}", + "responseCode": 200 + }, + "input": { + "shape": "GetApplicationRequest" + }, + "output": { + "shape": "GetApplicationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetChatControlsConfiguration": { + "name": "GetChatControlsConfiguration", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/chatcontrols", + "responseCode": 200 + }, + "input": { + "shape": "GetChatControlsConfigurationRequest" + }, + "output": { + "shape": "GetChatControlsConfigurationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetDataSource": { + "name": "GetDataSource", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources\/{dataSourceId}", + "responseCode": 200 + }, + "input": { + "shape": "GetDataSourceRequest" + }, + "output": { + "shape": "GetDataSourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetGroup": { + "name": "GetGroup", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/groups\/{groupName}", + "responseCode": 200 + }, + "input": { + "shape": "GetGroupRequest" + }, + "output": { + "shape": "GetGroupResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetIndex": { + "name": "GetIndex", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}", + "responseCode": 200 + }, + "input": { + "shape": "GetIndexRequest" + }, + "output": { + "shape": "GetIndexResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetPlugin": { + "name": "GetPlugin", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/plugins\/{pluginId}", + "responseCode": 200 + }, + "input": { + "shape": "GetPluginRequest" + }, + "output": { + "shape": "GetPluginResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetRetriever": { + "name": "GetRetriever", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/retrievers\/{retrieverId}", + "responseCode": 200 + }, + "input": { + "shape": "GetRetrieverRequest" + }, + "output": { + "shape": "GetRetrieverResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetUser": { + "name": "GetUser", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/users\/{userId}", + "responseCode": 200 + }, + "input": { + "shape": "GetUserRequest" + }, + "output": { + "shape": "GetUserResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "GetWebExperience": { + "name": "GetWebExperience", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/experiences\/{webExperienceId}", + "responseCode": 200 + }, + "input": { + "shape": "GetWebExperienceRequest" + }, + "output": { + "shape": "GetWebExperienceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListApplications": { + "name": "ListApplications", + "http": { + "method": "GET", + "requestUri": "\/applications", + "responseCode": 200 + }, + "input": { + "shape": "ListApplicationsRequest" + }, + "output": { + "shape": "ListApplicationsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListConversations": { + "name": "ListConversations", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/conversations", + "responseCode": 200 + }, + "input": { + "shape": "ListConversationsRequest" + }, + "output": { + "shape": "ListConversationsResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "LicenseNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListDataSourceSyncJobs": { + "name": "ListDataSourceSyncJobs", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources\/{dataSourceId}\/syncjobs", + "responseCode": 200 + }, + "input": { + "shape": "ListDataSourceSyncJobsRequest" + }, + "output": { + "shape": "ListDataSourceSyncJobsResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListDataSources": { + "name": "ListDataSources", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources", + "responseCode": 200 + }, + "input": { + "shape": "ListDataSourcesRequest" + }, + "output": { + "shape": "ListDataSourcesResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListDocuments": { + "name": "ListDocuments", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/index\/{indexId}\/documents", + "responseCode": 200 + }, + "input": { + "shape": "ListDocumentsRequest" + }, + "output": { + "shape": "ListDocumentsResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListGroups": { + "name": "ListGroups", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/groups", + "responseCode": 200 + }, + "input": { + "shape": "ListGroupsRequest" + }, + "output": { + "shape": "ListGroupsResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListIndices": { + "name": "ListIndices", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/indices", + "responseCode": 200 + }, + "input": { + "shape": "ListIndicesRequest" + }, + "output": { + "shape": "ListIndicesResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListMessages": { + "name": "ListMessages", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/conversations\/{conversationId}", + "responseCode": 200 + }, + "input": { + "shape": "ListMessagesRequest" + }, + "output": { + "shape": "ListMessagesResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "LicenseNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListPlugins": { + "name": "ListPlugins", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/plugins", + "responseCode": 200 + }, + "input": { + "shape": "ListPluginsRequest" + }, + "output": { + "shape": "ListPluginsResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListRetrievers": { + "name": "ListRetrievers", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/retrievers", + "responseCode": 200 + }, + "input": { + "shape": "ListRetrieversRequest" + }, + "output": { + "shape": "ListRetrieversResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "\/v1\/tags\/{resourceARN}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "ListWebExperiences": { + "name": "ListWebExperiences", + "http": { + "method": "GET", + "requestUri": "\/applications\/{applicationId}\/experiences", + "responseCode": 200 + }, + "input": { + "shape": "ListWebExperiencesRequest" + }, + "output": { + "shape": "ListWebExperiencesResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "PutFeedback": { + "name": "PutFeedback", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/conversations\/{conversationId}\/messages\/{messageId}\/feedback", + "responseCode": 200 + }, + "input": { + "shape": "PutFeedbackRequest" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "PutGroup": { + "name": "PutGroup", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/groups", + "responseCode": 200 + }, + "input": { + "shape": "PutGroupRequest" + }, + "output": { + "shape": "PutGroupResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "StartDataSourceSyncJob": { + "name": "StartDataSourceSyncJob", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources\/{dataSourceId}\/startsync", + "responseCode": 200 + }, + "input": { + "shape": "StartDataSourceSyncJobRequest" + }, + "output": { + "shape": "StartDataSourceSyncJobResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ] + }, + "StopDataSourceSyncJob": { + "name": "StopDataSourceSyncJob", + "http": { + "method": "POST", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources\/{dataSourceId}\/stopsync", + "responseCode": 200 + }, + "input": { + "shape": "StopDataSourceSyncJobRequest" + }, + "output": { + "shape": "StopDataSourceSyncJobResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ] + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "\/v1\/tags\/{resourceARN}", + "responseCode": 200 + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "\/v1\/tags\/{resourceARN}", + "responseCode": 200 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "UpdateApplication": { + "name": "UpdateApplication", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateApplicationRequest" + }, + "output": { + "shape": "UpdateApplicationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "UpdateChatControlsConfiguration": { + "name": "UpdateChatControlsConfiguration", + "http": { + "method": "PATCH", + "requestUri": "\/applications\/{applicationId}\/chatcontrols", + "responseCode": 200 + }, + "input": { + "shape": "UpdateChatControlsConfigurationRequest" + }, + "output": { + "shape": "UpdateChatControlsConfigurationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "UpdateDataSource": { + "name": "UpdateDataSource", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}\/datasources\/{dataSourceId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateDataSourceRequest" + }, + "output": { + "shape": "UpdateDataSourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true + }, + "UpdateIndex": { + "name": "UpdateIndex", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/indices\/{indexId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateIndexRequest" + }, + "output": { + "shape": "UpdateIndexResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "UpdatePlugin": { + "name": "UpdatePlugin", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/plugins\/{pluginId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdatePluginRequest" + }, + "output": { + "shape": "UpdatePluginResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "UpdateRetriever": { + "name": "UpdateRetriever", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/retrievers\/{retrieverId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateRetrieverRequest" + }, + "output": { + "shape": "UpdateRetrieverResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "UpdateUser": { + "name": "UpdateUser", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/users\/{userId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateUserRequest" + }, + "output": { + "shape": "UpdateUserResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "idempotent": true + }, + "UpdateWebExperience": { + "name": "UpdateWebExperience", + "http": { + "method": "PUT", + "requestUri": "\/applications\/{applicationId}\/experiences\/{webExperienceId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateWebExperienceRequest" + }, + "output": { + "shape": "UpdateWebExperienceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "idempotent": true } - } - }, - "DeleteWebExperienceResponse":{ - "type":"structure", - "members":{ - } - }, - "Description":{ - "type":"string", - "max":1000, - "min":0, - "pattern":"^\\P{C}*$" - }, - "Document":{ - "type":"structure", - "required":["id"], - "members":{ - "accessConfiguration":{"shape":"AccessConfiguration"}, - "attributes":{"shape":"DocumentAttributes"}, - "content":{"shape":"DocumentContent"}, - "contentType":{"shape":"ContentType"}, - "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, - "id":{"shape":"DocumentId"}, - "title":{"shape":"Title"} - } - }, - "DocumentAttribute":{ - "type":"structure", - "required":[ - "name", - "value" - ], - "members":{ - "name":{"shape":"DocumentAttributeKey"}, - "value":{"shape":"DocumentAttributeValue"} - } - }, - "DocumentAttributeBoostingConfiguration":{ - "type":"structure", - "members":{ - "dateConfiguration":{"shape":"DateAttributeBoostingConfiguration"}, - "numberConfiguration":{"shape":"NumberAttributeBoostingConfiguration"}, - "stringConfiguration":{"shape":"StringAttributeBoostingConfiguration"}, - "stringListConfiguration":{"shape":"StringListAttributeBoostingConfiguration"} - }, - "union":true - }, - "DocumentAttributeBoostingLevel":{ - "type":"string", - "enum":[ - "NONE", - "LOW", - "MEDIUM", - "HIGH", - "VERY_HIGH" - ] - }, - "DocumentAttributeBoostingOverrideMap":{ - "type":"map", - "key":{"shape":"DocumentAttributeKey"}, - "value":{"shape":"DocumentAttributeBoostingConfiguration"}, - "min":1 - }, - "DocumentAttributeCondition":{ - "type":"structure", - "required":[ - "key", - "operator" - ], - "members":{ - "key":{"shape":"DocumentAttributeKey"}, - "operator":{"shape":"DocumentEnrichmentConditionOperator"}, - "value":{"shape":"DocumentAttributeValue"} - } - }, - "DocumentAttributeConfiguration":{ - "type":"structure", - "members":{ - "name":{"shape":"String"}, - "search":{"shape":"Status"}, - "type":{"shape":"AttributeType"} - } - }, - "DocumentAttributeConfigurations":{ - "type":"list", - "member":{"shape":"DocumentAttributeConfiguration"}, - "max":500, - "min":1 - }, - "DocumentAttributeKey":{ - "type":"string", - "max":200, - "min":1, - "pattern":"^[a-zA-Z0-9_][a-zA-Z0-9_-]*$" - }, - "DocumentAttributeStringListValue":{ - "type":"list", - "member":{"shape":"String"} - }, - "DocumentAttributeTarget":{ - "type":"structure", - "required":["key"], - "members":{ - "attributeValueOperator":{"shape":"AttributeValueOperator"}, - "key":{"shape":"DocumentAttributeKey"}, - "value":{"shape":"DocumentAttributeValue"} - } - }, - "DocumentAttributeValue":{ - "type":"structure", - "members":{ - "dateValue":{"shape":"Timestamp"}, - "longValue":{"shape":"Long"}, - "stringListValue":{"shape":"DocumentAttributeStringListValue"}, - "stringValue":{"shape":"DocumentAttributeValueStringValueString"} - }, - "union":true - }, - "DocumentAttributeValueStringValueString":{ - "type":"string", - "max":2048, - "min":0 - }, - "DocumentAttributes":{ - "type":"list", - "member":{"shape":"DocumentAttribute"}, - "max":500, - "min":1 - }, - "DocumentContent":{ - "type":"structure", - "members":{ - "blob":{"shape":"Blob"}, - "s3":{"shape":"S3"} - }, - "union":true - }, - "DocumentContentOperator":{ - "type":"string", - "enum":["DELETE"] - }, - "DocumentDetailList":{ - "type":"list", - "member":{"shape":"DocumentDetails"} - }, - "DocumentDetails":{ - "type":"structure", - "members":{ - "createdAt":{"shape":"Timestamp"}, - "documentId":{"shape":"DocumentId"}, - "error":{"shape":"ErrorDetail"}, - "status":{"shape":"DocumentStatus"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "DocumentEnrichmentConditionOperator":{ - "type":"string", - "enum":[ - "GREATER_THAN", - "GREATER_THAN_OR_EQUALS", - "LESS_THAN", - "LESS_THAN_OR_EQUALS", - "EQUALS", - "NOT_EQUALS", - "CONTAINS", - "NOT_CONTAINS", - "EXISTS", - "NOT_EXISTS", - "BEGINS_WITH" - ] - }, - "DocumentEnrichmentConfiguration":{ - "type":"structure", - "members":{ - "inlineConfigurations":{"shape":"InlineDocumentEnrichmentConfigurations"}, - "postExtractionHookConfiguration":{"shape":"HookConfiguration"}, - "preExtractionHookConfiguration":{"shape":"HookConfiguration"} - } - }, - "DocumentId":{ - "type":"string", - "max":1825, - "min":1, - "pattern":"^\\P{C}*$" - }, - "DocumentStatus":{ - "type":"string", - "enum":[ - "RECEIVED", - "PROCESSING", - "INDEXED", - "UPDATED", - "FAILED", - "DELETING", - "DELETED", - "DOCUMENT_FAILED_TO_INDEX" - ] }, - "Documents":{ - "type":"list", - "member":{"shape":"Document"}, - "max":10, - "min":1 - }, - "EligibleDataSource":{ - "type":"structure", - "members":{ - "dataSourceId":{"shape":"DataSourceId"}, - "indexId":{"shape":"IndexId"} - } - }, - "EligibleDataSources":{ - "type":"list", - "member":{"shape":"EligibleDataSource"}, - "max":5, - "min":0 - }, - "EncryptionConfiguration":{ - "type":"structure", - "members":{ - "kmsKeyId":{"shape":"KmsKeyId"} - } - }, - "ErrorCode":{ - "type":"string", - "enum":[ - "InternalError", - "InvalidRequest", - "ResourceInactive", - "ResourceNotFound" - ] - }, - "ErrorDetail":{ - "type":"structure", - "members":{ - "errorCode":{"shape":"ErrorCode"}, - "errorMessage":{"shape":"ErrorMessage"} - } - }, - "ErrorMessage":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^\\P{C}*$" - }, - "ExampleChatMessage":{ - "type":"string", - "max":350, - "min":0, - "pattern":"^\\P{C}*$" - }, - "ExampleChatMessages":{ - "type":"list", - "member":{"shape":"ExampleChatMessage"}, - "max":5, - "min":0 - }, - "ExecutionId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "FailedDocument":{ - "type":"structure", - "members":{ - "dataSourceId":{"shape":"DataSourceId"}, - "error":{"shape":"ErrorDetail"}, - "id":{"shape":"DocumentId"} - } - }, - "FailedDocuments":{ - "type":"list", - "member":{"shape":"FailedDocument"} - }, - "GetApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - } - } - }, - "GetApplicationResponse":{ - "type":"structure", - "members":{ - "applicationArn":{"shape":"ApplicationArn"}, - "applicationId":{"shape":"ApplicationId"}, - "attachmentsConfiguration":{"shape":"AppliedAttachmentsConfiguration"}, - "createdAt":{"shape":"Timestamp"}, - "description":{"shape":"Description"}, - "displayName":{"shape":"ApplicationName"}, - "encryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "error":{"shape":"ErrorDetail"}, - "identityCenterApplicationArn":{"shape":"IdcApplicationArn"}, - "roleArn":{"shape":"RoleArn"}, - "status":{"shape":"ApplicationStatus"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "GetChatControlsConfigurationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForGetTopicConfigurations", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "GetChatControlsConfigurationResponse":{ - "type":"structure", - "members":{ - "blockedPhrases":{"shape":"BlockedPhrasesConfiguration"}, - "creatorModeConfiguration":{"shape":"AppliedCreatorModeConfiguration"}, - "nextToken":{"shape":"NextToken"}, - "responseScope":{"shape":"ResponseScope"}, - "topicConfigurations":{"shape":"TopicConfigurations"} - } - }, - "GetDataSourceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "dataSourceId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"uri", - "locationName":"dataSourceId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "GetDataSourceResponse":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "configuration":{"shape":"DataSourceConfiguration"}, - "createdAt":{"shape":"Timestamp"}, - "dataSourceArn":{"shape":"DataSourceArn"}, - "dataSourceId":{"shape":"DataSourceId"}, - "description":{"shape":"Description"}, - "displayName":{"shape":"DataSourceName"}, - "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, - "error":{"shape":"ErrorDetail"}, - "indexId":{"shape":"IndexId"}, - "roleArn":{"shape":"RoleArn"}, - "status":{"shape":"DataSourceStatus"}, - "syncSchedule":{"shape":"SyncSchedule"}, - "type":{"shape":"String"}, - "updatedAt":{"shape":"Timestamp"}, - "vpcConfiguration":{"shape":"DataSourceVpcConfiguration"} - } - }, - "GetGroupRequest":{ - "type":"structure", - "required":[ - "applicationId", - "groupName", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"querystring", - "locationName":"dataSourceId" - }, - "groupName":{ - "shape":"GroupName", - "location":"uri", - "locationName":"groupName" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "GetGroupResponse":{ - "type":"structure", - "members":{ - "status":{"shape":"GroupStatusDetail"}, - "statusHistory":{"shape":"GroupStatusDetails"} - } - }, - "GetIndexRequest":{ - "type":"structure", - "required":[ - "applicationId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "GetIndexResponse":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "capacityConfiguration":{"shape":"IndexCapacityConfiguration"}, - "createdAt":{"shape":"Timestamp"}, - "description":{"shape":"Description"}, - "displayName":{"shape":"IndexName"}, - "documentAttributeConfigurations":{"shape":"DocumentAttributeConfigurations"}, - "error":{"shape":"ErrorDetail"}, - "indexArn":{"shape":"IndexArn"}, - "indexId":{"shape":"IndexId"}, - "indexStatistics":{"shape":"IndexStatistics"}, - "status":{"shape":"IndexStatus"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "GetPluginRequest":{ - "type":"structure", - "required":[ - "applicationId", - "pluginId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "pluginId":{ - "shape":"PluginId", - "location":"uri", - "locationName":"pluginId" - } - } - }, - "GetPluginResponse":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "authConfiguration":{"shape":"PluginAuthConfiguration"}, - "createdAt":{"shape":"Timestamp"}, - "displayName":{"shape":"PluginName"}, - "pluginArn":{"shape":"PluginArn"}, - "pluginId":{"shape":"PluginId"}, - "serverUrl":{"shape":"Url"}, - "state":{"shape":"PluginState"}, - "type":{"shape":"PluginType"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "GetRetrieverRequest":{ - "type":"structure", - "required":[ - "applicationId", - "retrieverId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "retrieverId":{ - "shape":"RetrieverId", - "location":"uri", - "locationName":"retrieverId" - } - } - }, - "GetRetrieverResponse":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "configuration":{"shape":"RetrieverConfiguration"}, - "createdAt":{"shape":"Timestamp"}, - "displayName":{"shape":"RetrieverName"}, - "retrieverArn":{"shape":"RetrieverArn"}, - "retrieverId":{"shape":"RetrieverId"}, - "roleArn":{"shape":"RoleArn"}, - "status":{"shape":"RetrieverStatus"}, - "type":{"shape":"RetrieverType"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "GetUserRequest":{ - "type":"structure", - "required":[ - "applicationId", - "userId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "userId":{ - "shape":"String", - "location":"uri", - "locationName":"userId" - } - } - }, - "GetUserResponse":{ - "type":"structure", - "members":{ - "userAliases":{"shape":"UserAliases"} - } - }, - "GetWebExperienceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "webExperienceId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "webExperienceId":{ - "shape":"WebExperienceId", - "location":"uri", - "locationName":"webExperienceId" - } - } - }, - "GetWebExperienceResponse":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "authenticationConfiguration":{"shape":"WebExperienceAuthConfiguration"}, - "createdAt":{"shape":"Timestamp"}, - "defaultEndpoint":{"shape":"Url"}, - "error":{"shape":"ErrorDetail"}, - "roleArn":{"shape":"RoleArn"}, - "samplePromptsControlMode":{"shape":"WebExperienceSamplePromptsControlMode"}, - "status":{"shape":"WebExperienceStatus"}, - "subtitle":{"shape":"WebExperienceSubtitle"}, - "title":{"shape":"WebExperienceTitle"}, - "updatedAt":{"shape":"Timestamp"}, - "webExperienceArn":{"shape":"WebExperienceArn"}, - "webExperienceId":{"shape":"WebExperienceId"}, - "welcomeMessage":{"shape":"WebExperienceWelcomeMessage"} - } - }, - "GroupMembers":{ - "type":"structure", - "members":{ - "memberGroups":{"shape":"MemberGroups"}, - "memberUsers":{"shape":"MemberUsers"} - } - }, - "GroupName":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^\\P{C}*$" - }, - "GroupStatus":{ - "type":"string", - "enum":[ - "FAILED", - "SUCCEEDED", - "PROCESSING", - "DELETING", - "DELETED" - ] - }, - "GroupStatusDetail":{ - "type":"structure", - "members":{ - "errorDetail":{"shape":"ErrorDetail"}, - "lastUpdatedAt":{"shape":"Timestamp"}, - "status":{"shape":"GroupStatus"} - } - }, - "GroupStatusDetails":{ - "type":"list", - "member":{"shape":"GroupStatusDetail"} - }, - "GroupSummary":{ - "type":"structure", - "members":{ - "groupName":{"shape":"GroupName"} - } - }, - "GroupSummaryList":{ - "type":"list", - "member":{"shape":"GroupSummary"} - }, - "HookConfiguration":{ - "type":"structure", - "members":{ - "invocationCondition":{"shape":"DocumentAttributeCondition"}, - "lambdaArn":{"shape":"LambdaArn"}, - "roleArn":{"shape":"RoleArn"}, - "s3BucketName":{"shape":"S3BucketName"} - } - }, - "IdcApplicationArn":{ - "type":"string", - "max":1224, - "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" - }, - "Index":{ - "type":"structure", - "members":{ - "createdAt":{"shape":"Timestamp"}, - "displayName":{"shape":"IndexName"}, - "indexId":{"shape":"IndexId"}, - "status":{"shape":"IndexStatus"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "IndexArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "IndexCapacityConfiguration":{ - "type":"structure", - "members":{ - "units":{"shape":"IndexCapacityInteger"} - } - }, - "IndexCapacityInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "IndexId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "IndexName":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" - }, - "IndexStatistics":{ - "type":"structure", - "members":{ - "textDocumentStatistics":{"shape":"TextDocumentStatistics"} - } - }, - "IndexStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "UPDATING" - ] - }, - "IndexedTextBytes":{ - "type":"long", - "box":true, - "min":0 - }, - "IndexedTextDocument":{ - "type":"integer", - "box":true, - "min":0 - }, - "Indices":{ - "type":"list", - "member":{"shape":"Index"} - }, - "InlineDocumentEnrichmentConfiguration":{ - "type":"structure", - "members":{ - "condition":{"shape":"DocumentAttributeCondition"}, - "documentContentOperator":{"shape":"DocumentContentOperator"}, - "target":{"shape":"DocumentAttributeTarget"} - } - }, - "InlineDocumentEnrichmentConfigurations":{ - "type":"list", - "member":{"shape":"InlineDocumentEnrichmentConfiguration"}, - "max":100, - "min":1 - }, - "InstanceArn":{ - "type":"string", - "max":1224, - "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "KendraIndexConfiguration":{ - "type":"structure", - "required":["indexId"], - "members":{ - "indexId":{"shape":"KendraIndexId"} - } - }, - "KendraIndexId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "KmsKeyId":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "LambdaArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$" - }, - "LicenseNotFoundException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ListApplicationsRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResultsIntegerForListApplications", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListApplicationsResponse":{ - "type":"structure", - "members":{ - "applications":{"shape":"Applications"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListConversationsRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListConversations", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "userId":{ - "shape":"UserId", - "location":"querystring", - "locationName":"userId" - } - } - }, - "ListConversationsResponse":{ - "type":"structure", - "members":{ - "conversations":{"shape":"Conversations"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListDataSourceSyncJobsRequest":{ - "type":"structure", - "required":[ - "applicationId", - "dataSourceId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"uri", - "locationName":"dataSourceId" - }, - "endTime":{ - "shape":"Timestamp", - "location":"querystring", - "locationName":"endTime" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListDataSourcesSyncJobs", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "startTime":{ - "shape":"Timestamp", - "location":"querystring", - "locationName":"startTime" - }, - "statusFilter":{ - "shape":"DataSourceSyncJobStatus", - "location":"querystring", - "locationName":"syncStatus" - } - } - }, - "ListDataSourceSyncJobsResponse":{ - "type":"structure", - "members":{ - "history":{"shape":"DataSourceSyncJobs"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListDataSourcesRequest":{ - "type":"structure", - "required":[ - "applicationId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListDataSources", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListDataSourcesResponse":{ - "type":"structure", - "members":{ - "dataSources":{"shape":"DataSources"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListDocumentsRequest":{ - "type":"structure", - "required":[ - "applicationId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceIds":{ - "shape":"DataSourceIds", - "location":"querystring", - "locationName":"dataSourceIds" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListDocuments", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListDocumentsResponse":{ - "type":"structure", - "members":{ - "documentDetailList":{"shape":"DocumentDetailList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListGroupsRequest":{ - "type":"structure", - "required":[ - "applicationId", - "indexId", - "updatedEarlierThan" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"querystring", - "locationName":"dataSourceId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListGroupsRequest", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "updatedEarlierThan":{ - "shape":"Timestamp", - "location":"querystring", - "locationName":"updatedEarlierThan" - } - } - }, - "ListGroupsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"GroupSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListIndicesRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListIndices", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListIndicesResponse":{ - "type":"structure", - "members":{ - "indices":{"shape":"Indices"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListMessagesRequest":{ - "type":"structure", - "required":[ - "applicationId", - "conversationId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "conversationId":{ - "shape":"ConversationId", - "location":"uri", - "locationName":"conversationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListMessages", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "userId":{ - "shape":"UserId", - "location":"querystring", - "locationName":"userId" - } - } - }, - "ListMessagesResponse":{ - "type":"structure", - "members":{ - "messages":{"shape":"Messages"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPluginsRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListPlugins", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListPluginsResponse":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"NextToken"}, - "plugins":{"shape":"Plugins"} - } - }, - "ListRetrieversRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListRetrieversRequest", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListRetrieversResponse":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"NextToken"}, - "retrievers":{"shape":"Retrievers"} - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceARN"], - "members":{ - "resourceARN":{ - "shape":"AmazonResourceName", - "location":"uri", - "locationName":"resourceARN" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{"shape":"Tags"} - } - }, - "ListWebExperiencesRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "maxResults":{ - "shape":"MaxResultsIntegerForListWebExperiencesRequest", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListWebExperiencesResponse":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"NextToken"}, - "webExperiences":{"shape":"WebExperiences"} - } - }, - "Long":{ - "type":"long", - "box":true - }, - "MaxResultsIntegerForGetTopicConfigurations":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxResultsIntegerForListApplications":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxResultsIntegerForListConversations":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxResultsIntegerForListDataSources":{ - "type":"integer", - "box":true, - "max":10, - "min":1 - }, - "MaxResultsIntegerForListDataSourcesSyncJobs":{ - "type":"integer", - "box":true, - "max":10, - "min":1 - }, - "MaxResultsIntegerForListDocuments":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxResultsIntegerForListGroupsRequest":{ - "type":"integer", - "box":true, - "max":10, - "min":1 - }, - "MaxResultsIntegerForListIndices":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxResultsIntegerForListMessages":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxResultsIntegerForListPlugins":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxResultsIntegerForListRetrieversRequest":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxResultsIntegerForListWebExperiencesRequest":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MemberGroup":{ - "type":"structure", - "required":["groupName"], - "members":{ - "groupName":{"shape":"GroupName"}, - "type":{"shape":"MembershipType"} - } - }, - "MemberGroups":{ - "type":"list", - "member":{"shape":"MemberGroup"}, - "max":1000, - "min":1 - }, - "MemberRelation":{ - "type":"string", - "enum":[ - "AND", - "OR" - ] - }, - "MemberUser":{ - "type":"structure", - "required":["userId"], - "members":{ - "type":{"shape":"MembershipType"}, - "userId":{"shape":"DataSourceUserId"} - } - }, - "MemberUsers":{ - "type":"list", - "member":{"shape":"MemberUser"}, - "max":1000, - "min":1 - }, - "MembershipType":{ - "type":"string", - "enum":[ - "INDEX", - "DATASOURCE" - ] - }, - "Message":{ - "type":"structure", - "members":{ - "actionExecution":{"shape":"ActionExecution"}, - "actionReview":{"shape":"ActionReview"}, - "attachments":{"shape":"AttachmentsOutput"}, - "body":{"shape":"MessageBody"}, - "messageId":{"shape":"String"}, - "sourceAttribution":{"shape":"SourceAttributions"}, - "time":{"shape":"Timestamp"}, - "type":{"shape":"MessageType"} - } - }, - "MessageBody":{ - "type":"string", - "max":1000, - "min":0, - "pattern":"^\\P{C}*$}$" - }, - "MessageId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "MessageType":{ - "type":"string", - "enum":[ - "USER", - "SYSTEM" - ] - }, - "MessageUsefulness":{ - "type":"string", - "enum":[ - "USEFUL", - "NOT_USEFUL" - ] - }, - "MessageUsefulnessComment":{ - "type":"string", - "max":1000, - "min":0, - "pattern":"^\\P{C}*$" - }, - "MessageUsefulnessFeedback":{ - "type":"structure", - "required":[ - "submittedAt", - "usefulness" - ], - "members":{ - "comment":{"shape":"MessageUsefulnessComment"}, - "reason":{"shape":"MessageUsefulnessReason"}, - "submittedAt":{"shape":"Timestamp"}, - "usefulness":{"shape":"MessageUsefulness"} - } - }, - "MessageUsefulnessReason":{ - "type":"string", - "enum":[ - "NOT_FACTUALLY_CORRECT", - "HARMFUL_OR_UNSAFE", - "INCORRECT_OR_MISSING_SOURCES", - "NOT_HELPFUL", - "FACTUALLY_CORRECT", - "COMPLETE", - "RELEVANT_SOURCES", - "HELPFUL", - "NOT_BASED_ON_DOCUMENTS", - "NOT_COMPLETE", - "NOT_CONCISE", - "OTHER" - ] - }, - "Messages":{ - "type":"list", - "member":{"shape":"Message"} - }, - "MetricValue":{ - "type":"string", - "pattern":"^(([1-9][0-9]*)|0)$" - }, - "NativeIndexConfiguration":{ - "type":"structure", - "required":["indexId"], - "members":{ - "boostingOverride":{"shape":"DocumentAttributeBoostingOverrideMap"}, - "indexId":{"shape":"IndexId"} - } - }, - "NextToken":{ - "type":"string", - "max":800, - "min":1 - }, - "NumberAttributeBoostingConfiguration":{ - "type":"structure", - "required":["boostingLevel"], - "members":{ - "boostingLevel":{"shape":"DocumentAttributeBoostingLevel"}, - "boostingType":{"shape":"NumberAttributeBoostingType"} - } - }, - "NumberAttributeBoostingType":{ - "type":"string", - "enum":[ - "PRIORITIZE_LARGER_VALUES", - "PRIORITIZE_SMALLER_VALUES" - ] - }, - "OAuth2ClientCredentialConfiguration":{ - "type":"structure", - "required":[ - "roleArn", - "secretArn" - ], - "members":{ - "roleArn":{"shape":"RoleArn"}, - "secretArn":{"shape":"SecretArn"} - } - }, - "Plugin":{ - "type":"structure", - "members":{ - "createdAt":{"shape":"Timestamp"}, - "displayName":{"shape":"PluginName"}, - "pluginId":{"shape":"PluginId"}, - "serverUrl":{"shape":"Url"}, - "state":{"shape":"PluginState"}, - "type":{"shape":"PluginType"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "PluginArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "PluginAuthConfiguration":{ - "type":"structure", - "members":{ - "basicAuthConfiguration":{"shape":"BasicAuthConfiguration"}, - "oAuth2ClientCredentialConfiguration":{"shape":"OAuth2ClientCredentialConfiguration"} - }, - "union":true - }, - "PluginConfiguration":{ - "type":"structure", - "required":["pluginId"], - "members":{ - "pluginId":{"shape":"PluginId"} - } - }, - "PluginId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - }, - "PluginName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" - }, - "PluginState":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "PluginType":{ - "type":"string", - "enum":[ - "SERVICE_NOW", - "SALESFORCE", - "JIRA", - "ZENDESK" - ] - }, - "Plugins":{ - "type":"list", - "member":{"shape":"Plugin"} - }, - "Principal":{ - "type":"structure", - "members":{ - "group":{"shape":"PrincipalGroup"}, - "user":{"shape":"PrincipalUser"} - }, - "union":true - }, - "PrincipalGroup":{ - "type":"structure", - "required":["access"], - "members":{ - "access":{"shape":"ReadAccessType"}, - "membershipType":{"shape":"MembershipType"}, - "name":{"shape":"GroupName"} - } - }, - "PrincipalUser":{ - "type":"structure", - "required":["access"], - "members":{ - "access":{"shape":"ReadAccessType"}, - "id":{"shape":"UserId"}, - "membershipType":{"shape":"MembershipType"} - } - }, - "Principals":{ - "type":"list", - "member":{"shape":"Principal"} - }, - "PutFeedbackRequest":{ - "type":"structure", - "required":[ - "applicationId", - "conversationId", - "messageId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "conversationId":{ - "shape":"ConversationId", - "location":"uri", - "locationName":"conversationId" - }, - "messageCopiedAt":{"shape":"Timestamp"}, - "messageId":{ - "shape":"SystemMessageId", - "location":"uri", - "locationName":"messageId" - }, - "messageUsefulness":{"shape":"MessageUsefulnessFeedback"}, - "userId":{ - "shape":"UserId", - "location":"querystring", - "locationName":"userId" - } - } - }, - "PutGroupRequest":{ - "type":"structure", - "required":[ - "applicationId", - "groupMembers", - "groupName", - "indexId", - "type" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{"shape":"DataSourceId"}, - "groupMembers":{"shape":"GroupMembers"}, - "groupName":{"shape":"GroupName"}, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "type":{"shape":"MembershipType"} - } - }, - "PutGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "ReadAccessType":{ - "type":"string", - "enum":[ - "ALLOW", - "DENY" - ] - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"ErrorMessage"}, - "resourceId":{"shape":"String"}, - "resourceType":{"shape":"String"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResponseScope":{ - "type":"string", - "enum":[ - "ENTERPRISE_CONTENT_ONLY", - "EXTENDED_KNOWLEDGE_ENABLED" - ] - }, - "Retriever":{ - "type":"structure", - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "displayName":{"shape":"RetrieverName"}, - "retrieverId":{"shape":"RetrieverId"}, - "status":{"shape":"RetrieverStatus"}, - "type":{"shape":"RetrieverType"} - } - }, - "RetrieverArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "RetrieverConfiguration":{ - "type":"structure", - "members":{ - "kendraIndexConfiguration":{"shape":"KendraIndexConfiguration"}, - "nativeIndexConfiguration":{"shape":"NativeIndexConfiguration"} - }, - "union":true - }, - "RetrieverId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "RetrieverName":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" - }, - "RetrieverStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "FAILED" - ] - }, - "RetrieverType":{ - "type":"string", - "enum":[ - "NATIVE_INDEX", - "KENDRA_INDEX" - ] - }, - "Retrievers":{ - "type":"list", - "member":{"shape":"Retriever"} - }, - "RoleArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "Rule":{ - "type":"structure", - "required":["ruleType"], - "members":{ - "excludedUsersAndGroups":{"shape":"UsersAndGroups"}, - "includedUsersAndGroups":{"shape":"UsersAndGroups"}, - "ruleConfiguration":{"shape":"RuleConfiguration"}, - "ruleType":{"shape":"RuleType"} - } - }, - "RuleConfiguration":{ - "type":"structure", - "members":{ - "contentBlockerRule":{"shape":"ContentBlockerRule"}, - "contentRetrievalRule":{"shape":"ContentRetrievalRule"} - }, - "union":true - }, - "RuleType":{ - "type":"string", - "enum":[ - "CONTENT_BLOCKER_RULE", - "CONTENT_RETRIEVAL_RULE" - ] - }, - "Rules":{ - "type":"list", - "member":{"shape":"Rule"}, - "max":10, - "min":0 - }, - "S3":{ - "type":"structure", - "required":[ - "bucket", - "key" - ], - "members":{ - "bucket":{"shape":"S3BucketName"}, - "key":{"shape":"S3ObjectKey"} - } - }, - "S3BucketName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" - }, - "S3ObjectKey":{ - "type":"string", - "max":1024, - "min":1 - }, - "SamlAttribute":{ - "type":"string", - "max":256, - "min":1 - }, - "SamlConfiguration":{ - "type":"structure", - "required":[ - "metadataXML", - "roleArn", - "userIdAttribute" - ], - "members":{ - "metadataXML":{"shape":"SamlMetadataXML"}, - "roleArn":{"shape":"RoleArn"}, - "userGroupAttribute":{"shape":"SamlAttribute"}, - "userIdAttribute":{"shape":"SamlAttribute"} - } - }, - "SamlMetadataXML":{ - "type":"string", - "max":10000000, - "min":1000, - "pattern":"^.*$" - }, - "SecretArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "SecurityGroupId":{ - "type":"string", - "max":200, - "min":1, - "pattern":"^[-0-9a-zA-Z]+$" - }, - "SecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":10, - "min":1 - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"ErrorMessage"}, - "resourceId":{"shape":"String"}, - "resourceType":{"shape":"String"} - }, - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SourceAttribution":{ - "type":"structure", - "members":{ - "citationNumber":{"shape":"Integer"}, - "snippet":{"shape":"String"}, - "textMessageSegments":{"shape":"TextSegmentList"}, - "title":{"shape":"String"}, - "updatedAt":{"shape":"Timestamp"}, - "url":{"shape":"String"} - } - }, - "SourceAttributions":{ - "type":"list", - "member":{"shape":"SourceAttribution"} - }, - "StartDataSourceSyncJobRequest":{ - "type":"structure", - "required":[ - "applicationId", - "dataSourceId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"uri", - "locationName":"dataSourceId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "StartDataSourceSyncJobResponse":{ - "type":"structure", - "members":{ - "executionId":{"shape":"ExecutionId"} - } - }, - "Status":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "StopDataSourceSyncJobRequest":{ - "type":"structure", - "required":[ - "applicationId", - "dataSourceId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"uri", - "locationName":"dataSourceId" - }, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "StopDataSourceSyncJobResponse":{ - "type":"structure", - "members":{ - } - }, - "String":{ - "type":"string", - "max":2048, - "min":1 - }, - "StringAttributeBoostingConfiguration":{ - "type":"structure", - "required":["boostingLevel"], - "members":{ - "attributeValueBoosting":{"shape":"StringAttributeValueBoosting"}, - "boostingLevel":{"shape":"DocumentAttributeBoostingLevel"} - } - }, - "StringAttributeValueBoosting":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"StringAttributeValueBoostingLevel"}, - "max":10, - "min":1 - }, - "StringAttributeValueBoostingLevel":{ - "type":"string", - "enum":[ - "LOW", - "MEDIUM", - "HIGH", - "VERY_HIGH" - ] - }, - "StringListAttributeBoostingConfiguration":{ - "type":"structure", - "required":["boostingLevel"], - "members":{ - "boostingLevel":{"shape":"DocumentAttributeBoostingLevel"} - } - }, - "SubnetId":{ - "type":"string", - "max":200, - "min":1, - "pattern":"^[-0-9a-zA-Z]+$" - }, - "SubnetIds":{ - "type":"list", - "member":{"shape":"SubnetId"} - }, - "SyncSchedule":{ - "type":"string", - "max":998, - "min":0, - "pattern":"^\\P{C}*$" - }, - "SystemMessageId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" - }, - "SystemMessageOverride":{ - "type":"string", - "max":350, - "min":0, - "pattern":"^\\P{C}*$" - }, - "Tag":{ - "type":"structure", - "required":[ - "key", - "value" - ], - "members":{ - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"} - } - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TagKeys":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceARN", - "tags" - ], - "members":{ - "resourceARN":{ - "shape":"AmazonResourceName", - "location":"uri", - "locationName":"resourceARN" - }, - "tags":{"shape":"Tags"} - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0 - }, - "Tags":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":200, - "min":0 - }, - "TextDocumentStatistics":{ - "type":"structure", - "members":{ - "indexedTextBytes":{"shape":"IndexedTextBytes"}, - "indexedTextDocumentCount":{"shape":"IndexedTextDocument"} - } - }, - "TextSegment":{ - "type":"structure", - "members":{ - "beginOffset":{"shape":"Integer"}, - "endOffset":{"shape":"Integer"} - } - }, - "TextSegmentList":{ - "type":"list", - "member":{"shape":"TextSegment"} - }, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "Timestamp":{"type":"timestamp"}, - "Title":{ - "type":"string", - "max":1024, - "min":1 - }, - "TopicConfiguration":{ - "type":"structure", - "required":[ - "name", - "rules" - ], - "members":{ - "description":{"shape":"TopicDescription"}, - "exampleChatMessages":{"shape":"ExampleChatMessages"}, - "name":{"shape":"TopicConfigurationName"}, - "rules":{"shape":"Rules"} - } - }, - "TopicConfigurationName":{ - "type":"string", - "max":36, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{0,35}$" - }, - "TopicConfigurations":{ - "type":"list", - "member":{"shape":"TopicConfiguration"}, - "max":10, - "min":0 - }, - "TopicDescription":{ - "type":"string", - "max":350, - "min":0, - "pattern":"^\\P{C}*$" - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceARN", - "tagKeys" - ], - "members":{ - "resourceARN":{ - "shape":"AmazonResourceName", - "location":"uri", - "locationName":"resourceARN" - }, - "tagKeys":{ - "shape":"TagKeys", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "attachmentsConfiguration":{"shape":"AttachmentsConfiguration"}, - "description":{"shape":"Description"}, - "displayName":{"shape":"ApplicationName"}, - "roleArn":{"shape":"RoleArn"} - } - }, - "UpdateApplicationResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateChatControlsConfigurationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "blockedPhrasesConfigurationUpdate":{"shape":"BlockedPhrasesConfigurationUpdate"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "creatorModeConfiguration":{"shape":"CreatorModeConfiguration"}, - "responseScope":{"shape":"ResponseScope"}, - "topicConfigurationsToCreateOrUpdate":{"shape":"TopicConfigurations"}, - "topicConfigurationsToDelete":{"shape":"TopicConfigurations"} - } - }, - "UpdateChatControlsConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateDataSourceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "dataSourceId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "configuration":{"shape":"DataSourceConfiguration"}, - "dataSourceId":{ - "shape":"DataSourceId", - "location":"uri", - "locationName":"dataSourceId" - }, - "description":{"shape":"Description"}, - "displayName":{"shape":"DataSourceName"}, - "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - }, - "roleArn":{"shape":"RoleArn"}, - "syncSchedule":{"shape":"SyncSchedule"}, - "vpcConfiguration":{"shape":"DataSourceVpcConfiguration"} - } - }, - "UpdateDataSourceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateIndexRequest":{ - "type":"structure", - "required":[ - "applicationId", - "indexId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "capacityConfiguration":{"shape":"IndexCapacityConfiguration"}, - "description":{"shape":"Description"}, - "displayName":{"shape":"ApplicationName"}, - "documentAttributeConfigurations":{"shape":"DocumentAttributeConfigurations"}, - "indexId":{ - "shape":"IndexId", - "location":"uri", - "locationName":"indexId" - } - } - }, - "UpdateIndexResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdatePluginRequest":{ - "type":"structure", - "required":[ - "applicationId", - "pluginId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "authConfiguration":{"shape":"PluginAuthConfiguration"}, - "displayName":{"shape":"PluginName"}, - "pluginId":{ - "shape":"PluginId", - "location":"uri", - "locationName":"pluginId" - }, - "serverUrl":{"shape":"Url"}, - "state":{"shape":"PluginState"} - } - }, - "UpdatePluginResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateRetrieverRequest":{ - "type":"structure", - "required":[ - "applicationId", - "retrieverId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "configuration":{"shape":"RetrieverConfiguration"}, - "displayName":{"shape":"RetrieverName"}, - "retrieverId":{ - "shape":"RetrieverId", - "location":"uri", - "locationName":"retrieverId" - }, - "roleArn":{"shape":"RoleArn"} - } - }, - "UpdateRetrieverResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateUserRequest":{ - "type":"structure", - "required":[ - "applicationId", - "userId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "userAliasesToDelete":{"shape":"UserAliases"}, - "userAliasesToUpdate":{"shape":"UserAliases"}, - "userId":{ - "shape":"String", - "location":"uri", - "locationName":"userId" + "shapes": { + "APISchema": { + "type": "structure", + "members": { + "payload": { + "shape": "Payload" + }, + "s3": { + "shape": "S3" + } + }, + "union": true + }, + "APISchemaType": { + "type": "string", + "enum": [ + "OPEN_API_V3" + ] + }, + "AccessConfiguration": { + "type": "structure", + "required": [ + "accessControls" + ], + "members": { + "accessControls": { + "shape": "AccessControls" + }, + "memberRelation": { + "shape": "MemberRelation" + } + } + }, + "AccessControl": { + "type": "structure", + "required": [ + "principals" + ], + "members": { + "principals": { + "shape": "Principals" + }, + "memberRelation": { + "shape": "MemberRelation" + } + } + }, + "AccessControls": { + "type": "list", + "member": { + "shape": "AccessControl" + } + }, + "AccessDeniedException": { + "type": "structure", + "required": [ + "message" + ], + "members": { + "message": { + "shape": "ErrorMessage" + } + }, + "error": { + "httpStatusCode": 403, + "senderFault": true + }, + "exception": true + }, + "ActionExecution": { + "type": "structure", + "required": [ + "pluginId", + "payload", + "payloadFieldNameSeparator" + ], + "members": { + "pluginId": { + "shape": "PluginId" + }, + "payload": { + "shape": "ActionExecutionPayload" + }, + "payloadFieldNameSeparator": { + "shape": "ActionPayloadFieldNameSeparator" + } + } + }, + "ActionExecutionEvent": { + "type": "structure", + "required": [ + "pluginId", + "payload", + "payloadFieldNameSeparator" + ], + "members": { + "pluginId": { + "shape": "PluginId" + }, + "payload": { + "shape": "ActionExecutionPayload" + }, + "payloadFieldNameSeparator": { + "shape": "ActionPayloadFieldNameSeparator" + } + }, + "event": true + }, + "ActionExecutionPayload": { + "type": "map", + "key": { + "shape": "ActionPayloadFieldKey" + }, + "value": { + "shape": "ActionExecutionPayloadField" + } + }, + "ActionExecutionPayloadField": { + "type": "structure", + "required": [ + "value" + ], + "members": { + "value": { + "shape": "ActionPayloadFieldValue" + } + } + }, + "ActionPayloadFieldKey": { + "type": "string", + "min": 1 + }, + "ActionPayloadFieldNameSeparator": { + "type": "string", + "max": 1, + "min": 1 + }, + "ActionPayloadFieldType": { + "type": "string", + "enum": [ + "STRING", + "NUMBER", + "ARRAY", + "BOOLEAN" + ] + }, + "ActionPayloadFieldValue": { + "type": "structure", + "members": [], + "document": true + }, + "ActionReview": { + "type": "structure", + "members": { + "pluginId": { + "shape": "PluginId" + }, + "pluginType": { + "shape": "PluginType" + }, + "payload": { + "shape": "ActionReviewPayload" + }, + "payloadFieldNameSeparator": { + "shape": "ActionPayloadFieldNameSeparator" + } + } + }, + "ActionReviewEvent": { + "type": "structure", + "members": { + "conversationId": { + "shape": "ConversationId" + }, + "userMessageId": { + "shape": "MessageId" + }, + "systemMessageId": { + "shape": "MessageId" + }, + "pluginId": { + "shape": "PluginId" + }, + "pluginType": { + "shape": "PluginType" + }, + "payload": { + "shape": "ActionReviewPayload" + }, + "payloadFieldNameSeparator": { + "shape": "ActionPayloadFieldNameSeparator" + } + }, + "event": true + }, + "ActionReviewPayload": { + "type": "map", + "key": { + "shape": "ActionPayloadFieldKey" + }, + "value": { + "shape": "ActionReviewPayloadField" + } + }, + "ActionReviewPayloadField": { + "type": "structure", + "members": { + "displayName": { + "shape": "String" + }, + "displayOrder": { + "shape": "Integer" + }, + "displayDescription": { + "shape": "String" + }, + "type": { + "shape": "ActionPayloadFieldType" + }, + "value": { + "shape": "ActionPayloadFieldValue" + }, + "allowedValues": { + "shape": "ActionReviewPayloadFieldAllowedValues" + }, + "allowedFormat": { + "shape": "String" + }, + "required": { + "shape": "Boolean" + } + } + }, + "ActionReviewPayloadFieldAllowedValue": { + "type": "structure", + "members": { + "value": { + "shape": "ActionPayloadFieldValue" + }, + "displayValue": { + "shape": "ActionPayloadFieldValue" + } + } + }, + "ActionReviewPayloadFieldAllowedValues": { + "type": "list", + "member": { + "shape": "ActionReviewPayloadFieldAllowedValue" + } + }, + "AmazonResourceName": { + "type": "string", + "max": 1011, + "min": 1 + }, + "Application": { + "type": "structure", + "members": { + "displayName": { + "shape": "ApplicationName" + }, + "applicationId": { + "shape": "ApplicationId" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "status": { + "shape": "ApplicationStatus" + } + } + }, + "ApplicationArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "ApplicationId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "ApplicationName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "ApplicationStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ] + }, + "Applications": { + "type": "list", + "member": { + "shape": "Application" + } + }, + "AppliedAttachmentsConfiguration": { + "type": "structure", + "members": { + "attachmentsControlMode": { + "shape": "AttachmentsControlMode" + } + } + }, + "AppliedCreatorModeConfiguration": { + "type": "structure", + "required": [ + "creatorModeControl" + ], + "members": { + "creatorModeControl": { + "shape": "CreatorModeControl" + } + } + }, + "AttachmentInput": { + "type": "structure", + "required": [ + "name", + "data" + ], + "members": { + "name": { + "shape": "AttachmentName" + }, + "data": { + "shape": "Blob" + } + } + }, + "AttachmentInputEvent": { + "type": "structure", + "members": { + "attachment": { + "shape": "AttachmentInput" + } + }, + "event": true + }, + "AttachmentName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "\\P{C}*" + }, + "AttachmentOutput": { + "type": "structure", + "members": { + "name": { + "shape": "AttachmentName" + }, + "status": { + "shape": "AttachmentStatus" + }, + "error": { + "shape": "ErrorDetail" + } + } + }, + "AttachmentStatus": { + "type": "string", + "enum": [ + "FAILED", + "SUCCEEDED" + ] + }, + "AttachmentsConfiguration": { + "type": "structure", + "required": [ + "attachmentsControlMode" + ], + "members": { + "attachmentsControlMode": { + "shape": "AttachmentsControlMode" + } + } + }, + "AttachmentsControlMode": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "AttachmentsInput": { + "type": "list", + "member": { + "shape": "AttachmentInput" + }, + "min": 1 + }, + "AttachmentsOutput": { + "type": "list", + "member": { + "shape": "AttachmentOutput" + } + }, + "AttributeFilter": { + "type": "structure", + "members": { + "andAllFilters": { + "shape": "AttributeFilters" + }, + "orAllFilters": { + "shape": "AttributeFilters" + }, + "notFilter": { + "shape": "AttributeFilter" + }, + "equalsTo": { + "shape": "DocumentAttribute" + }, + "containsAll": { + "shape": "DocumentAttribute" + }, + "containsAny": { + "shape": "DocumentAttribute" + }, + "greaterThan": { + "shape": "DocumentAttribute" + }, + "greaterThanOrEquals": { + "shape": "DocumentAttribute" + }, + "lessThan": { + "shape": "DocumentAttribute" + }, + "lessThanOrEquals": { + "shape": "DocumentAttribute" + } + } + }, + "AttributeFilters": { + "type": "list", + "member": { + "shape": "AttributeFilter" + } + }, + "AttributeType": { + "type": "string", + "enum": [ + "STRING", + "STRING_LIST", + "NUMBER", + "DATE" + ] + }, + "AttributeValueOperator": { + "type": "string", + "enum": [ + "DELETE" + ] + }, + "AuthChallengeRequest": { + "type": "structure", + "required": [ + "authorizationUrl" + ], + "members": { + "authorizationUrl": { + "shape": "Url" + } + } + }, + "AuthChallengeRequestEvent": { + "type": "structure", + "required": [ + "authorizationUrl" + ], + "members": { + "authorizationUrl": { + "shape": "Url" + } + }, + "event": true + }, + "AuthChallengeResponse": { + "type": "structure", + "required": [ + "responseMap" + ], + "members": { + "responseMap": { + "shape": "AuthorizationResponseMap" + } + } + }, + "AuthChallengeResponseEvent": { + "type": "structure", + "required": [ + "responseMap" + ], + "members": { + "responseMap": { + "shape": "AuthorizationResponseMap" + } + }, + "event": true + }, + "AuthResponseKey": { + "type": "string", + "max": 100, + "min": 1 + }, + "AuthResponseValue": { + "type": "string", + "max": 2048, + "min": 1 + }, + "AuthorizationResponseMap": { + "type": "map", + "key": { + "shape": "AuthResponseKey" + }, + "value": { + "shape": "AuthResponseValue" + } + }, + "BasicAuthConfiguration": { + "type": "structure", + "required": [ + "secretArn", + "roleArn" + ], + "members": { + "secretArn": { + "shape": "SecretArn" + }, + "roleArn": { + "shape": "RoleArn" + } + } + }, + "BatchDeleteDocumentRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "documents" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "documents": { + "shape": "DeleteDocuments" + }, + "dataSourceSyncId": { + "shape": "ExecutionId" + } + } + }, + "BatchDeleteDocumentResponse": { + "type": "structure", + "members": { + "failedDocuments": { + "shape": "FailedDocuments" + } + } + }, + "BatchPutDocumentRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "documents" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "documents": { + "shape": "Documents" + }, + "roleArn": { + "shape": "RoleArn" + }, + "dataSourceSyncId": { + "shape": "ExecutionId" + } + } + }, + "BatchPutDocumentResponse": { + "type": "structure", + "members": { + "failedDocuments": { + "shape": "FailedDocuments" + } + } + }, + "Blob": { + "type": "blob" + }, + "BlockedPhrase": { + "type": "string", + "max": 36, + "min": 0, + "pattern": "\\P{C}*" + }, + "BlockedPhrases": { + "type": "list", + "member": { + "shape": "BlockedPhrase" + }, + "max": 5, + "min": 0 + }, + "BlockedPhrasesConfiguration": { + "type": "structure", + "members": { + "blockedPhrases": { + "shape": "BlockedPhrases" + }, + "systemMessageOverride": { + "shape": "SystemMessageOverride" + } + } + }, + "BlockedPhrasesConfigurationUpdate": { + "type": "structure", + "members": { + "blockedPhrasesToCreateOrUpdate": { + "shape": "BlockedPhrases" + }, + "blockedPhrasesToDelete": { + "shape": "BlockedPhrases" + }, + "systemMessageOverride": { + "shape": "SystemMessageOverride" + } + } + }, + "Boolean": { + "type": "boolean", + "box": true + }, + "BoostingDurationInSeconds": { + "type": "long", + "box": true, + "max": 999999999, + "min": 0 + }, + "ChatInput": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "UserId", + "location": "querystring", + "locationName": "userId" + }, + "userGroups": { + "shape": "UserGroups", + "location": "querystring", + "locationName": "userGroups" + }, + "conversationId": { + "shape": "ConversationId", + "location": "querystring", + "locationName": "conversationId" + }, + "parentMessageId": { + "shape": "MessageId", + "location": "querystring", + "locationName": "parentMessageId" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + }, + "inputStream": { + "shape": "ChatInputStream" + } + }, + "payload": "inputStream" + }, + "ChatInputStream": { + "type": "structure", + "members": { + "configurationEvent": { + "shape": "ConfigurationEvent" + }, + "textEvent": { + "shape": "TextInputEvent" + }, + "attachmentEvent": { + "shape": "AttachmentInputEvent" + }, + "actionExecutionEvent": { + "shape": "ActionExecutionEvent" + }, + "endOfInputEvent": { + "shape": "EndOfInputEvent" + }, + "authChallengeResponseEvent": { + "shape": "AuthChallengeResponseEvent" + } + }, + "eventstream": true + }, + "ChatMode": { + "type": "string", + "enum": [ + "RETRIEVAL_MODE", + "CREATOR_MODE", + "PLUGIN_MODE" + ] + }, + "ChatModeConfiguration": { + "type": "structure", + "members": { + "pluginConfiguration": { + "shape": "PluginConfiguration" + } + }, + "union": true + }, + "ChatOutput": { + "type": "structure", + "members": { + "outputStream": { + "shape": "ChatOutputStream" + } + }, + "payload": "outputStream" + }, + "ChatOutputStream": { + "type": "structure", + "members": { + "textEvent": { + "shape": "TextOutputEvent" + }, + "metadataEvent": { + "shape": "MetadataEvent" + }, + "actionReviewEvent": { + "shape": "ActionReviewEvent" + }, + "failedAttachmentEvent": { + "shape": "FailedAttachmentEvent" + }, + "authChallengeRequestEvent": { + "shape": "AuthChallengeRequestEvent" + } + }, + "eventstream": true + }, + "ChatSyncInput": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "UserId", + "location": "querystring", + "locationName": "userId" + }, + "userGroups": { + "shape": "UserGroups", + "location": "querystring", + "locationName": "userGroups" + }, + "userMessage": { + "shape": "UserMessage" + }, + "attachments": { + "shape": "AttachmentsInput" + }, + "actionExecution": { + "shape": "ActionExecution" + }, + "authChallengeResponse": { + "shape": "AuthChallengeResponse" + }, + "conversationId": { + "shape": "ConversationId" + }, + "parentMessageId": { + "shape": "MessageId" + }, + "attributeFilter": { + "shape": "AttributeFilter" + }, + "chatMode": { + "shape": "ChatMode" + }, + "chatModeConfiguration": { + "shape": "ChatModeConfiguration" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + } + } + }, + "ChatSyncOutput": { + "type": "structure", + "members": { + "conversationId": { + "shape": "ConversationId" + }, + "systemMessage": { + "shape": "String" + }, + "systemMessageId": { + "shape": "MessageId" + }, + "userMessageId": { + "shape": "MessageId" + }, + "actionReview": { + "shape": "ActionReview" + }, + "authChallengeRequest": { + "shape": "AuthChallengeRequest" + }, + "sourceAttributions": { + "shape": "SourceAttributions" + }, + "failedAttachments": { + "shape": "AttachmentsOutput" + } + } + }, + "ClientToken": { + "type": "string", + "max": 100, + "min": 1 + }, + "ConfigurationEvent": { + "type": "structure", + "members": { + "chatMode": { + "shape": "ChatMode" + }, + "chatModeConfiguration": { + "shape": "ChatModeConfiguration" + }, + "attributeFilter": { + "shape": "AttributeFilter" + } + }, + "event": true + }, + "ConflictException": { + "type": "structure", + "required": [ + "message", + "resourceId", + "resourceType" + ], + "members": { + "message": { + "shape": "ErrorMessage" + }, + "resourceId": { + "shape": "String" + }, + "resourceType": { + "shape": "String" + } + }, + "error": { + "httpStatusCode": 409, + "senderFault": true + }, + "exception": true + }, + "ContentBlockerRule": { + "type": "structure", + "members": { + "systemMessageOverride": { + "shape": "SystemMessageOverride" + } + } + }, + "ContentRetrievalRule": { + "type": "structure", + "members": { + "eligibleDataSources": { + "shape": "EligibleDataSources" + } + } + }, + "ContentType": { + "type": "string", + "enum": [ + "PDF", + "HTML", + "MS_WORD", + "PLAIN_TEXT", + "PPT", + "RTF", + "XML", + "XSLT", + "MS_EXCEL", + "CSV", + "JSON", + "MD" + ] + }, + "Conversation": { + "type": "structure", + "members": { + "conversationId": { + "shape": "ConversationId" + }, + "title": { + "shape": "ConversationTitle" + }, + "startTime": { + "shape": "Timestamp" + } + } + }, + "ConversationId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "ConversationTitle": { + "type": "string" + }, + "Conversations": { + "type": "list", + "member": { + "shape": "Conversation" + } + }, + "CreateApplicationRequest": { + "type": "structure", + "required": [ + "displayName" + ], + "members": { + "displayName": { + "shape": "ApplicationName" + }, + "roleArn": { + "shape": "RoleArn" + }, + "identityCenterInstanceArn": { + "shape": "InstanceArn" + }, + "description": { + "shape": "Description" + }, + "encryptionConfiguration": { + "shape": "EncryptionConfiguration" + }, + "tags": { + "shape": "Tags" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + }, + "attachmentsConfiguration": { + "shape": "AttachmentsConfiguration" + } + } + }, + "CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "applicationArn": { + "shape": "ApplicationArn" + } + } + }, + "CreateDataSourceRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "displayName", + "configuration" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "displayName": { + "shape": "DataSourceName" + }, + "configuration": { + "shape": "DataSourceConfiguration" + }, + "vpcConfiguration": { + "shape": "DataSourceVpcConfiguration" + }, + "description": { + "shape": "Description" + }, + "tags": { + "shape": "Tags" + }, + "syncSchedule": { + "shape": "SyncSchedule" + }, + "roleArn": { + "shape": "RoleArn" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + }, + "documentEnrichmentConfiguration": { + "shape": "DocumentEnrichmentConfiguration" + } + } + }, + "CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSourceId": { + "shape": "DataSourceId" + }, + "dataSourceArn": { + "shape": "DataSourceArn" + } + } + }, + "CreateIndexRequest": { + "type": "structure", + "required": [ + "applicationId", + "displayName" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "displayName": { + "shape": "IndexName" + }, + "type": { + "shape": "IndexType" + }, + "description": { + "shape": "Description" + }, + "tags": { + "shape": "Tags" + }, + "capacityConfiguration": { + "shape": "IndexCapacityConfiguration" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + } + } + }, + "CreateIndexResponse": { + "type": "structure", + "members": { + "indexId": { + "shape": "IndexId" + }, + "indexArn": { + "shape": "IndexArn" + } + } + }, + "CreatePluginRequest": { + "type": "structure", + "required": [ + "applicationId", + "displayName", + "type", + "authConfiguration" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "displayName": { + "shape": "PluginName" + }, + "type": { + "shape": "PluginType" + }, + "authConfiguration": { + "shape": "PluginAuthConfiguration" + }, + "serverUrl": { + "shape": "Url" + }, + "customPluginConfiguration": { + "shape": "CustomPluginConfiguration" + }, + "tags": { + "shape": "Tags" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + } + } + }, + "CreatePluginResponse": { + "type": "structure", + "members": { + "pluginId": { + "shape": "PluginId" + }, + "pluginArn": { + "shape": "PluginArn" + }, + "buildStatus": { + "shape": "PluginBuildStatus" + } + } + }, + "CreateRetrieverRequest": { + "type": "structure", + "required": [ + "applicationId", + "type", + "displayName", + "configuration" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "type": { + "shape": "RetrieverType" + }, + "displayName": { + "shape": "RetrieverName" + }, + "configuration": { + "shape": "RetrieverConfiguration" + }, + "roleArn": { + "shape": "RoleArn" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + }, + "tags": { + "shape": "Tags" + } + } + }, + "CreateRetrieverResponse": { + "type": "structure", + "members": { + "retrieverId": { + "shape": "RetrieverId" + }, + "retrieverArn": { + "shape": "RetrieverArn" + } + } + }, + "CreateUserRequest": { + "type": "structure", + "required": [ + "applicationId", + "userId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "String" + }, + "userAliases": { + "shape": "CreateUserRequestUserAliasesList" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + } + } + }, + "CreateUserRequestUserAliasesList": { + "type": "list", + "member": { + "shape": "UserAlias" + }, + "max": 100, + "min": 0 + }, + "CreateUserResponse": { + "type": "structure", + "members": [] + }, + "CreateWebExperienceRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "title": { + "shape": "WebExperienceTitle" + }, + "subtitle": { + "shape": "WebExperienceSubtitle" + }, + "welcomeMessage": { + "shape": "WebExperienceWelcomeMessage" + }, + "samplePromptsControlMode": { + "shape": "WebExperienceSamplePromptsControlMode" + }, + "roleArn": { + "shape": "RoleArn" + }, + "tags": { + "shape": "Tags" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + } + } + }, + "CreateWebExperienceResponse": { + "type": "structure", + "members": { + "webExperienceId": { + "shape": "WebExperienceId" + }, + "webExperienceArn": { + "shape": "WebExperienceArn" + } + } + }, + "CreatorModeConfiguration": { + "type": "structure", + "required": [ + "creatorModeControl" + ], + "members": { + "creatorModeControl": { + "shape": "CreatorModeControl" + } + } + }, + "CreatorModeControl": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "CustomPluginConfiguration": { + "type": "structure", + "required": [ + "description", + "apiSchemaType", + "apiSchema" + ], + "members": { + "description": { + "shape": "PluginDescription" + }, + "apiSchemaType": { + "shape": "APISchemaType" + }, + "apiSchema": { + "shape": "APISchema" + } + } + }, + "DataSource": { + "type": "structure", + "members": { + "displayName": { + "shape": "DataSourceName" + }, + "dataSourceId": { + "shape": "DataSourceId" + }, + "type": { + "shape": "String" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "status": { + "shape": "DataSourceStatus" + } + } + }, + "DataSourceArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "DataSourceConfiguration": { + "type": "structure", + "members": [], + "document": true + }, + "DataSourceId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "DataSourceIds": { + "type": "list", + "member": { + "shape": "DataSourceId" + }, + "max": 1, + "min": 1 + }, + "DataSourceName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "DataSourceStatus": { + "type": "string", + "enum": [ + "PENDING_CREATION", + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ] + }, + "DataSourceSyncJob": { + "type": "structure", + "members": { + "executionId": { + "shape": "ExecutionId" + }, + "startTime": { + "shape": "Timestamp" + }, + "endTime": { + "shape": "Timestamp" + }, + "status": { + "shape": "DataSourceSyncJobStatus" + }, + "error": { + "shape": "ErrorDetail" + }, + "dataSourceErrorCode": { + "shape": "String" + }, + "metrics": { + "shape": "DataSourceSyncJobMetrics" + } + } + }, + "DataSourceSyncJobMetrics": { + "type": "structure", + "members": { + "documentsAdded": { + "shape": "MetricValue" + }, + "documentsModified": { + "shape": "MetricValue" + }, + "documentsDeleted": { + "shape": "MetricValue" + }, + "documentsFailed": { + "shape": "MetricValue" + }, + "documentsScanned": { + "shape": "MetricValue" + } + } + }, + "DataSourceSyncJobStatus": { + "type": "string", + "enum": [ + "FAILED", + "SUCCEEDED", + "SYNCING", + "INCOMPLETE", + "STOPPING", + "ABORTED", + "SYNCING_INDEXING" + ] + }, + "DataSourceSyncJobs": { + "type": "list", + "member": { + "shape": "DataSourceSyncJob" + } + }, + "DataSourceUserId": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "\\P{C}*" + }, + "DataSourceVpcConfiguration": { + "type": "structure", + "required": [ + "subnetIds", + "securityGroupIds" + ], + "members": { + "subnetIds": { + "shape": "SubnetIds" + }, + "securityGroupIds": { + "shape": "SecurityGroupIds" + } + } + }, + "DataSources": { + "type": "list", + "member": { + "shape": "DataSource" + } + }, + "DateAttributeBoostingConfiguration": { + "type": "structure", + "required": [ + "boostingLevel" + ], + "members": { + "boostingLevel": { + "shape": "DocumentAttributeBoostingLevel" + }, + "boostingDurationInSeconds": { + "shape": "BoostingDurationInSeconds" + } + } + }, + "DeleteApplicationRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + } + } + }, + "DeleteApplicationResponse": { + "type": "structure", + "members": [] + }, + "DeleteChatControlsConfigurationRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + } + } + }, + "DeleteChatControlsConfigurationResponse": { + "type": "structure", + "members": [] + }, + "DeleteConversationRequest": { + "type": "structure", + "required": [ + "conversationId", + "applicationId" + ], + "members": { + "conversationId": { + "shape": "ConversationId", + "location": "uri", + "locationName": "conversationId" + }, + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "UserId", + "location": "querystring", + "locationName": "userId" + } + } + }, + "DeleteConversationResponse": { + "type": "structure", + "members": [] + }, + "DeleteDataSourceRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "dataSourceId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "dataSourceId": { + "shape": "DataSourceId", + "location": "uri", + "locationName": "dataSourceId" + } + } + }, + "DeleteDataSourceResponse": { + "type": "structure", + "members": [] + }, + "DeleteDocument": { + "type": "structure", + "required": [ + "documentId" + ], + "members": { + "documentId": { + "shape": "DocumentId" + } + } + }, + "DeleteDocuments": { + "type": "list", + "member": { + "shape": "DeleteDocument" + } + }, + "DeleteGroupRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "groupName" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "groupName": { + "shape": "GroupName", + "location": "uri", + "locationName": "groupName" + }, + "dataSourceId": { + "shape": "DataSourceId", + "location": "querystring", + "locationName": "dataSourceId" + } + } + }, + "DeleteGroupResponse": { + "type": "structure", + "members": [] + }, + "DeleteIndexRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + } + } + }, + "DeleteIndexResponse": { + "type": "structure", + "members": [] + }, + "DeletePluginRequest": { + "type": "structure", + "required": [ + "applicationId", + "pluginId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "pluginId": { + "shape": "PluginId", + "location": "uri", + "locationName": "pluginId" + } + } + }, + "DeletePluginResponse": { + "type": "structure", + "members": [] + }, + "DeleteRetrieverRequest": { + "type": "structure", + "required": [ + "applicationId", + "retrieverId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "retrieverId": { + "shape": "RetrieverId", + "location": "uri", + "locationName": "retrieverId" + } + } + }, + "DeleteRetrieverResponse": { + "type": "structure", + "members": [] + }, + "DeleteUserRequest": { + "type": "structure", + "required": [ + "applicationId", + "userId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "String", + "location": "uri", + "locationName": "userId" + } + } + }, + "DeleteUserResponse": { + "type": "structure", + "members": [] + }, + "DeleteWebExperienceRequest": { + "type": "structure", + "required": [ + "applicationId", + "webExperienceId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "webExperienceId": { + "shape": "WebExperienceId", + "location": "uri", + "locationName": "webExperienceId" + } + } + }, + "DeleteWebExperienceResponse": { + "type": "structure", + "members": [] + }, + "Description": { + "type": "string", + "max": 1000, + "min": 0, + "pattern": "\\P{C}*" + }, + "Document": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": { + "shape": "DocumentId" + }, + "attributes": { + "shape": "DocumentAttributes" + }, + "content": { + "shape": "DocumentContent" + }, + "contentType": { + "shape": "ContentType" + }, + "title": { + "shape": "Title" + }, + "accessConfiguration": { + "shape": "AccessConfiguration" + }, + "documentEnrichmentConfiguration": { + "shape": "DocumentEnrichmentConfiguration" + } + } + }, + "DocumentAttribute": { + "type": "structure", + "required": [ + "name", + "value" + ], + "members": { + "name": { + "shape": "DocumentAttributeKey" + }, + "value": { + "shape": "DocumentAttributeValue" + } + } + }, + "DocumentAttributeBoostingConfiguration": { + "type": "structure", + "members": { + "numberConfiguration": { + "shape": "NumberAttributeBoostingConfiguration" + }, + "stringConfiguration": { + "shape": "StringAttributeBoostingConfiguration" + }, + "dateConfiguration": { + "shape": "DateAttributeBoostingConfiguration" + }, + "stringListConfiguration": { + "shape": "StringListAttributeBoostingConfiguration" + } + }, + "union": true + }, + "DocumentAttributeBoostingLevel": { + "type": "string", + "enum": [ + "NONE", + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ] + }, + "DocumentAttributeBoostingOverrideMap": { + "type": "map", + "key": { + "shape": "DocumentAttributeKey" + }, + "value": { + "shape": "DocumentAttributeBoostingConfiguration" + }, + "min": 1 + }, + "DocumentAttributeCondition": { + "type": "structure", + "required": [ + "key", + "operator" + ], + "members": { + "key": { + "shape": "DocumentAttributeKey" + }, + "operator": { + "shape": "DocumentEnrichmentConditionOperator" + }, + "value": { + "shape": "DocumentAttributeValue" + } + } + }, + "DocumentAttributeConfiguration": { + "type": "structure", + "members": { + "name": { + "shape": "DocumentMetadataConfigurationName" + }, + "type": { + "shape": "AttributeType" + }, + "search": { + "shape": "Status" + } + } + }, + "DocumentAttributeConfigurations": { + "type": "list", + "member": { + "shape": "DocumentAttributeConfiguration" + }, + "max": 500, + "min": 1 + }, + "DocumentAttributeKey": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "[a-zA-Z0-9_][a-zA-Z0-9_-]*" + }, + "DocumentAttributeStringListValue": { + "type": "list", + "member": { + "shape": "String" + } + }, + "DocumentAttributeTarget": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": { + "shape": "DocumentAttributeKey" + }, + "value": { + "shape": "DocumentAttributeValue" + }, + "attributeValueOperator": { + "shape": "AttributeValueOperator" + } + } + }, + "DocumentAttributeValue": { + "type": "structure", + "members": { + "stringValue": { + "shape": "DocumentAttributeValueStringValueString" + }, + "stringListValue": { + "shape": "DocumentAttributeStringListValue" + }, + "longValue": { + "shape": "Long" + }, + "dateValue": { + "shape": "Timestamp" + } + }, + "union": true + }, + "DocumentAttributeValueStringValueString": { + "type": "string", + "max": 2048, + "min": 0 + }, + "DocumentAttributes": { + "type": "list", + "member": { + "shape": "DocumentAttribute" + }, + "max": 500, + "min": 1 + }, + "DocumentContent": { + "type": "structure", + "members": { + "blob": { + "shape": "Blob" + }, + "s3": { + "shape": "S3" + } + }, + "union": true + }, + "DocumentContentOperator": { + "type": "string", + "enum": [ + "DELETE" + ] + }, + "DocumentDetailList": { + "type": "list", + "member": { + "shape": "DocumentDetails" + } + }, + "DocumentDetails": { + "type": "structure", + "members": { + "documentId": { + "shape": "DocumentId" + }, + "status": { + "shape": "DocumentStatus" + }, + "error": { + "shape": "ErrorDetail" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + } + } + }, + "DocumentEnrichmentConditionOperator": { + "type": "string", + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUALS", + "LESS_THAN", + "LESS_THAN_OR_EQUALS", + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "EXISTS", + "NOT_EXISTS", + "BEGINS_WITH" + ] + }, + "DocumentEnrichmentConfiguration": { + "type": "structure", + "members": { + "inlineConfigurations": { + "shape": "InlineDocumentEnrichmentConfigurations" + }, + "preExtractionHookConfiguration": { + "shape": "HookConfiguration" + }, + "postExtractionHookConfiguration": { + "shape": "HookConfiguration" + } + } + }, + "DocumentId": { + "type": "string", + "max": 1825, + "min": 1, + "pattern": "\\P{C}*" + }, + "DocumentMetadataConfigurationName": { + "type": "string", + "max": 30, + "min": 1, + "pattern": "[a-zA-Z0-9_][a-zA-Z0-9_-]*" + }, + "DocumentStatus": { + "type": "string", + "enum": [ + "RECEIVED", + "PROCESSING", + "INDEXED", + "UPDATED", + "FAILED", + "DELETING", + "DELETED", + "DOCUMENT_FAILED_TO_INDEX" + ] + }, + "Documents": { + "type": "list", + "member": { + "shape": "Document" + }, + "max": 10, + "min": 1 + }, + "EligibleDataSource": { + "type": "structure", + "members": { + "indexId": { + "shape": "IndexId" + }, + "dataSourceId": { + "shape": "DataSourceId" + } + } + }, + "EligibleDataSources": { + "type": "list", + "member": { + "shape": "EligibleDataSource" + }, + "max": 5, + "min": 0 + }, + "EncryptionConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "shape": "KmsKeyId" + } + } + }, + "EndOfInputEvent": { + "type": "structure", + "members": [], + "event": true + }, + "ErrorCode": { + "type": "string", + "enum": [ + "InternalError", + "InvalidRequest", + "ResourceInactive", + "ResourceNotFound" + ] + }, + "ErrorDetail": { + "type": "structure", + "members": { + "errorMessage": { + "shape": "ErrorMessage" + }, + "errorCode": { + "shape": "ErrorCode" + } + } + }, + "ErrorMessage": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "\\P{C}*" + }, + "ExampleChatMessage": { + "type": "string", + "max": 350, + "min": 0, + "pattern": "\\P{C}*" + }, + "ExampleChatMessages": { + "type": "list", + "member": { + "shape": "ExampleChatMessage" + }, + "max": 5, + "min": 0 + }, + "ExecutionId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "FailedAttachmentEvent": { + "type": "structure", + "members": { + "conversationId": { + "shape": "ConversationId" + }, + "userMessageId": { + "shape": "MessageId" + }, + "systemMessageId": { + "shape": "MessageId" + }, + "attachment": { + "shape": "AttachmentOutput" + } + }, + "event": true + }, + "FailedDocument": { + "type": "structure", + "members": { + "id": { + "shape": "DocumentId" + }, + "error": { + "shape": "ErrorDetail" + }, + "dataSourceId": { + "shape": "DataSourceId" + } + } + }, + "FailedDocuments": { + "type": "list", + "member": { + "shape": "FailedDocument" + } + }, + "GetApplicationRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + } + } + }, + "GetApplicationResponse": { + "type": "structure", + "members": { + "displayName": { + "shape": "ApplicationName" + }, + "applicationId": { + "shape": "ApplicationId" + }, + "applicationArn": { + "shape": "ApplicationArn" + }, + "identityCenterApplicationArn": { + "shape": "IdcApplicationArn" + }, + "roleArn": { + "shape": "RoleArn" + }, + "status": { + "shape": "ApplicationStatus" + }, + "description": { + "shape": "Description" + }, + "encryptionConfiguration": { + "shape": "EncryptionConfiguration" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "error": { + "shape": "ErrorDetail" + }, + "attachmentsConfiguration": { + "shape": "AppliedAttachmentsConfiguration" + } + } + }, + "GetChatControlsConfigurationRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "maxResults": { + "shape": "MaxResultsIntegerForGetTopicConfigurations", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetChatControlsConfigurationResponse": { + "type": "structure", + "members": { + "responseScope": { + "shape": "ResponseScope" + }, + "blockedPhrases": { + "shape": "BlockedPhrasesConfiguration" + }, + "topicConfigurations": { + "shape": "TopicConfigurations" + }, + "creatorModeConfiguration": { + "shape": "AppliedCreatorModeConfiguration" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "GetDataSourceRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "dataSourceId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "dataSourceId": { + "shape": "DataSourceId", + "location": "uri", + "locationName": "dataSourceId" + } + } + }, + "GetDataSourceResponse": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "indexId": { + "shape": "IndexId" + }, + "dataSourceId": { + "shape": "DataSourceId" + }, + "dataSourceArn": { + "shape": "DataSourceArn" + }, + "displayName": { + "shape": "DataSourceName" + }, + "type": { + "shape": "String" + }, + "configuration": { + "shape": "DataSourceConfiguration" + }, + "vpcConfiguration": { + "shape": "DataSourceVpcConfiguration" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "description": { + "shape": "Description" + }, + "status": { + "shape": "DataSourceStatus" + }, + "syncSchedule": { + "shape": "SyncSchedule" + }, + "roleArn": { + "shape": "RoleArn" + }, + "error": { + "shape": "ErrorDetail" + }, + "documentEnrichmentConfiguration": { + "shape": "DocumentEnrichmentConfiguration" + } + } + }, + "GetGroupRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "groupName" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "groupName": { + "shape": "GroupName", + "location": "uri", + "locationName": "groupName" + }, + "dataSourceId": { + "shape": "DataSourceId", + "location": "querystring", + "locationName": "dataSourceId" + } + } + }, + "GetGroupResponse": { + "type": "structure", + "members": { + "status": { + "shape": "GroupStatusDetail" + }, + "statusHistory": { + "shape": "GroupStatusDetails" + } + } + }, + "GetIndexRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + } + } + }, + "GetIndexResponse": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "indexId": { + "shape": "IndexId" + }, + "displayName": { + "shape": "IndexName" + }, + "type": { + "shape": "IndexType" + }, + "indexArn": { + "shape": "IndexArn" + }, + "status": { + "shape": "IndexStatus" + }, + "description": { + "shape": "Description" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "capacityConfiguration": { + "shape": "IndexCapacityConfiguration" + }, + "documentAttributeConfigurations": { + "shape": "DocumentAttributeConfigurations" + }, + "error": { + "shape": "ErrorDetail" + }, + "indexStatistics": { + "shape": "IndexStatistics" + } + } + }, + "GetPluginRequest": { + "type": "structure", + "required": [ + "applicationId", + "pluginId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "pluginId": { + "shape": "PluginId", + "location": "uri", + "locationName": "pluginId" + } + } + }, + "GetPluginResponse": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "pluginId": { + "shape": "PluginId" + }, + "displayName": { + "shape": "PluginName" + }, + "type": { + "shape": "PluginType" + }, + "serverUrl": { + "shape": "Url" + }, + "authConfiguration": { + "shape": "PluginAuthConfiguration" + }, + "customPluginConfiguration": { + "shape": "CustomPluginConfiguration" + }, + "buildStatus": { + "shape": "PluginBuildStatus" + }, + "pluginArn": { + "shape": "PluginArn" + }, + "state": { + "shape": "PluginState" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + } + } + }, + "GetRetrieverRequest": { + "type": "structure", + "required": [ + "applicationId", + "retrieverId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "retrieverId": { + "shape": "RetrieverId", + "location": "uri", + "locationName": "retrieverId" + } + } + }, + "GetRetrieverResponse": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "retrieverId": { + "shape": "RetrieverId" + }, + "retrieverArn": { + "shape": "RetrieverArn" + }, + "type": { + "shape": "RetrieverType" + }, + "status": { + "shape": "RetrieverStatus" + }, + "displayName": { + "shape": "RetrieverName" + }, + "configuration": { + "shape": "RetrieverConfiguration" + }, + "roleArn": { + "shape": "RoleArn" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + } + } + }, + "GetUserRequest": { + "type": "structure", + "required": [ + "applicationId", + "userId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "String", + "location": "uri", + "locationName": "userId" + } + } + }, + "GetUserResponse": { + "type": "structure", + "members": { + "userAliases": { + "shape": "UserAliases" + } + } + }, + "GetWebExperienceRequest": { + "type": "structure", + "required": [ + "applicationId", + "webExperienceId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "webExperienceId": { + "shape": "WebExperienceId", + "location": "uri", + "locationName": "webExperienceId" + } + } + }, + "GetWebExperienceResponse": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "webExperienceId": { + "shape": "WebExperienceId" + }, + "webExperienceArn": { + "shape": "WebExperienceArn" + }, + "defaultEndpoint": { + "shape": "Url" + }, + "status": { + "shape": "WebExperienceStatus" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "title": { + "shape": "WebExperienceTitle" + }, + "subtitle": { + "shape": "WebExperienceSubtitle" + }, + "welcomeMessage": { + "shape": "WebExperienceWelcomeMessage" + }, + "samplePromptsControlMode": { + "shape": "WebExperienceSamplePromptsControlMode" + }, + "roleArn": { + "shape": "RoleArn" + }, + "authenticationConfiguration": { + "shape": "WebExperienceAuthConfiguration", + "deprecated": true, + "deprecatedMessage": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." + }, + "error": { + "shape": "ErrorDetail" + } + } + }, + "GroupMembers": { + "type": "structure", + "members": { + "memberGroups": { + "shape": "MemberGroups" + }, + "memberUsers": { + "shape": "MemberUsers" + } + } + }, + "GroupName": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "\\P{C}*" + }, + "GroupStatus": { + "type": "string", + "enum": [ + "FAILED", + "SUCCEEDED", + "PROCESSING", + "DELETING", + "DELETED" + ] + }, + "GroupStatusDetail": { + "type": "structure", + "members": { + "status": { + "shape": "GroupStatus" + }, + "lastUpdatedAt": { + "shape": "Timestamp" + }, + "errorDetail": { + "shape": "ErrorDetail" + } + } + }, + "GroupStatusDetails": { + "type": "list", + "member": { + "shape": "GroupStatusDetail" + } + }, + "GroupSummary": { + "type": "structure", + "members": { + "groupName": { + "shape": "GroupName" + } + } + }, + "GroupSummaryList": { + "type": "list", + "member": { + "shape": "GroupSummary" + } + }, + "HookConfiguration": { + "type": "structure", + "members": { + "invocationCondition": { + "shape": "DocumentAttributeCondition" + }, + "lambdaArn": { + "shape": "LambdaArn" + }, + "s3BucketName": { + "shape": "S3BucketName" + }, + "roleArn": { + "shape": "RoleArn" + } + } + }, + "IdcApplicationArn": { + "type": "string", + "max": 1224, + "min": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application\/(sso)?ins-[a-zA-Z0-9-.]{16}\/apl-[a-zA-Z0-9]{16}" + }, + "Index": { + "type": "structure", + "members": { + "displayName": { + "shape": "IndexName" + }, + "indexId": { + "shape": "IndexId" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "status": { + "shape": "IndexStatus" + } + } + }, + "IndexArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "IndexCapacityConfiguration": { + "type": "structure", + "members": { + "units": { + "shape": "IndexCapacityInteger" + } + } + }, + "IndexCapacityInteger": { + "type": "integer", + "box": true, + "min": 1 + }, + "IndexId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "IndexName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "IndexStatistics": { + "type": "structure", + "members": { + "textDocumentStatistics": { + "shape": "TextDocumentStatistics" + } + } + }, + "IndexStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ] + }, + "IndexType": { + "type": "string", + "enum": [ + "ENTERPRISE", + "STARTER" + ] + }, + "IndexedTextBytes": { + "type": "long", + "box": true, + "min": 0 + }, + "IndexedTextDocument": { + "type": "integer", + "box": true, + "min": 0 + }, + "Indices": { + "type": "list", + "member": { + "shape": "Index" + } + }, + "InlineDocumentEnrichmentConfiguration": { + "type": "structure", + "members": { + "condition": { + "shape": "DocumentAttributeCondition" + }, + "target": { + "shape": "DocumentAttributeTarget" + }, + "documentContentOperator": { + "shape": "DocumentContentOperator" + } + } + }, + "InlineDocumentEnrichmentConfigurations": { + "type": "list", + "member": { + "shape": "InlineDocumentEnrichmentConfiguration" + }, + "max": 100, + "min": 1 + }, + "InstanceArn": { + "type": "string", + "max": 1224, + "min": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance\/(sso)?ins-[a-zA-Z0-9-.]{16}" + }, + "Integer": { + "type": "integer", + "box": true + }, + "InternalServerException": { + "type": "structure", + "required": [ + "message" + ], + "members": { + "message": { + "shape": "ErrorMessage" + } + }, + "error": { + "httpStatusCode": 500 + }, + "exception": true, + "fault": true + }, + "KendraIndexConfiguration": { + "type": "structure", + "required": [ + "indexId" + ], + "members": { + "indexId": { + "shape": "KendraIndexId" + } + } + }, + "KendraIndexId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "KmsKeyId": { + "type": "string", + "max": 2048, + "min": 1, + "sensitive": true + }, + "LambdaArn": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?" + }, + "LicenseNotFoundException": { + "type": "structure", + "required": [ + "message" + ], + "members": { + "message": { + "shape": "ErrorMessage" + } + }, + "error": { + "httpStatusCode": 400, + "senderFault": true + }, + "exception": true + }, + "ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListApplications", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListApplicationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken" + }, + "applications": { + "shape": "Applications" + } + } + }, + "ListConversationsRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "UserId", + "location": "querystring", + "locationName": "userId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListConversations", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListConversationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken" + }, + "conversations": { + "shape": "Conversations" + } + } + }, + "ListDataSourceSyncJobsRequest": { + "type": "structure", + "required": [ + "dataSourceId", + "applicationId", + "indexId" + ], + "members": { + "dataSourceId": { + "shape": "DataSourceId", + "location": "uri", + "locationName": "dataSourceId" + }, + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListDataSourcesSyncJobs", + "location": "querystring", + "locationName": "maxResults" + }, + "startTime": { + "shape": "Timestamp", + "location": "querystring", + "locationName": "startTime" + }, + "endTime": { + "shape": "Timestamp", + "location": "querystring", + "locationName": "endTime" + }, + "statusFilter": { + "shape": "DataSourceSyncJobStatus", + "location": "querystring", + "locationName": "syncStatus" + } + } + }, + "ListDataSourceSyncJobsResponse": { + "type": "structure", + "members": { + "history": { + "shape": "DataSourceSyncJobs" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "ListDataSourcesRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListDataSources", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListDataSourcesResponse": { + "type": "structure", + "members": { + "dataSources": { + "shape": "DataSources" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "ListDocumentsRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "dataSourceIds": { + "shape": "DataSourceIds", + "location": "querystring", + "locationName": "dataSourceIds" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListDocuments", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListDocumentsResponse": { + "type": "structure", + "members": { + "documentDetailList": { + "shape": "DocumentDetailList" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "ListGroupsRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "updatedEarlierThan" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "updatedEarlierThan": { + "shape": "Timestamp", + "location": "querystring", + "locationName": "updatedEarlierThan" + }, + "dataSourceId": { + "shape": "DataSourceId", + "location": "querystring", + "locationName": "dataSourceId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListGroupsRequest", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListGroupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken" + }, + "items": { + "shape": "GroupSummaryList" + } + } + }, + "ListIndicesRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListIndices", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListIndicesResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken" + }, + "indices": { + "shape": "Indices" + } + } + }, + "ListMessagesRequest": { + "type": "structure", + "required": [ + "conversationId", + "applicationId" + ], + "members": { + "conversationId": { + "shape": "ConversationId", + "location": "uri", + "locationName": "conversationId" + }, + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "UserId", + "location": "querystring", + "locationName": "userId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListMessages", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListMessagesResponse": { + "type": "structure", + "members": { + "messages": { + "shape": "Messages" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "ListPluginsRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListPlugins", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListPluginsResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken" + }, + "plugins": { + "shape": "Plugins" + } + } + }, + "ListRetrieversRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListRetrieversRequest", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListRetrieversResponse": { + "type": "structure", + "members": { + "retrievers": { + "shape": "Retrievers" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "ListTagsForResourceRequest": { + "type": "structure", + "required": [ + "resourceARN" + ], + "members": { + "resourceARN": { + "shape": "AmazonResourceName", + "location": "uri", + "locationName": "resourceARN" + } + } + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "shape": "Tags" + } + } + }, + "ListWebExperiencesRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "nextToken": { + "shape": "NextToken", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResultsIntegerForListWebExperiencesRequest", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListWebExperiencesResponse": { + "type": "structure", + "members": { + "webExperiences": { + "shape": "WebExperiences" + }, + "nextToken": { + "shape": "NextToken" + } + } + }, + "Long": { + "type": "long", + "box": true + }, + "MaxResultsIntegerForGetTopicConfigurations": { + "type": "integer", + "box": true, + "max": 50, + "min": 1 + }, + "MaxResultsIntegerForListApplications": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListConversations": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListDataSources": { + "type": "integer", + "box": true, + "max": 10, + "min": 1 + }, + "MaxResultsIntegerForListDataSourcesSyncJobs": { + "type": "integer", + "box": true, + "max": 10, + "min": 1 + }, + "MaxResultsIntegerForListDocuments": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListGroupsRequest": { + "type": "integer", + "box": true, + "max": 10, + "min": 1 + }, + "MaxResultsIntegerForListIndices": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListMessages": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListPlugins": { + "type": "integer", + "box": true, + "max": 50, + "min": 1 + }, + "MaxResultsIntegerForListRetrieversRequest": { + "type": "integer", + "box": true, + "max": 50, + "min": 1 + }, + "MaxResultsIntegerForListWebExperiencesRequest": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MemberGroup": { + "type": "structure", + "required": [ + "groupName" + ], + "members": { + "groupName": { + "shape": "GroupName" + }, + "type": { + "shape": "MembershipType" + } + } + }, + "MemberGroups": { + "type": "list", + "member": { + "shape": "MemberGroup" + }, + "max": 1000, + "min": 1 + }, + "MemberRelation": { + "type": "string", + "enum": [ + "AND", + "OR" + ] + }, + "MemberUser": { + "type": "structure", + "required": [ + "userId" + ], + "members": { + "userId": { + "shape": "DataSourceUserId" + }, + "type": { + "shape": "MembershipType" + } + } + }, + "MemberUsers": { + "type": "list", + "member": { + "shape": "MemberUser" + }, + "max": 1000, + "min": 1 + }, + "MembershipType": { + "type": "string", + "enum": [ + "INDEX", + "DATASOURCE" + ] + }, + "Message": { + "type": "structure", + "members": { + "messageId": { + "shape": "String" + }, + "body": { + "shape": "MessageBody" + }, + "time": { + "shape": "Timestamp" + }, + "type": { + "shape": "MessageType" + }, + "attachments": { + "shape": "AttachmentsOutput" + }, + "sourceAttribution": { + "shape": "SourceAttributions" + }, + "actionReview": { + "shape": "ActionReview" + }, + "actionExecution": { + "shape": "ActionExecution" + } + } + }, + "MessageBody": { + "type": "string", + "max": 1000, + "min": 0, + "pattern": "\\P{C}*$}" + }, + "MessageId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "MessageType": { + "type": "string", + "enum": [ + "USER", + "SYSTEM" + ] + }, + "MessageUsefulness": { + "type": "string", + "enum": [ + "USEFUL", + "NOT_USEFUL" + ] + }, + "MessageUsefulnessComment": { + "type": "string", + "max": 1000, + "min": 0, + "pattern": "\\P{C}*" + }, + "MessageUsefulnessFeedback": { + "type": "structure", + "required": [ + "usefulness", + "submittedAt" + ], + "members": { + "usefulness": { + "shape": "MessageUsefulness" + }, + "reason": { + "shape": "MessageUsefulnessReason" + }, + "comment": { + "shape": "MessageUsefulnessComment" + }, + "submittedAt": { + "shape": "Timestamp" + } + } + }, + "MessageUsefulnessReason": { + "type": "string", + "enum": [ + "NOT_FACTUALLY_CORRECT", + "HARMFUL_OR_UNSAFE", + "INCORRECT_OR_MISSING_SOURCES", + "NOT_HELPFUL", + "FACTUALLY_CORRECT", + "COMPLETE", + "RELEVANT_SOURCES", + "HELPFUL", + "NOT_BASED_ON_DOCUMENTS", + "NOT_COMPLETE", + "NOT_CONCISE", + "OTHER" + ] + }, + "Messages": { + "type": "list", + "member": { + "shape": "Message" + } + }, + "MetadataEvent": { + "type": "structure", + "members": { + "conversationId": { + "shape": "ConversationId" + }, + "userMessageId": { + "shape": "MessageId" + }, + "systemMessageId": { + "shape": "MessageId" + }, + "sourceAttributions": { + "shape": "SourceAttributions" + }, + "finalTextMessage": { + "shape": "String" + } + }, + "event": true + }, + "MetricValue": { + "type": "string", + "pattern": "(([1-9][0-9]*)|0)" + }, + "NativeIndexConfiguration": { + "type": "structure", + "required": [ + "indexId" + ], + "members": { + "indexId": { + "shape": "IndexId" + }, + "boostingOverride": { + "shape": "DocumentAttributeBoostingOverrideMap" + } + } + }, + "NextToken": { + "type": "string", + "max": 800, + "min": 1 + }, + "NoAuthConfiguration": { + "type": "structure", + "members": [] + }, + "NumberAttributeBoostingConfiguration": { + "type": "structure", + "required": [ + "boostingLevel" + ], + "members": { + "boostingLevel": { + "shape": "DocumentAttributeBoostingLevel" + }, + "boostingType": { + "shape": "NumberAttributeBoostingType" + } + } + }, + "NumberAttributeBoostingType": { + "type": "string", + "enum": [ + "PRIORITIZE_LARGER_VALUES", + "PRIORITIZE_SMALLER_VALUES" + ] + }, + "OAuth2ClientCredentialConfiguration": { + "type": "structure", + "required": [ + "secretArn", + "roleArn" + ], + "members": { + "secretArn": { + "shape": "SecretArn" + }, + "roleArn": { + "shape": "RoleArn" + } + } + }, + "Payload": { + "type": "string", + "sensitive": true + }, + "Plugin": { + "type": "structure", + "members": { + "pluginId": { + "shape": "PluginId" + }, + "displayName": { + "shape": "PluginName" + }, + "type": { + "shape": "PluginType" + }, + "serverUrl": { + "shape": "Url" + }, + "state": { + "shape": "PluginState" + }, + "buildStatus": { + "shape": "PluginBuildStatus" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + } + } + }, + "PluginArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "PluginAuthConfiguration": { + "type": "structure", + "members": { + "basicAuthConfiguration": { + "shape": "BasicAuthConfiguration" + }, + "oAuth2ClientCredentialConfiguration": { + "shape": "OAuth2ClientCredentialConfiguration" + }, + "noAuthConfiguration": { + "shape": "NoAuthConfiguration" + } + }, + "union": true + }, + "PluginBuildStatus": { + "type": "string", + "enum": [ + "READY", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED", + "DELETE_IN_PROGRESS", + "DELETE_FAILED" + ] + }, + "PluginConfiguration": { + "type": "structure", + "required": [ + "pluginId" + ], + "members": { + "pluginId": { + "shape": "PluginId" + } + } + }, + "PluginDescription": { + "type": "string", + "max": 200, + "min": 1 + }, + "PluginId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "PluginName": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "PluginState": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "PluginType": { + "type": "string", + "enum": [ + "SERVICE_NOW", + "SALESFORCE", + "JIRA", + "ZENDESK", + "CUSTOM" + ] + }, + "Plugins": { + "type": "list", + "member": { + "shape": "Plugin" + } + }, + "Principal": { + "type": "structure", + "members": { + "user": { + "shape": "PrincipalUser" + }, + "group": { + "shape": "PrincipalGroup" + } + }, + "union": true + }, + "PrincipalGroup": { + "type": "structure", + "required": [ + "access" + ], + "members": { + "name": { + "shape": "GroupName" + }, + "access": { + "shape": "ReadAccessType" + }, + "membershipType": { + "shape": "MembershipType" + } + } + }, + "PrincipalUser": { + "type": "structure", + "required": [ + "access" + ], + "members": { + "id": { + "shape": "UserId" + }, + "access": { + "shape": "ReadAccessType" + }, + "membershipType": { + "shape": "MembershipType" + } + } + }, + "Principals": { + "type": "list", + "member": { + "shape": "Principal" + } + }, + "PutFeedbackRequest": { + "type": "structure", + "required": [ + "applicationId", + "conversationId", + "messageId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "UserId", + "location": "querystring", + "locationName": "userId" + }, + "conversationId": { + "shape": "ConversationId", + "location": "uri", + "locationName": "conversationId" + }, + "messageId": { + "shape": "SystemMessageId", + "location": "uri", + "locationName": "messageId" + }, + "messageCopiedAt": { + "shape": "Timestamp" + }, + "messageUsefulness": { + "shape": "MessageUsefulnessFeedback" + } + } + }, + "PutGroupRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "groupName", + "type", + "groupMembers" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "groupName": { + "shape": "GroupName" + }, + "dataSourceId": { + "shape": "DataSourceId" + }, + "type": { + "shape": "MembershipType" + }, + "groupMembers": { + "shape": "GroupMembers" + } + } + }, + "PutGroupResponse": { + "type": "structure", + "members": [] + }, + "ReadAccessType": { + "type": "string", + "enum": [ + "ALLOW", + "DENY" + ] + }, + "ResourceNotFoundException": { + "type": "structure", + "required": [ + "message", + "resourceId", + "resourceType" + ], + "members": { + "message": { + "shape": "ErrorMessage" + }, + "resourceId": { + "shape": "String" + }, + "resourceType": { + "shape": "String" + } + }, + "error": { + "httpStatusCode": 404, + "senderFault": true + }, + "exception": true + }, + "ResponseScope": { + "type": "string", + "enum": [ + "ENTERPRISE_CONTENT_ONLY", + "EXTENDED_KNOWLEDGE_ENABLED" + ] + }, + "Retriever": { + "type": "structure", + "members": { + "applicationId": { + "shape": "ApplicationId" + }, + "retrieverId": { + "shape": "RetrieverId" + }, + "type": { + "shape": "RetrieverType" + }, + "status": { + "shape": "RetrieverStatus" + }, + "displayName": { + "shape": "RetrieverName" + } + } + }, + "RetrieverArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "RetrieverConfiguration": { + "type": "structure", + "members": { + "nativeIndexConfiguration": { + "shape": "NativeIndexConfiguration" + }, + "kendraIndexConfiguration": { + "shape": "KendraIndexConfiguration" + } + }, + "union": true + }, + "RetrieverId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "RetrieverName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "RetrieverStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "FAILED" + ] + }, + "RetrieverType": { + "type": "string", + "enum": [ + "NATIVE_INDEX", + "KENDRA_INDEX" + ] + }, + "Retrievers": { + "type": "list", + "member": { + "shape": "Retriever" + } + }, + "RoleArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "Rule": { + "type": "structure", + "required": [ + "ruleType" + ], + "members": { + "includedUsersAndGroups": { + "shape": "UsersAndGroups" + }, + "excludedUsersAndGroups": { + "shape": "UsersAndGroups" + }, + "ruleType": { + "shape": "RuleType" + }, + "ruleConfiguration": { + "shape": "RuleConfiguration" + } + } + }, + "RuleConfiguration": { + "type": "structure", + "members": { + "contentBlockerRule": { + "shape": "ContentBlockerRule" + }, + "contentRetrievalRule": { + "shape": "ContentRetrievalRule" + } + }, + "union": true + }, + "RuleType": { + "type": "string", + "enum": [ + "CONTENT_BLOCKER_RULE", + "CONTENT_RETRIEVAL_RULE" + ] + }, + "Rules": { + "type": "list", + "member": { + "shape": "Rule" + }, + "max": 10, + "min": 0 + }, + "S3": { + "type": "structure", + "required": [ + "bucket", + "key" + ], + "members": { + "bucket": { + "shape": "S3BucketName" + }, + "key": { + "shape": "S3ObjectKey" + } + } + }, + "S3BucketName": { + "type": "string", + "max": 63, + "min": 1, + "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" + }, + "S3ObjectKey": { + "type": "string", + "max": 1024, + "min": 1 + }, + "SamlAttribute": { + "type": "string", + "max": 256, + "min": 1 + }, + "SamlConfiguration": { + "type": "structure", + "required": [ + "metadataXML", + "roleArn", + "userIdAttribute" + ], + "members": { + "metadataXML": { + "shape": "SamlMetadataXML" + }, + "roleArn": { + "shape": "RoleArn" + }, + "userIdAttribute": { + "shape": "SamlAttribute" + }, + "userGroupAttribute": { + "shape": "SamlAttribute" + } + } + }, + "SamlMetadataXML": { + "type": "string", + "max": 10000000, + "min": 1000, + "pattern": ".*" + }, + "SecretArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "SecurityGroupId": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "[-0-9a-zA-Z]+" + }, + "SecurityGroupIds": { + "type": "list", + "member": { + "shape": "SecurityGroupId" + }, + "max": 10, + "min": 1 + }, + "ServiceQuotaExceededException": { + "type": "structure", + "required": [ + "message", + "resourceId", + "resourceType" + ], + "members": { + "message": { + "shape": "ErrorMessage" + }, + "resourceId": { + "shape": "String" + }, + "resourceType": { + "shape": "String" + } + }, + "error": { + "httpStatusCode": 402, + "senderFault": true + }, + "exception": true + }, + "SnippetExcerpt": { + "type": "structure", + "members": { + "text": { + "shape": "SnippetExcerptText" + } + } + }, + "SnippetExcerptText": { + "type": "string" + }, + "SourceAttribution": { + "type": "structure", + "members": { + "title": { + "shape": "String" + }, + "snippet": { + "shape": "String" + }, + "url": { + "shape": "String" + }, + "citationNumber": { + "shape": "Integer" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "textMessageSegments": { + "shape": "TextSegmentList" + } + } + }, + "SourceAttributions": { + "type": "list", + "member": { + "shape": "SourceAttribution" + } + }, + "StartDataSourceSyncJobRequest": { + "type": "structure", + "required": [ + "dataSourceId", + "applicationId", + "indexId" + ], + "members": { + "dataSourceId": { + "shape": "DataSourceId", + "location": "uri", + "locationName": "dataSourceId" + }, + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + } + } + }, + "StartDataSourceSyncJobResponse": { + "type": "structure", + "members": { + "executionId": { + "shape": "ExecutionId" + } + } + }, + "Status": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "StopDataSourceSyncJobRequest": { + "type": "structure", + "required": [ + "dataSourceId", + "applicationId", + "indexId" + ], + "members": { + "dataSourceId": { + "shape": "DataSourceId", + "location": "uri", + "locationName": "dataSourceId" + }, + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + } + } + }, + "StopDataSourceSyncJobResponse": { + "type": "structure", + "members": [] + }, + "String": { + "type": "string", + "max": 2048, + "min": 1 + }, + "StringAttributeBoostingConfiguration": { + "type": "structure", + "required": [ + "boostingLevel" + ], + "members": { + "boostingLevel": { + "shape": "DocumentAttributeBoostingLevel" + }, + "attributeValueBoosting": { + "shape": "StringAttributeValueBoosting" + } + } + }, + "StringAttributeValueBoosting": { + "type": "map", + "key": { + "shape": "String" + }, + "value": { + "shape": "StringAttributeValueBoostingLevel" + }, + "max": 10, + "min": 1 + }, + "StringAttributeValueBoostingLevel": { + "type": "string", + "enum": [ + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ] + }, + "StringListAttributeBoostingConfiguration": { + "type": "structure", + "required": [ + "boostingLevel" + ], + "members": { + "boostingLevel": { + "shape": "DocumentAttributeBoostingLevel" + } + } + }, + "SubnetId": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "[-0-9a-zA-Z]+" + }, + "SubnetIds": { + "type": "list", + "member": { + "shape": "SubnetId" + } + }, + "SyncSchedule": { + "type": "string", + "max": 998, + "min": 0, + "pattern": "\\P{C}*" + }, + "SystemMessageId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + }, + "SystemMessageOverride": { + "type": "string", + "max": 350, + "min": 0, + "pattern": "\\P{C}*" + }, + "Tag": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": { + "shape": "TagKey" + }, + "value": { + "shape": "TagValue" + } + } + }, + "TagKey": { + "type": "string", + "max": 128, + "min": 1 + }, + "TagKeys": { + "type": "list", + "member": { + "shape": "TagKey" + }, + "max": 200, + "min": 0 + }, + "TagResourceRequest": { + "type": "structure", + "required": [ + "resourceARN", + "tags" + ], + "members": { + "resourceARN": { + "shape": "AmazonResourceName", + "location": "uri", + "locationName": "resourceARN" + }, + "tags": { + "shape": "Tags" + } + } + }, + "TagResourceResponse": { + "type": "structure", + "members": [] + }, + "TagValue": { + "type": "string", + "max": 256, + "min": 0 + }, + "Tags": { + "type": "list", + "member": { + "shape": "Tag" + }, + "max": 200, + "min": 0 + }, + "TextDocumentStatistics": { + "type": "structure", + "members": { + "indexedTextBytes": { + "shape": "IndexedTextBytes" + }, + "indexedTextDocumentCount": { + "shape": "IndexedTextDocument" + } + } + }, + "TextInputEvent": { + "type": "structure", + "required": [ + "userMessage" + ], + "members": { + "userMessage": { + "shape": "UserMessage" + } + }, + "event": true + }, + "TextOutputEvent": { + "type": "structure", + "members": { + "conversationId": { + "shape": "ConversationId" + }, + "userMessageId": { + "shape": "MessageId" + }, + "systemMessageId": { + "shape": "MessageId" + }, + "systemMessage": { + "shape": "String" + } + }, + "event": true + }, + "TextSegment": { + "type": "structure", + "members": { + "beginOffset": { + "shape": "Integer" + }, + "endOffset": { + "shape": "Integer" + }, + "snippetExcerpt": { + "shape": "SnippetExcerpt" + } + } + }, + "TextSegmentList": { + "type": "list", + "member": { + "shape": "TextSegment" + } + }, + "ThrottlingException": { + "type": "structure", + "required": [ + "message" + ], + "members": { + "message": { + "shape": "ErrorMessage" + } + }, + "error": { + "httpStatusCode": 429, + "senderFault": true + }, + "exception": true + }, + "Timestamp": { + "type": "timestamp" + }, + "Title": { + "type": "string", + "max": 1024, + "min": 1 + }, + "TopicConfiguration": { + "type": "structure", + "required": [ + "name", + "rules" + ], + "members": { + "name": { + "shape": "TopicConfigurationName" + }, + "description": { + "shape": "TopicDescription" + }, + "exampleChatMessages": { + "shape": "ExampleChatMessages" + }, + "rules": { + "shape": "Rules" + } + } + }, + "TopicConfigurationName": { + "type": "string", + "max": 36, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]{0,35}" + }, + "TopicConfigurations": { + "type": "list", + "member": { + "shape": "TopicConfiguration" + }, + "max": 10, + "min": 0 + }, + "TopicDescription": { + "type": "string", + "max": 350, + "min": 0, + "pattern": "\\P{C}*" + }, + "UntagResourceRequest": { + "type": "structure", + "required": [ + "resourceARN", + "tagKeys" + ], + "members": { + "resourceARN": { + "shape": "AmazonResourceName", + "location": "uri", + "locationName": "resourceARN" + }, + "tagKeys": { + "shape": "TagKeys", + "location": "querystring", + "locationName": "tagKeys" + } + } + }, + "UntagResourceResponse": { + "type": "structure", + "members": [] + }, + "UpdateApplicationRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "identityCenterInstanceArn": { + "shape": "InstanceArn" + }, + "displayName": { + "shape": "ApplicationName" + }, + "description": { + "shape": "Description" + }, + "roleArn": { + "shape": "RoleArn" + }, + "attachmentsConfiguration": { + "shape": "AttachmentsConfiguration" + } + } + }, + "UpdateApplicationResponse": { + "type": "structure", + "members": [] + }, + "UpdateChatControlsConfigurationRequest": { + "type": "structure", + "required": [ + "applicationId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true + }, + "responseScope": { + "shape": "ResponseScope" + }, + "blockedPhrasesConfigurationUpdate": { + "shape": "BlockedPhrasesConfigurationUpdate" + }, + "topicConfigurationsToCreateOrUpdate": { + "shape": "TopicConfigurations" + }, + "topicConfigurationsToDelete": { + "shape": "TopicConfigurations" + }, + "creatorModeConfiguration": { + "shape": "CreatorModeConfiguration" + } + } + }, + "UpdateChatControlsConfigurationResponse": { + "type": "structure", + "members": [] + }, + "UpdateDataSourceRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId", + "dataSourceId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "dataSourceId": { + "shape": "DataSourceId", + "location": "uri", + "locationName": "dataSourceId" + }, + "displayName": { + "shape": "DataSourceName" + }, + "configuration": { + "shape": "DataSourceConfiguration" + }, + "vpcConfiguration": { + "shape": "DataSourceVpcConfiguration" + }, + "description": { + "shape": "Description" + }, + "syncSchedule": { + "shape": "SyncSchedule" + }, + "roleArn": { + "shape": "RoleArn" + }, + "documentEnrichmentConfiguration": { + "shape": "DocumentEnrichmentConfiguration" + } + } + }, + "UpdateDataSourceResponse": { + "type": "structure", + "members": [] + }, + "UpdateIndexRequest": { + "type": "structure", + "required": [ + "applicationId", + "indexId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "indexId": { + "shape": "IndexId", + "location": "uri", + "locationName": "indexId" + }, + "displayName": { + "shape": "ApplicationName" + }, + "description": { + "shape": "Description" + }, + "capacityConfiguration": { + "shape": "IndexCapacityConfiguration" + }, + "documentAttributeConfigurations": { + "shape": "DocumentAttributeConfigurations" + } + } + }, + "UpdateIndexResponse": { + "type": "structure", + "members": [] + }, + "UpdatePluginRequest": { + "type": "structure", + "required": [ + "applicationId", + "pluginId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "pluginId": { + "shape": "PluginId", + "location": "uri", + "locationName": "pluginId" + }, + "displayName": { + "shape": "PluginName" + }, + "state": { + "shape": "PluginState" + }, + "serverUrl": { + "shape": "Url" + }, + "customPluginConfiguration": { + "shape": "CustomPluginConfiguration" + }, + "authConfiguration": { + "shape": "PluginAuthConfiguration" + } + } + }, + "UpdatePluginResponse": { + "type": "structure", + "members": [] + }, + "UpdateRetrieverRequest": { + "type": "structure", + "required": [ + "applicationId", + "retrieverId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "retrieverId": { + "shape": "RetrieverId", + "location": "uri", + "locationName": "retrieverId" + }, + "configuration": { + "shape": "RetrieverConfiguration" + }, + "displayName": { + "shape": "RetrieverName" + }, + "roleArn": { + "shape": "RoleArn" + } + } + }, + "UpdateRetrieverResponse": { + "type": "structure", + "members": [] + }, + "UpdateUserRequest": { + "type": "structure", + "required": [ + "applicationId", + "userId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "userId": { + "shape": "String", + "location": "uri", + "locationName": "userId" + }, + "userAliasesToUpdate": { + "shape": "UserAliases" + }, + "userAliasesToDelete": { + "shape": "UserAliases" + } + } + }, + "UpdateUserResponse": { + "type": "structure", + "members": { + "userAliasesAdded": { + "shape": "UserAliases" + }, + "userAliasesUpdated": { + "shape": "UserAliases" + }, + "userAliasesDeleted": { + "shape": "UserAliases" + } + } + }, + "UpdateWebExperienceRequest": { + "type": "structure", + "required": [ + "applicationId", + "webExperienceId" + ], + "members": { + "applicationId": { + "shape": "ApplicationId", + "location": "uri", + "locationName": "applicationId" + }, + "webExperienceId": { + "shape": "WebExperienceId", + "location": "uri", + "locationName": "webExperienceId" + }, + "roleArn": { + "shape": "RoleArn" + }, + "authenticationConfiguration": { + "shape": "WebExperienceAuthConfiguration", + "deprecated": true, + "deprecatedMessage": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." + }, + "title": { + "shape": "WebExperienceTitle" + }, + "subtitle": { + "shape": "WebExperienceSubtitle" + }, + "welcomeMessage": { + "shape": "WebExperienceWelcomeMessage" + }, + "samplePromptsControlMode": { + "shape": "WebExperienceSamplePromptsControlMode" + } + } + }, + "UpdateWebExperienceResponse": { + "type": "structure", + "members": [] + }, + "Url": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "(https?|ftp|file):\/\/([^\\s]*)" + }, + "UserAlias": { + "type": "structure", + "required": [ + "userId" + ], + "members": { + "indexId": { + "shape": "IndexId" + }, + "dataSourceId": { + "shape": "DataSourceId" + }, + "userId": { + "shape": "String" + } + } + }, + "UserAliases": { + "type": "list", + "member": { + "shape": "UserAlias" + } + }, + "UserGroups": { + "type": "list", + "member": { + "shape": "String" + } + }, + "UserId": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "\\P{C}*" + }, + "UserIds": { + "type": "list", + "member": { + "shape": "String" + } + }, + "UserMessage": { + "type": "string", + "max": 7000, + "min": 1 + }, + "UsersAndGroups": { + "type": "structure", + "members": { + "userIds": { + "shape": "UserIds" + }, + "userGroups": { + "shape": "UserGroups" + } + } + }, + "ValidationException": { + "type": "structure", + "required": [ + "message", + "reason" + ], + "members": { + "message": { + "shape": "ErrorMessage" + }, + "reason": { + "shape": "ValidationExceptionReason" + }, + "fields": { + "shape": "ValidationExceptionFields" + } + }, + "error": { + "httpStatusCode": 400, + "senderFault": true + }, + "exception": true + }, + "ValidationExceptionField": { + "type": "structure", + "required": [ + "name", + "message" + ], + "members": { + "name": { + "shape": "String" + }, + "message": { + "shape": "String" + } + } + }, + "ValidationExceptionFields": { + "type": "list", + "member": { + "shape": "ValidationExceptionField" + } + }, + "ValidationExceptionReason": { + "type": "string", + "enum": [ + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "UNKNOWN_OPERATION" + ] + }, + "WebExperience": { + "type": "structure", + "members": { + "webExperienceId": { + "shape": "WebExperienceId" + }, + "createdAt": { + "shape": "Timestamp" + }, + "updatedAt": { + "shape": "Timestamp" + }, + "defaultEndpoint": { + "shape": "Url" + }, + "status": { + "shape": "WebExperienceStatus" + } + } + }, + "WebExperienceArn": { + "type": "string", + "max": 1284, + "min": 0, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^\/].{0,1023}" + }, + "WebExperienceAuthConfiguration": { + "type": "structure", + "members": { + "samlConfiguration": { + "shape": "SamlConfiguration" + } + }, + "union": true + }, + "WebExperienceId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]*" + }, + "WebExperienceSamplePromptsControlMode": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "WebExperienceStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "PENDING_AUTH_CONFIG" + ] + }, + "WebExperienceSubtitle": { + "type": "string", + "max": 500, + "min": 0, + "pattern": "\\P{C}*" + }, + "WebExperienceTitle": { + "type": "string", + "max": 500, + "min": 0, + "pattern": "\\P{C}*" + }, + "WebExperienceWelcomeMessage": { + "type": "string", + "max": 300, + "min": 0 + }, + "WebExperiences": { + "type": "list", + "member": { + "shape": "WebExperience" + } } - } - }, - "UpdateUserResponse":{ - "type":"structure", - "members":{ - "userAliasesAdded":{"shape":"UserAliases"}, - "userAliasesDeleted":{"shape":"UserAliases"}, - "userAliasesUpdated":{"shape":"UserAliases"} - } - }, - "UpdateWebExperienceRequest":{ - "type":"structure", - "required":[ - "applicationId", - "webExperienceId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "location":"uri", - "locationName":"applicationId" - }, - "authenticationConfiguration":{"shape":"WebExperienceAuthConfiguration"}, - "samplePromptsControlMode":{"shape":"WebExperienceSamplePromptsControlMode"}, - "subtitle":{"shape":"WebExperienceSubtitle"}, - "title":{"shape":"WebExperienceTitle"}, - "webExperienceId":{ - "shape":"WebExperienceId", - "location":"uri", - "locationName":"webExperienceId" - }, - "welcomeMessage":{"shape":"WebExperienceWelcomeMessage"} - } - }, - "UpdateWebExperienceResponse":{ - "type":"structure", - "members":{ - } - }, - "Url":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^(https?|ftp|file)://([^\\s]*)$" - }, - "UserAlias":{ - "type":"structure", - "required":["userId"], - "members":{ - "dataSourceId":{"shape":"DataSourceId"}, - "indexId":{"shape":"IndexId"}, - "userId":{"shape":"String"} - } - }, - "UserAliases":{ - "type":"list", - "member":{"shape":"UserAlias"} - }, - "UserGroups":{ - "type":"list", - "member":{"shape":"String"} - }, - "UserId":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^\\P{C}*$" - }, - "UserIds":{ - "type":"list", - "member":{"shape":"String"} - }, - "UserMessage":{ - "type":"string", - "max":7000, - "min":1 - }, - "UsersAndGroups":{ - "type":"structure", - "members":{ - "userGroups":{"shape":"UserGroups"}, - "userIds":{"shape":"UserIds"} - } - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "fields":{"shape":"ValidationExceptionFields"}, - "message":{"shape":"ErrorMessage"}, - "reason":{"shape":"ValidationExceptionReason"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "message", - "name" - ], - "members":{ - "message":{"shape":"String"}, - "name":{"shape":"String"} - } - }, - "ValidationExceptionFields":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "CANNOT_PARSE", - "FIELD_VALIDATION_FAILED", - "UNKNOWN_OPERATION" - ] - }, - "WebExperience":{ - "type":"structure", - "members":{ - "createdAt":{"shape":"Timestamp"}, - "defaultEndpoint":{"shape":"Url"}, - "status":{"shape":"WebExperienceStatus"}, - "updatedAt":{"shape":"Timestamp"}, - "webExperienceId":{"shape":"WebExperienceId"} - } - }, - "WebExperienceArn":{ - "type":"string", - "max":1284, - "min":0, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" - }, - "WebExperienceAuthConfiguration":{ - "type":"structure", - "members":{ - "samlConfiguration":{"shape":"SamlConfiguration"} - }, - "union":true - }, - "WebExperienceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "WebExperienceSamplePromptsControlMode":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "WebExperienceStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "PENDING_AUTH_CONFIG" - ] - }, - "WebExperienceSubtitle":{ - "type":"string", - "max":500, - "min":0, - "pattern":"^\\P{C}*$" - }, - "WebExperienceTitle":{ - "type":"string", - "max":500, - "min":0, - "pattern":"^\\P{C}*$" - }, - "WebExperienceWelcomeMessage":{ - "type":"string", - "max":300, - "min":0 - }, - "WebExperiences":{ - "type":"list", - "member":{"shape":"WebExperience"} } - } -} +} \ No newline at end of file diff --git a/src/data/qbusiness/2023-11-27/api-2.json.php b/src/data/qbusiness/2023-11-27/api-2.json.php index b44ad34d7c..940ff488c5 100644 --- a/src/data/qbusiness/2023-11-27/api-2.json.php +++ b/src/data/qbusiness/2023-11-27/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2023-11-27', 'endpointPrefix' => 'qbusiness', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'QBusiness', 'serviceId' => 'QBusiness', 'signatureVersion' => 'v4', 'signingName' => 'qbusiness', 'uid' => 'qbusiness-2023-11-27', ], 'operations' => [ 'BatchDeleteDocument' => [ 'name' => 'BatchDeleteDocument', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/documents/delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchDeleteDocumentRequest', ], 'output' => [ 'shape' => 'BatchDeleteDocumentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'BatchPutDocument' => [ 'name' => 'BatchPutDocument', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/documents', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchPutDocumentRequest', ], 'output' => [ 'shape' => 'BatchPutDocumentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'ChatSync' => [ 'name' => 'ChatSync', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/conversations?sync', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ChatSyncInput', ], 'output' => [ 'shape' => 'ChatSyncOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateApplication' => [ 'name' => 'CreateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateApplicationRequest', ], 'output' => [ 'shape' => 'CreateApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateDataSource' => [ 'name' => 'CreateDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDataSourceRequest', ], 'output' => [ 'shape' => 'CreateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateIndex' => [ 'name' => 'CreateIndex', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateIndexRequest', ], 'output' => [ 'shape' => 'CreateIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'CreatePlugin' => [ 'name' => 'CreatePlugin', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/plugins', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreatePluginRequest', ], 'output' => [ 'shape' => 'CreatePluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateRetriever' => [ 'name' => 'CreateRetriever', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/retrievers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateRetrieverRequest', ], 'output' => [ 'shape' => 'CreateRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/users', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateUserRequest', ], 'output' => [ 'shape' => 'CreateUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateWebExperience' => [ 'name' => 'CreateWebExperience', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/experiences', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateWebExperienceRequest', ], 'output' => [ 'shape' => 'CreateWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'DeleteApplication' => [ 'name' => 'DeleteApplication', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteApplicationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteChatControlsConfiguration' => [ 'name' => 'DeleteChatControlsConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/chatcontrols', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteChatControlsConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteChatControlsConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteConversation' => [ 'name' => 'DeleteConversation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/conversations/{conversationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteConversationRequest', ], 'output' => [ 'shape' => 'DeleteConversationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups/{groupName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteIndex' => [ 'name' => 'DeleteIndex', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/indices/{indexId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteIndexRequest', ], 'output' => [ 'shape' => 'DeleteIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeletePlugin' => [ 'name' => 'DeletePlugin', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/plugins/{pluginId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeletePluginRequest', ], 'output' => [ 'shape' => 'DeletePluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteRetriever' => [ 'name' => 'DeleteRetriever', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/retrievers/{retrieverId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteRetrieverRequest', ], 'output' => [ 'shape' => 'DeleteRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/users/{userId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'output' => [ 'shape' => 'DeleteUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteWebExperience' => [ 'name' => 'DeleteWebExperience', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/experiences/{webExperienceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteWebExperienceRequest', ], 'output' => [ 'shape' => 'DeleteWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'GetApplication' => [ 'name' => 'GetApplication', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetApplicationRequest', ], 'output' => [ 'shape' => 'GetApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetChatControlsConfiguration' => [ 'name' => 'GetChatControlsConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/chatcontrols', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetChatControlsConfigurationRequest', ], 'output' => [ 'shape' => 'GetChatControlsConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetGroup' => [ 'name' => 'GetGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups/{groupName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupRequest', ], 'output' => [ 'shape' => 'GetGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetIndex' => [ 'name' => 'GetIndex', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetIndexRequest', ], 'output' => [ 'shape' => 'GetIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetPlugin' => [ 'name' => 'GetPlugin', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/plugins/{pluginId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetPluginRequest', ], 'output' => [ 'shape' => 'GetPluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetRetriever' => [ 'name' => 'GetRetriever', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/retrievers/{retrieverId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRetrieverRequest', ], 'output' => [ 'shape' => 'GetRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetUser' => [ 'name' => 'GetUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/users/{userId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetUserRequest', ], 'output' => [ 'shape' => 'GetUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetWebExperience' => [ 'name' => 'GetWebExperience', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/experiences/{webExperienceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWebExperienceRequest', ], 'output' => [ 'shape' => 'GetWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListApplications' => [ 'name' => 'ListApplications', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListApplicationsRequest', ], 'output' => [ 'shape' => 'ListApplicationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListConversations' => [ 'name' => 'ListConversations', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/conversations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListConversationsRequest', ], 'output' => [ 'shape' => 'ListConversationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListDataSourceSyncJobs' => [ 'name' => 'ListDataSourceSyncJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDataSourceSyncJobsRequest', ], 'output' => [ 'shape' => 'ListDataSourceSyncJobsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListDocuments' => [ 'name' => 'ListDocuments', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/index/{indexId}/documents', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDocumentsRequest', ], 'output' => [ 'shape' => 'ListDocumentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListIndices' => [ 'name' => 'ListIndices', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListIndicesRequest', ], 'output' => [ 'shape' => 'ListIndicesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListMessages' => [ 'name' => 'ListMessages', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/conversations/{conversationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListMessagesRequest', ], 'output' => [ 'shape' => 'ListMessagesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListPlugins' => [ 'name' => 'ListPlugins', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/plugins', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListPluginsRequest', ], 'output' => [ 'shape' => 'ListPluginsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListRetrievers' => [ 'name' => 'ListRetrievers', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/retrievers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRetrieversRequest', ], 'output' => [ 'shape' => 'ListRetrieversResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/tags/{resourceARN}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListWebExperiences' => [ 'name' => 'ListWebExperiences', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/experiences', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWebExperiencesRequest', ], 'output' => [ 'shape' => 'ListWebExperiencesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutFeedback' => [ 'name' => 'PutFeedback', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutFeedbackRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutGroup' => [ 'name' => 'PutGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutGroupRequest', ], 'output' => [ 'shape' => 'PutGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'StartDataSourceSyncJob' => [ 'name' => 'StartDataSourceSyncJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartDataSourceSyncJobRequest', ], 'output' => [ 'shape' => 'StartDataSourceSyncJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'StopDataSourceSyncJob' => [ 'name' => 'StopDataSourceSyncJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StopDataSourceSyncJobRequest', ], 'output' => [ 'shape' => 'StopDataSourceSyncJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/tags/{resourceARN}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/tags/{resourceARN}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateApplication' => [ 'name' => 'UpdateApplication', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateApplicationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateChatControlsConfiguration' => [ 'name' => 'UpdateChatControlsConfiguration', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/applications/{applicationId}/chatcontrols', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateChatControlsConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateChatControlsConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateIndex' => [ 'name' => 'UpdateIndex', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/indices/{indexId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateIndexRequest', ], 'output' => [ 'shape' => 'UpdateIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdatePlugin' => [ 'name' => 'UpdatePlugin', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/plugins/{pluginId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdatePluginRequest', ], 'output' => [ 'shape' => 'UpdatePluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateRetriever' => [ 'name' => 'UpdateRetriever', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/retrievers/{retrieverId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateRetrieverRequest', ], 'output' => [ 'shape' => 'UpdateRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateUser' => [ 'name' => 'UpdateUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/users/{userId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateUserRequest', ], 'output' => [ 'shape' => 'UpdateUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateWebExperience' => [ 'name' => 'UpdateWebExperience', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/experiences/{webExperienceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateWebExperienceRequest', ], 'output' => [ 'shape' => 'UpdateWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'AccessConfiguration' => [ 'type' => 'structure', 'required' => [ 'accessControls', ], 'members' => [ 'accessControls' => [ 'shape' => 'AccessControls', ], 'memberRelation' => [ 'shape' => 'MemberRelation', ], ], ], 'AccessControl' => [ 'type' => 'structure', 'required' => [ 'principals', ], 'members' => [ 'memberRelation' => [ 'shape' => 'MemberRelation', ], 'principals' => [ 'shape' => 'Principals', ], ], ], 'AccessControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControl', ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActionExecution' => [ 'type' => 'structure', 'required' => [ 'payload', 'payloadFieldNameSeparator', 'pluginId', ], 'members' => [ 'payload' => [ 'shape' => 'ActionExecutionPayload', ], 'payloadFieldNameSeparator' => [ 'shape' => 'ActionPayloadFieldNameSeparator', ], 'pluginId' => [ 'shape' => 'PluginId', ], ], ], 'ActionExecutionPayload' => [ 'type' => 'map', 'key' => [ 'shape' => 'ActionPayloadFieldKey', ], 'value' => [ 'shape' => 'ActionExecutionPayloadField', ], ], 'ActionExecutionPayloadField' => [ 'type' => 'structure', 'required' => [ 'value', ], 'members' => [ 'value' => [ 'shape' => 'ActionPayloadFieldValue', ], ], ], 'ActionPayloadFieldKey' => [ 'type' => 'string', 'min' => 1, ], 'ActionPayloadFieldNameSeparator' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'ActionPayloadFieldType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'NUMBER', 'ARRAY', 'BOOLEAN', ], ], 'ActionPayloadFieldValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'ActionReview' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'ActionReviewPayload', ], 'payloadFieldNameSeparator' => [ 'shape' => 'ActionPayloadFieldNameSeparator', ], 'pluginId' => [ 'shape' => 'PluginId', ], 'pluginType' => [ 'shape' => 'PluginType', ], ], ], 'ActionReviewPayload' => [ 'type' => 'map', 'key' => [ 'shape' => 'ActionPayloadFieldKey', ], 'value' => [ 'shape' => 'ActionReviewPayloadField', ], ], 'ActionReviewPayloadField' => [ 'type' => 'structure', 'members' => [ 'allowedValues' => [ 'shape' => 'ActionReviewPayloadFieldAllowedValues', ], 'displayName' => [ 'shape' => 'String', ], 'displayOrder' => [ 'shape' => 'Integer', ], 'required' => [ 'shape' => 'Boolean', ], 'type' => [ 'shape' => 'ActionPayloadFieldType', ], 'value' => [ 'shape' => 'ActionPayloadFieldValue', ], ], ], 'ActionReviewPayloadFieldAllowedValue' => [ 'type' => 'structure', 'members' => [ 'displayValue' => [ 'shape' => 'ActionPayloadFieldValue', ], 'value' => [ 'shape' => 'ActionPayloadFieldValue', ], ], ], 'ActionReviewPayloadFieldAllowedValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionReviewPayloadFieldAllowedValue', ], ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 1011, 'min' => 1, ], 'Application' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'status' => [ 'shape' => 'ApplicationStatus', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ApplicationArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'ApplicationId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'ApplicationName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9_-]*$', ], 'ApplicationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'UPDATING', ], ], 'Applications' => [ 'type' => 'list', 'member' => [ 'shape' => 'Application', ], ], 'AppliedAttachmentsConfiguration' => [ 'type' => 'structure', 'members' => [ 'attachmentsControlMode' => [ 'shape' => 'AttachmentsControlMode', ], ], ], 'AppliedCreatorModeConfiguration' => [ 'type' => 'structure', 'required' => [ 'creatorModeControl', ], 'members' => [ 'creatorModeControl' => [ 'shape' => 'CreatorModeControl', ], ], ], 'AttachmentInput' => [ 'type' => 'structure', 'required' => [ 'data', 'name', ], 'members' => [ 'data' => [ 'shape' => 'Blob', ], 'name' => [ 'shape' => 'AttachmentName', ], ], ], 'AttachmentName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'AttachmentOutput' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'ErrorDetail', ], 'name' => [ 'shape' => 'AttachmentName', ], 'status' => [ 'shape' => 'AttachmentStatus', ], ], ], 'AttachmentStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', ], ], 'AttachmentsConfiguration' => [ 'type' => 'structure', 'required' => [ 'attachmentsControlMode', ], 'members' => [ 'attachmentsControlMode' => [ 'shape' => 'AttachmentsControlMode', ], ], ], 'AttachmentsControlMode' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AttachmentsInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentInput', ], 'min' => 1, ], 'AttachmentsOutput' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentOutput', ], ], 'AttributeFilter' => [ 'type' => 'structure', 'members' => [ 'andAllFilters' => [ 'shape' => 'AttributeFilters', ], 'containsAll' => [ 'shape' => 'DocumentAttribute', ], 'containsAny' => [ 'shape' => 'DocumentAttribute', ], 'equalsTo' => [ 'shape' => 'DocumentAttribute', ], 'greaterThan' => [ 'shape' => 'DocumentAttribute', ], 'greaterThanOrEquals' => [ 'shape' => 'DocumentAttribute', ], 'lessThan' => [ 'shape' => 'DocumentAttribute', ], 'lessThanOrEquals' => [ 'shape' => 'DocumentAttribute', ], 'notFilter' => [ 'shape' => 'AttributeFilter', ], 'orAllFilters' => [ 'shape' => 'AttributeFilters', ], ], ], 'AttributeFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeFilter', ], ], 'AttributeType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'STRING_LIST', 'NUMBER', 'DATE', ], ], 'AttributeValueOperator' => [ 'type' => 'string', 'enum' => [ 'DELETE', ], ], 'BasicAuthConfiguration' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'secretArn', ], 'members' => [ 'roleArn' => [ 'shape' => 'RoleArn', ], 'secretArn' => [ 'shape' => 'SecretArn', ], ], ], 'BatchDeleteDocumentRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'documents', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceSyncId' => [ 'shape' => 'ExecutionId', ], 'documents' => [ 'shape' => 'DeleteDocuments', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'BatchDeleteDocumentResponse' => [ 'type' => 'structure', 'members' => [ 'failedDocuments' => [ 'shape' => 'FailedDocuments', ], ], ], 'BatchPutDocumentRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'documents', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceSyncId' => [ 'shape' => 'ExecutionId', ], 'documents' => [ 'shape' => 'Documents', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'BatchPutDocumentResponse' => [ 'type' => 'structure', 'members' => [ 'failedDocuments' => [ 'shape' => 'FailedDocuments', ], ], ], 'Blob' => [ 'type' => 'blob', ], 'BlockedPhrase' => [ 'type' => 'string', 'max' => 36, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'BlockedPhrases' => [ 'type' => 'list', 'member' => [ 'shape' => 'BlockedPhrase', ], 'max' => 5, 'min' => 0, ], 'BlockedPhrasesConfiguration' => [ 'type' => 'structure', 'members' => [ 'blockedPhrases' => [ 'shape' => 'BlockedPhrases', ], 'systemMessageOverride' => [ 'shape' => 'SystemMessageOverride', ], ], ], 'BlockedPhrasesConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'blockedPhrasesToCreateOrUpdate' => [ 'shape' => 'BlockedPhrases', ], 'blockedPhrasesToDelete' => [ 'shape' => 'BlockedPhrases', ], 'systemMessageOverride' => [ 'shape' => 'SystemMessageOverride', ], ], ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'BoostingDurationInSeconds' => [ 'type' => 'long', 'box' => true, 'max' => 999999999, 'min' => 0, ], 'ChatMode' => [ 'type' => 'string', 'enum' => [ 'RETRIEVAL_MODE', 'CREATOR_MODE', 'PLUGIN_MODE', ], ], 'ChatModeConfiguration' => [ 'type' => 'structure', 'members' => [ 'pluginConfiguration' => [ 'shape' => 'PluginConfiguration', ], ], 'union' => true, ], 'ChatSyncInput' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'actionExecution' => [ 'shape' => 'ActionExecution', ], 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'attachments' => [ 'shape' => 'AttachmentsInput', ], 'attributeFilter' => [ 'shape' => 'AttributeFilter', ], 'chatMode' => [ 'shape' => 'ChatMode', ], 'chatModeConfiguration' => [ 'shape' => 'ChatModeConfiguration', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'conversationId' => [ 'shape' => 'ConversationId', ], 'parentMessageId' => [ 'shape' => 'MessageId', ], 'userGroups' => [ 'shape' => 'UserGroups', 'location' => 'querystring', 'locationName' => 'userGroups', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], 'userMessage' => [ 'shape' => 'UserMessage', ], ], ], 'ChatSyncOutput' => [ 'type' => 'structure', 'members' => [ 'actionReview' => [ 'shape' => 'ActionReview', ], 'conversationId' => [ 'shape' => 'ConversationId', ], 'failedAttachments' => [ 'shape' => 'AttachmentsOutput', ], 'sourceAttributions' => [ 'shape' => 'SourceAttributions', ], 'systemMessage' => [ 'shape' => 'String', ], 'systemMessageId' => [ 'shape' => 'MessageId', ], 'userMessageId' => [ 'shape' => 'MessageId', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', 'resourceId', 'resourceType', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'ContentBlockerRule' => [ 'type' => 'structure', 'members' => [ 'systemMessageOverride' => [ 'shape' => 'SystemMessageOverride', ], ], ], 'ContentRetrievalRule' => [ 'type' => 'structure', 'members' => [ 'eligibleDataSources' => [ 'shape' => 'EligibleDataSources', ], ], ], 'ContentType' => [ 'type' => 'string', 'enum' => [ 'PDF', 'HTML', 'MS_WORD', 'PLAIN_TEXT', 'PPT', 'RTF', 'XML', 'XSLT', 'MS_EXCEL', 'CSV', 'JSON', 'MD', ], ], 'Conversation' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'title' => [ 'shape' => 'ConversationTitle', ], ], ], 'ConversationId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'ConversationTitle' => [ 'type' => 'string', ], 'Conversations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Conversation', ], ], 'CreateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'displayName', 'roleArn', ], 'members' => [ 'attachmentsConfiguration' => [ 'shape' => 'AttachmentsConfiguration', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], 'identityCenterInstanceArn' => [ 'shape' => 'InstanceArn', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'applicationArn' => [ 'shape' => 'ApplicationArn', ], 'applicationId' => [ 'shape' => 'ApplicationId', ], ], ], 'CreateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'configuration', 'displayName', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'configuration' => [ 'shape' => 'DataSourceConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'syncSchedule' => [ 'shape' => 'SyncSchedule', ], 'tags' => [ 'shape' => 'Tags', ], 'vpcConfiguration' => [ 'shape' => 'DataSourceVpcConfiguration', ], ], ], 'CreateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'dataSourceArn' => [ 'shape' => 'DataSourceArn', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], ], ], 'CreateIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'displayName', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'capacityConfiguration' => [ 'shape' => 'IndexCapacityConfiguration', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'IndexName', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateIndexResponse' => [ 'type' => 'structure', 'members' => [ 'indexArn' => [ 'shape' => 'IndexArn', ], 'indexId' => [ 'shape' => 'IndexId', ], ], ], 'CreatePluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'authConfiguration', 'displayName', 'serverUrl', 'type', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'authConfiguration' => [ 'shape' => 'PluginAuthConfiguration', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'displayName' => [ 'shape' => 'PluginName', ], 'serverUrl' => [ 'shape' => 'Url', ], 'tags' => [ 'shape' => 'Tags', ], 'type' => [ 'shape' => 'PluginType', ], ], ], 'CreatePluginResponse' => [ 'type' => 'structure', 'members' => [ 'pluginArn' => [ 'shape' => 'PluginArn', ], 'pluginId' => [ 'shape' => 'PluginId', ], ], ], 'CreateRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'configuration', 'displayName', 'type', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'configuration' => [ 'shape' => 'RetrieverConfiguration', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], 'type' => [ 'shape' => 'RetrieverType', ], ], ], 'CreateRetrieverResponse' => [ 'type' => 'structure', 'members' => [ 'retrieverArn' => [ 'shape' => 'RetrieverArn', ], 'retrieverId' => [ 'shape' => 'RetrieverId', ], ], ], 'CreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'userAliases' => [ 'shape' => 'CreateUserRequestUserAliasesList', ], 'userId' => [ 'shape' => 'String', ], ], ], 'CreateUserRequestUserAliasesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAlias', ], 'max' => 100, 'min' => 0, ], 'CreateUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'samplePromptsControlMode' => [ 'shape' => 'WebExperienceSamplePromptsControlMode', ], 'subtitle' => [ 'shape' => 'WebExperienceSubtitle', ], 'tags' => [ 'shape' => 'Tags', ], 'title' => [ 'shape' => 'WebExperienceTitle', ], 'welcomeMessage' => [ 'shape' => 'WebExperienceWelcomeMessage', ], ], ], 'CreateWebExperienceResponse' => [ 'type' => 'structure', 'members' => [ 'webExperienceArn' => [ 'shape' => 'WebExperienceArn', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', ], ], ], 'CreatorModeConfiguration' => [ 'type' => 'structure', 'required' => [ 'creatorModeControl', ], 'members' => [ 'creatorModeControl' => [ 'shape' => 'CreatorModeControl', ], ], ], 'CreatorModeControl' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'type' => [ 'shape' => 'String', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'DataSourceArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'DataSourceConfiguration' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'DataSourceId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'DataSourceIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceId', ], 'max' => 1, 'min' => 1, ], 'DataSourceName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9_-]*$', ], 'DataSourceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_CREATION', 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'UPDATING', ], ], 'DataSourceSyncJob' => [ 'type' => 'structure', 'members' => [ 'dataSourceErrorCode' => [ 'shape' => 'String', ], 'endTime' => [ 'shape' => 'Timestamp', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'executionId' => [ 'shape' => 'ExecutionId', ], 'metrics' => [ 'shape' => 'DataSourceSyncJobMetrics', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'DataSourceSyncJobStatus', ], ], ], 'DataSourceSyncJobMetrics' => [ 'type' => 'structure', 'members' => [ 'documentsAdded' => [ 'shape' => 'MetricValue', ], 'documentsDeleted' => [ 'shape' => 'MetricValue', ], 'documentsFailed' => [ 'shape' => 'MetricValue', ], 'documentsModified' => [ 'shape' => 'MetricValue', ], 'documentsScanned' => [ 'shape' => 'MetricValue', ], ], ], 'DataSourceSyncJobStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'SYNCING', 'INCOMPLETE', 'STOPPING', 'ABORTED', 'SYNCING_INDEXING', ], ], 'DataSourceSyncJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSyncJob', ], ], 'DataSourceUserId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'DataSourceVpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'securityGroupIds', 'subnetIds', ], 'members' => [ 'securityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'subnetIds' => [ 'shape' => 'SubnetIds', ], ], ], 'DataSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSource', ], ], 'DateAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingDurationInSeconds' => [ 'shape' => 'BoostingDurationInSeconds', ], 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], ], ], 'DeleteApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], ], ], 'DeleteApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteChatControlsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], ], ], 'DeleteChatControlsConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteConversationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'conversationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'uri', 'locationName' => 'conversationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], ], ], 'DeleteConversationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'dataSourceId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDocument' => [ 'type' => 'structure', 'required' => [ 'documentId', ], 'members' => [ 'documentId' => [ 'shape' => 'DocumentId', ], ], ], 'DeleteDocuments' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeleteDocument', ], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'groupName', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'querystring', 'locationName' => 'dataSourceId', ], 'groupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'groupName', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'DeleteIndexResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeletePluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'pluginId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'pluginId' => [ 'shape' => 'PluginId', 'location' => 'uri', 'locationName' => 'pluginId', ], ], ], 'DeletePluginResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'retrieverId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', 'location' => 'uri', 'locationName' => 'retrieverId', ], ], ], 'DeleteRetrieverResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'userId', ], ], ], 'DeleteUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'webExperienceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', 'location' => 'uri', 'locationName' => 'webExperienceId', ], ], ], 'DeleteWebExperienceResponse' => [ 'type' => 'structure', 'members' => [], ], 'Description' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'Document' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'accessConfiguration' => [ 'shape' => 'AccessConfiguration', ], 'attributes' => [ 'shape' => 'DocumentAttributes', ], 'content' => [ 'shape' => 'DocumentContent', ], 'contentType' => [ 'shape' => 'ContentType', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], 'id' => [ 'shape' => 'DocumentId', ], 'title' => [ 'shape' => 'Title', ], ], ], 'DocumentAttribute' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'DocumentAttributeKey', ], 'value' => [ 'shape' => 'DocumentAttributeValue', ], ], ], 'DocumentAttributeBoostingConfiguration' => [ 'type' => 'structure', 'members' => [ 'dateConfiguration' => [ 'shape' => 'DateAttributeBoostingConfiguration', ], 'numberConfiguration' => [ 'shape' => 'NumberAttributeBoostingConfiguration', ], 'stringConfiguration' => [ 'shape' => 'StringAttributeBoostingConfiguration', ], 'stringListConfiguration' => [ 'shape' => 'StringListAttributeBoostingConfiguration', ], ], 'union' => true, ], 'DocumentAttributeBoostingLevel' => [ 'type' => 'string', 'enum' => [ 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'VERY_HIGH', ], ], 'DocumentAttributeBoostingOverrideMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'DocumentAttributeKey', ], 'value' => [ 'shape' => 'DocumentAttributeBoostingConfiguration', ], 'min' => 1, ], 'DocumentAttributeCondition' => [ 'type' => 'structure', 'required' => [ 'key', 'operator', ], 'members' => [ 'key' => [ 'shape' => 'DocumentAttributeKey', ], 'operator' => [ 'shape' => 'DocumentEnrichmentConditionOperator', ], 'value' => [ 'shape' => 'DocumentAttributeValue', ], ], ], 'DocumentAttributeConfiguration' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'search' => [ 'shape' => 'Status', ], 'type' => [ 'shape' => 'AttributeType', ], ], ], 'DocumentAttributeConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocumentAttributeConfiguration', ], 'max' => 500, 'min' => 1, ], 'DocumentAttributeKey' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_][a-zA-Z0-9_-]*$', ], 'DocumentAttributeStringListValue' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'DocumentAttributeTarget' => [ 'type' => 'structure', 'required' => [ 'key', ], 'members' => [ 'attributeValueOperator' => [ 'shape' => 'AttributeValueOperator', ], 'key' => [ 'shape' => 'DocumentAttributeKey', ], 'value' => [ 'shape' => 'DocumentAttributeValue', ], ], ], 'DocumentAttributeValue' => [ 'type' => 'structure', 'members' => [ 'dateValue' => [ 'shape' => 'Timestamp', ], 'longValue' => [ 'shape' => 'Long', ], 'stringListValue' => [ 'shape' => 'DocumentAttributeStringListValue', ], 'stringValue' => [ 'shape' => 'DocumentAttributeValueStringValueString', ], ], 'union' => true, ], 'DocumentAttributeValueStringValueString' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'DocumentAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocumentAttribute', ], 'max' => 500, 'min' => 1, ], 'DocumentContent' => [ 'type' => 'structure', 'members' => [ 'blob' => [ 'shape' => 'Blob', ], 's3' => [ 'shape' => 'S3', ], ], 'union' => true, ], 'DocumentContentOperator' => [ 'type' => 'string', 'enum' => [ 'DELETE', ], ], 'DocumentDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocumentDetails', ], ], 'DocumentDetails' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'documentId' => [ 'shape' => 'DocumentId', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'status' => [ 'shape' => 'DocumentStatus', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'DocumentEnrichmentConditionOperator' => [ 'type' => 'string', 'enum' => [ 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'EQUALS', 'NOT_EQUALS', 'CONTAINS', 'NOT_CONTAINS', 'EXISTS', 'NOT_EXISTS', 'BEGINS_WITH', ], ], 'DocumentEnrichmentConfiguration' => [ 'type' => 'structure', 'members' => [ 'inlineConfigurations' => [ 'shape' => 'InlineDocumentEnrichmentConfigurations', ], 'postExtractionHookConfiguration' => [ 'shape' => 'HookConfiguration', ], 'preExtractionHookConfiguration' => [ 'shape' => 'HookConfiguration', ], ], ], 'DocumentId' => [ 'type' => 'string', 'max' => 1825, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'DocumentStatus' => [ 'type' => 'string', 'enum' => [ 'RECEIVED', 'PROCESSING', 'INDEXED', 'UPDATED', 'FAILED', 'DELETING', 'DELETED', 'DOCUMENT_FAILED_TO_INDEX', ], ], 'Documents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Document', ], 'max' => 10, 'min' => 1, ], 'EligibleDataSource' => [ 'type' => 'structure', 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', ], ], ], 'EligibleDataSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'EligibleDataSource', ], 'max' => 5, 'min' => 0, ], 'EncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'kmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ErrorCode' => [ 'type' => 'string', 'enum' => [ 'InternalError', 'InvalidRequest', 'ResourceInactive', 'ResourceNotFound', ], ], 'ErrorDetail' => [ 'type' => 'structure', 'members' => [ 'errorCode' => [ 'shape' => 'ErrorCode', ], 'errorMessage' => [ 'shape' => 'ErrorMessage', ], ], ], 'ErrorMessage' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'ExampleChatMessage' => [ 'type' => 'string', 'max' => 350, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'ExampleChatMessages' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExampleChatMessage', ], 'max' => 5, 'min' => 0, ], 'ExecutionId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'FailedDocument' => [ 'type' => 'structure', 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'id' => [ 'shape' => 'DocumentId', ], ], ], 'FailedDocuments' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedDocument', ], ], 'GetApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], ], ], 'GetApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'applicationArn' => [ 'shape' => 'ApplicationArn', ], 'applicationId' => [ 'shape' => 'ApplicationId', ], 'attachmentsConfiguration' => [ 'shape' => 'AppliedAttachmentsConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'identityCenterApplicationArn' => [ 'shape' => 'IdcApplicationArn', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ApplicationStatus', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'GetChatControlsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForGetTopicConfigurations', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetChatControlsConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'blockedPhrases' => [ 'shape' => 'BlockedPhrasesConfiguration', ], 'creatorModeConfiguration' => [ 'shape' => 'AppliedCreatorModeConfiguration', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'responseScope' => [ 'shape' => 'ResponseScope', ], 'topicConfigurations' => [ 'shape' => 'TopicConfigurations', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'dataSourceId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'configuration' => [ 'shape' => 'DataSourceConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'dataSourceArn' => [ 'shape' => 'DataSourceArn', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'indexId' => [ 'shape' => 'IndexId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'syncSchedule' => [ 'shape' => 'SyncSchedule', ], 'type' => [ 'shape' => 'String', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'vpcConfiguration' => [ 'shape' => 'DataSourceVpcConfiguration', ], ], ], 'GetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'groupName', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'querystring', 'locationName' => 'dataSourceId', ], 'groupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'groupName', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'GetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'GroupStatusDetail', ], 'statusHistory' => [ 'shape' => 'GroupStatusDetails', ], ], ], 'GetIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'GetIndexResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'capacityConfiguration' => [ 'shape' => 'IndexCapacityConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'IndexName', ], 'documentAttributeConfigurations' => [ 'shape' => 'DocumentAttributeConfigurations', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'indexArn' => [ 'shape' => 'IndexArn', ], 'indexId' => [ 'shape' => 'IndexId', ], 'indexStatistics' => [ 'shape' => 'IndexStatistics', ], 'status' => [ 'shape' => 'IndexStatus', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'GetPluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'pluginId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'pluginId' => [ 'shape' => 'PluginId', 'location' => 'uri', 'locationName' => 'pluginId', ], ], ], 'GetPluginResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'authConfiguration' => [ 'shape' => 'PluginAuthConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'displayName' => [ 'shape' => 'PluginName', ], 'pluginArn' => [ 'shape' => 'PluginArn', ], 'pluginId' => [ 'shape' => 'PluginId', ], 'serverUrl' => [ 'shape' => 'Url', ], 'state' => [ 'shape' => 'PluginState', ], 'type' => [ 'shape' => 'PluginType', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'GetRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'retrieverId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', 'location' => 'uri', 'locationName' => 'retrieverId', ], ], ], 'GetRetrieverResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'configuration' => [ 'shape' => 'RetrieverConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'retrieverArn' => [ 'shape' => 'RetrieverArn', ], 'retrieverId' => [ 'shape' => 'RetrieverId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'RetrieverStatus', ], 'type' => [ 'shape' => 'RetrieverType', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'GetUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'userId', ], ], ], 'GetUserResponse' => [ 'type' => 'structure', 'members' => [ 'userAliases' => [ 'shape' => 'UserAliases', ], ], ], 'GetWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'webExperienceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', 'location' => 'uri', 'locationName' => 'webExperienceId', ], ], ], 'GetWebExperienceResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'authenticationConfiguration' => [ 'shape' => 'WebExperienceAuthConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'defaultEndpoint' => [ 'shape' => 'Url', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'samplePromptsControlMode' => [ 'shape' => 'WebExperienceSamplePromptsControlMode', ], 'status' => [ 'shape' => 'WebExperienceStatus', ], 'subtitle' => [ 'shape' => 'WebExperienceSubtitle', ], 'title' => [ 'shape' => 'WebExperienceTitle', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'webExperienceArn' => [ 'shape' => 'WebExperienceArn', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', ], 'welcomeMessage' => [ 'shape' => 'WebExperienceWelcomeMessage', ], ], ], 'GroupMembers' => [ 'type' => 'structure', 'members' => [ 'memberGroups' => [ 'shape' => 'MemberGroups', ], 'memberUsers' => [ 'shape' => 'MemberUsers', ], ], ], 'GroupName' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'GroupStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'PROCESSING', 'DELETING', 'DELETED', ], ], 'GroupStatusDetail' => [ 'type' => 'structure', 'members' => [ 'errorDetail' => [ 'shape' => 'ErrorDetail', ], 'lastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'GroupStatus', ], ], ], 'GroupStatusDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupStatusDetail', ], ], 'GroupSummary' => [ 'type' => 'structure', 'members' => [ 'groupName' => [ 'shape' => 'GroupName', ], ], ], 'GroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupSummary', ], ], 'HookConfiguration' => [ 'type' => 'structure', 'members' => [ 'invocationCondition' => [ 'shape' => 'DocumentAttributeCondition', ], 'lambdaArn' => [ 'shape' => 'LambdaArn', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 's3BucketName' => [ 'shape' => 'S3BucketName', ], ], ], 'IdcApplicationArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 10, 'pattern' => '^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$', ], 'Index' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'displayName' => [ 'shape' => 'IndexName', ], 'indexId' => [ 'shape' => 'IndexId', ], 'status' => [ 'shape' => 'IndexStatus', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'IndexArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'IndexCapacityConfiguration' => [ 'type' => 'structure', 'members' => [ 'units' => [ 'shape' => 'IndexCapacityInteger', ], ], ], 'IndexCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'IndexId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'IndexName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9_-]*$', ], 'IndexStatistics' => [ 'type' => 'structure', 'members' => [ 'textDocumentStatistics' => [ 'shape' => 'TextDocumentStatistics', ], ], ], 'IndexStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'UPDATING', ], ], 'IndexedTextBytes' => [ 'type' => 'long', 'box' => true, 'min' => 0, ], 'IndexedTextDocument' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'Indices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Index', ], ], 'InlineDocumentEnrichmentConfiguration' => [ 'type' => 'structure', 'members' => [ 'condition' => [ 'shape' => 'DocumentAttributeCondition', ], 'documentContentOperator' => [ 'shape' => 'DocumentContentOperator', ], 'target' => [ 'shape' => 'DocumentAttributeTarget', ], ], ], 'InlineDocumentEnrichmentConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InlineDocumentEnrichmentConfiguration', ], 'max' => 100, 'min' => 1, ], 'InstanceArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 10, 'pattern' => '^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$', ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'KendraIndexConfiguration' => [ 'type' => 'structure', 'required' => [ 'indexId', ], 'members' => [ 'indexId' => [ 'shape' => 'KendraIndexId', ], ], ], 'KendraIndexId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'sensitive' => true, ], 'LambdaArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$', ], 'LicenseNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ListApplicationsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListApplications', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListApplicationsResponse' => [ 'type' => 'structure', 'members' => [ 'applications' => [ 'shape' => 'Applications', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConversationsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListConversations', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], ], ], 'ListConversationsResponse' => [ 'type' => 'structure', 'members' => [ 'conversations' => [ 'shape' => 'Conversations', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourceSyncJobsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'dataSourceId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'endTime' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'endTime', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListDataSourcesSyncJobs', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'startTime' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'startTime', ], 'statusFilter' => [ 'shape' => 'DataSourceSyncJobStatus', 'location' => 'querystring', 'locationName' => 'syncStatus', ], ], ], 'ListDataSourceSyncJobsResponse' => [ 'type' => 'structure', 'members' => [ 'history' => [ 'shape' => 'DataSourceSyncJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListDataSources', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'dataSources' => [ 'shape' => 'DataSources', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDocumentsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceIds' => [ 'shape' => 'DataSourceIds', 'location' => 'querystring', 'locationName' => 'dataSourceIds', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListDocuments', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDocumentsResponse' => [ 'type' => 'structure', 'members' => [ 'documentDetailList' => [ 'shape' => 'DocumentDetailList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'updatedEarlierThan', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'querystring', 'locationName' => 'dataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListGroupsRequest', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'updatedEarlierThan' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'updatedEarlierThan', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'items' => [ 'shape' => 'GroupSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListIndicesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListIndices', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListIndicesResponse' => [ 'type' => 'structure', 'members' => [ 'indices' => [ 'shape' => 'Indices', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMessagesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'conversationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'uri', 'locationName' => 'conversationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListMessages', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], ], ], 'ListMessagesResponse' => [ 'type' => 'structure', 'members' => [ 'messages' => [ 'shape' => 'Messages', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPluginsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListPlugins', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPluginsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'plugins' => [ 'shape' => 'Plugins', ], ], ], 'ListRetrieversRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListRetrieversRequest', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListRetrieversResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'retrievers' => [ 'shape' => 'Retrievers', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceARN', ], 'members' => [ 'resourceARN' => [ 'shape' => 'AmazonResourceName', 'location' => 'uri', 'locationName' => 'resourceARN', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListWebExperiencesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListWebExperiencesRequest', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListWebExperiencesResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'webExperiences' => [ 'shape' => 'WebExperiences', ], ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'MaxResultsIntegerForGetTopicConfigurations' => [ 'type' => 'integer', 'box' => true, 'max' => 50, 'min' => 1, ], 'MaxResultsIntegerForListApplications' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListConversations' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListDataSources' => [ 'type' => 'integer', 'box' => true, 'max' => 10, 'min' => 1, ], 'MaxResultsIntegerForListDataSourcesSyncJobs' => [ 'type' => 'integer', 'box' => true, 'max' => 10, 'min' => 1, ], 'MaxResultsIntegerForListDocuments' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListGroupsRequest' => [ 'type' => 'integer', 'box' => true, 'max' => 10, 'min' => 1, ], 'MaxResultsIntegerForListIndices' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListMessages' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListPlugins' => [ 'type' => 'integer', 'box' => true, 'max' => 50, 'min' => 1, ], 'MaxResultsIntegerForListRetrieversRequest' => [ 'type' => 'integer', 'box' => true, 'max' => 50, 'min' => 1, ], 'MaxResultsIntegerForListWebExperiencesRequest' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MemberGroup' => [ 'type' => 'structure', 'required' => [ 'groupName', ], 'members' => [ 'groupName' => [ 'shape' => 'GroupName', ], 'type' => [ 'shape' => 'MembershipType', ], ], ], 'MemberGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberGroup', ], 'max' => 1000, 'min' => 1, ], 'MemberRelation' => [ 'type' => 'string', 'enum' => [ 'AND', 'OR', ], ], 'MemberUser' => [ 'type' => 'structure', 'required' => [ 'userId', ], 'members' => [ 'type' => [ 'shape' => 'MembershipType', ], 'userId' => [ 'shape' => 'DataSourceUserId', ], ], ], 'MemberUsers' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberUser', ], 'max' => 1000, 'min' => 1, ], 'MembershipType' => [ 'type' => 'string', 'enum' => [ 'INDEX', 'DATASOURCE', ], ], 'Message' => [ 'type' => 'structure', 'members' => [ 'actionExecution' => [ 'shape' => 'ActionExecution', ], 'actionReview' => [ 'shape' => 'ActionReview', ], 'attachments' => [ 'shape' => 'AttachmentsOutput', ], 'body' => [ 'shape' => 'MessageBody', ], 'messageId' => [ 'shape' => 'String', ], 'sourceAttribution' => [ 'shape' => 'SourceAttributions', ], 'time' => [ 'shape' => 'Timestamp', ], 'type' => [ 'shape' => 'MessageType', ], ], ], 'MessageBody' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^\\P{C}*$}$', ], 'MessageId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'MessageType' => [ 'type' => 'string', 'enum' => [ 'USER', 'SYSTEM', ], ], 'MessageUsefulness' => [ 'type' => 'string', 'enum' => [ 'USEFUL', 'NOT_USEFUL', ], ], 'MessageUsefulnessComment' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'MessageUsefulnessFeedback' => [ 'type' => 'structure', 'required' => [ 'submittedAt', 'usefulness', ], 'members' => [ 'comment' => [ 'shape' => 'MessageUsefulnessComment', ], 'reason' => [ 'shape' => 'MessageUsefulnessReason', ], 'submittedAt' => [ 'shape' => 'Timestamp', ], 'usefulness' => [ 'shape' => 'MessageUsefulness', ], ], ], 'MessageUsefulnessReason' => [ 'type' => 'string', 'enum' => [ 'NOT_FACTUALLY_CORRECT', 'HARMFUL_OR_UNSAFE', 'INCORRECT_OR_MISSING_SOURCES', 'NOT_HELPFUL', 'FACTUALLY_CORRECT', 'COMPLETE', 'RELEVANT_SOURCES', 'HELPFUL', 'NOT_BASED_ON_DOCUMENTS', 'NOT_COMPLETE', 'NOT_CONCISE', 'OTHER', ], ], 'Messages' => [ 'type' => 'list', 'member' => [ 'shape' => 'Message', ], ], 'MetricValue' => [ 'type' => 'string', 'pattern' => '^(([1-9][0-9]*)|0)$', ], 'NativeIndexConfiguration' => [ 'type' => 'structure', 'required' => [ 'indexId', ], 'members' => [ 'boostingOverride' => [ 'shape' => 'DocumentAttributeBoostingOverrideMap', ], 'indexId' => [ 'shape' => 'IndexId', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 800, 'min' => 1, ], 'NumberAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], 'boostingType' => [ 'shape' => 'NumberAttributeBoostingType', ], ], ], 'NumberAttributeBoostingType' => [ 'type' => 'string', 'enum' => [ 'PRIORITIZE_LARGER_VALUES', 'PRIORITIZE_SMALLER_VALUES', ], ], 'OAuth2ClientCredentialConfiguration' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'secretArn', ], 'members' => [ 'roleArn' => [ 'shape' => 'RoleArn', ], 'secretArn' => [ 'shape' => 'SecretArn', ], ], ], 'Plugin' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'displayName' => [ 'shape' => 'PluginName', ], 'pluginId' => [ 'shape' => 'PluginId', ], 'serverUrl' => [ 'shape' => 'Url', ], 'state' => [ 'shape' => 'PluginState', ], 'type' => [ 'shape' => 'PluginType', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'PluginArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'PluginAuthConfiguration' => [ 'type' => 'structure', 'members' => [ 'basicAuthConfiguration' => [ 'shape' => 'BasicAuthConfiguration', ], 'oAuth2ClientCredentialConfiguration' => [ 'shape' => 'OAuth2ClientCredentialConfiguration', ], ], 'union' => true, ], 'PluginConfiguration' => [ 'type' => 'structure', 'required' => [ 'pluginId', ], 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], ], ], 'PluginId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'PluginName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9_-]*$', ], 'PluginState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'PluginType' => [ 'type' => 'string', 'enum' => [ 'SERVICE_NOW', 'SALESFORCE', 'JIRA', 'ZENDESK', ], ], 'Plugins' => [ 'type' => 'list', 'member' => [ 'shape' => 'Plugin', ], ], 'Principal' => [ 'type' => 'structure', 'members' => [ 'group' => [ 'shape' => 'PrincipalGroup', ], 'user' => [ 'shape' => 'PrincipalUser', ], ], 'union' => true, ], 'PrincipalGroup' => [ 'type' => 'structure', 'required' => [ 'access', ], 'members' => [ 'access' => [ 'shape' => 'ReadAccessType', ], 'membershipType' => [ 'shape' => 'MembershipType', ], 'name' => [ 'shape' => 'GroupName', ], ], ], 'PrincipalUser' => [ 'type' => 'structure', 'required' => [ 'access', ], 'members' => [ 'access' => [ 'shape' => 'ReadAccessType', ], 'id' => [ 'shape' => 'UserId', ], 'membershipType' => [ 'shape' => 'MembershipType', ], ], ], 'Principals' => [ 'type' => 'list', 'member' => [ 'shape' => 'Principal', ], ], 'PutFeedbackRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'conversationId', 'messageId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'uri', 'locationName' => 'conversationId', ], 'messageCopiedAt' => [ 'shape' => 'Timestamp', ], 'messageId' => [ 'shape' => 'SystemMessageId', 'location' => 'uri', 'locationName' => 'messageId', ], 'messageUsefulness' => [ 'shape' => 'MessageUsefulnessFeedback', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], ], ], 'PutGroupRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'groupMembers', 'groupName', 'indexId', 'type', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'groupMembers' => [ 'shape' => 'GroupMembers', ], 'groupName' => [ 'shape' => 'GroupName', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'type' => [ 'shape' => 'MembershipType', ], ], ], 'PutGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'ReadAccessType' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', 'resourceId', 'resourceType', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResponseScope' => [ 'type' => 'string', 'enum' => [ 'ENTERPRISE_CONTENT_ONLY', 'EXTENDED_KNOWLEDGE_ENABLED', ], ], 'Retriever' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'retrieverId' => [ 'shape' => 'RetrieverId', ], 'status' => [ 'shape' => 'RetrieverStatus', ], 'type' => [ 'shape' => 'RetrieverType', ], ], ], 'RetrieverArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'RetrieverConfiguration' => [ 'type' => 'structure', 'members' => [ 'kendraIndexConfiguration' => [ 'shape' => 'KendraIndexConfiguration', ], 'nativeIndexConfiguration' => [ 'shape' => 'NativeIndexConfiguration', ], ], 'union' => true, ], 'RetrieverId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'RetrieverName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9_-]*$', ], 'RetrieverStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'FAILED', ], ], 'RetrieverType' => [ 'type' => 'string', 'enum' => [ 'NATIVE_INDEX', 'KENDRA_INDEX', ], ], 'Retrievers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Retriever', ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'ruleType', ], 'members' => [ 'excludedUsersAndGroups' => [ 'shape' => 'UsersAndGroups', ], 'includedUsersAndGroups' => [ 'shape' => 'UsersAndGroups', ], 'ruleConfiguration' => [ 'shape' => 'RuleConfiguration', ], 'ruleType' => [ 'shape' => 'RuleType', ], ], ], 'RuleConfiguration' => [ 'type' => 'structure', 'members' => [ 'contentBlockerRule' => [ 'shape' => 'ContentBlockerRule', ], 'contentRetrievalRule' => [ 'shape' => 'ContentRetrievalRule', ], ], 'union' => true, ], 'RuleType' => [ 'type' => 'string', 'enum' => [ 'CONTENT_BLOCKER_RULE', 'CONTENT_RETRIEVAL_RULE', ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], 'max' => 10, 'min' => 0, ], 'S3' => [ 'type' => 'structure', 'required' => [ 'bucket', 'key', ], 'members' => [ 'bucket' => [ 'shape' => 'S3BucketName', ], 'key' => [ 'shape' => 'S3ObjectKey', ], ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$', ], 'S3ObjectKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SamlAttribute' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'SamlConfiguration' => [ 'type' => 'structure', 'required' => [ 'metadataXML', 'roleArn', 'userIdAttribute', ], 'members' => [ 'metadataXML' => [ 'shape' => 'SamlMetadataXML', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'userGroupAttribute' => [ 'shape' => 'SamlAttribute', ], 'userIdAttribute' => [ 'shape' => 'SamlAttribute', ], ], ], 'SamlMetadataXML' => [ 'type' => 'string', 'max' => 10000000, 'min' => 1000, 'pattern' => '^.*$', ], 'SecretArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '^[-0-9a-zA-Z]+$', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 10, 'min' => 1, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', 'resourceId', 'resourceType', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'SourceAttribution' => [ 'type' => 'structure', 'members' => [ 'citationNumber' => [ 'shape' => 'Integer', ], 'snippet' => [ 'shape' => 'String', ], 'textMessageSegments' => [ 'shape' => 'TextSegmentList', ], 'title' => [ 'shape' => 'String', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'url' => [ 'shape' => 'String', ], ], ], 'SourceAttributions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAttribution', ], ], 'StartDataSourceSyncJobRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'dataSourceId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'StartDataSourceSyncJobResponse' => [ 'type' => 'structure', 'members' => [ 'executionId' => [ 'shape' => 'ExecutionId', ], ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'StopDataSourceSyncJobRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'dataSourceId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'StopDataSourceSyncJobResponse' => [ 'type' => 'structure', 'members' => [], ], 'String' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'StringAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'attributeValueBoosting' => [ 'shape' => 'StringAttributeValueBoosting', ], 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], ], ], 'StringAttributeValueBoosting' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'StringAttributeValueBoostingLevel', ], 'max' => 10, 'min' => 1, ], 'StringAttributeValueBoostingLevel' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', 'VERY_HIGH', ], ], 'StringListAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '^[-0-9a-zA-Z]+$', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], ], 'SyncSchedule' => [ 'type' => 'string', 'max' => 998, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'SystemMessageId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{35}$', ], 'SystemMessageOverride' => [ 'type' => 'string', 'max' => 350, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceARN', 'tags', ], 'members' => [ 'resourceARN' => [ 'shape' => 'AmazonResourceName', 'location' => 'uri', 'locationName' => 'resourceARN', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TextDocumentStatistics' => [ 'type' => 'structure', 'members' => [ 'indexedTextBytes' => [ 'shape' => 'IndexedTextBytes', ], 'indexedTextDocumentCount' => [ 'shape' => 'IndexedTextDocument', ], ], ], 'TextSegment' => [ 'type' => 'structure', 'members' => [ 'beginOffset' => [ 'shape' => 'Integer', ], 'endOffset' => [ 'shape' => 'Integer', ], ], ], 'TextSegmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TextSegment', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'Title' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'TopicConfiguration' => [ 'type' => 'structure', 'required' => [ 'name', 'rules', ], 'members' => [ 'description' => [ 'shape' => 'TopicDescription', ], 'exampleChatMessages' => [ 'shape' => 'ExampleChatMessages', ], 'name' => [ 'shape' => 'TopicConfigurationName', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'TopicConfigurationName' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]{0,35}$', ], 'TopicConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicConfiguration', ], 'max' => 10, 'min' => 0, ], 'TopicDescription' => [ 'type' => 'string', 'max' => 350, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceARN', 'tagKeys', ], 'members' => [ 'resourceARN' => [ 'shape' => 'AmazonResourceName', 'location' => 'uri', 'locationName' => 'resourceARN', ], 'tagKeys' => [ 'shape' => 'TagKeys', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'attachmentsConfiguration' => [ 'shape' => 'AttachmentsConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateChatControlsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'blockedPhrasesConfigurationUpdate' => [ 'shape' => 'BlockedPhrasesConfigurationUpdate', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'creatorModeConfiguration' => [ 'shape' => 'CreatorModeConfiguration', ], 'responseScope' => [ 'shape' => 'ResponseScope', ], 'topicConfigurationsToCreateOrUpdate' => [ 'shape' => 'TopicConfigurations', ], 'topicConfigurationsToDelete' => [ 'shape' => 'TopicConfigurations', ], ], ], 'UpdateChatControlsConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'dataSourceId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'configuration' => [ 'shape' => 'DataSourceConfiguration', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'syncSchedule' => [ 'shape' => 'SyncSchedule', ], 'vpcConfiguration' => [ 'shape' => 'DataSourceVpcConfiguration', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'capacityConfiguration' => [ 'shape' => 'IndexCapacityConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'documentAttributeConfigurations' => [ 'shape' => 'DocumentAttributeConfigurations', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'UpdateIndexResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'pluginId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'authConfiguration' => [ 'shape' => 'PluginAuthConfiguration', ], 'displayName' => [ 'shape' => 'PluginName', ], 'pluginId' => [ 'shape' => 'PluginId', 'location' => 'uri', 'locationName' => 'pluginId', ], 'serverUrl' => [ 'shape' => 'Url', ], 'state' => [ 'shape' => 'PluginState', ], ], ], 'UpdatePluginResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'retrieverId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'configuration' => [ 'shape' => 'RetrieverConfiguration', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'retrieverId' => [ 'shape' => 'RetrieverId', 'location' => 'uri', 'locationName' => 'retrieverId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateRetrieverResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userAliasesToDelete' => [ 'shape' => 'UserAliases', ], 'userAliasesToUpdate' => [ 'shape' => 'UserAliases', ], 'userId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'userId', ], ], ], 'UpdateUserResponse' => [ 'type' => 'structure', 'members' => [ 'userAliasesAdded' => [ 'shape' => 'UserAliases', ], 'userAliasesDeleted' => [ 'shape' => 'UserAliases', ], 'userAliasesUpdated' => [ 'shape' => 'UserAliases', ], ], ], 'UpdateWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'webExperienceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'authenticationConfiguration' => [ 'shape' => 'WebExperienceAuthConfiguration', ], 'samplePromptsControlMode' => [ 'shape' => 'WebExperienceSamplePromptsControlMode', ], 'subtitle' => [ 'shape' => 'WebExperienceSubtitle', ], 'title' => [ 'shape' => 'WebExperienceTitle', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', 'location' => 'uri', 'locationName' => 'webExperienceId', ], 'welcomeMessage' => [ 'shape' => 'WebExperienceWelcomeMessage', ], ], ], 'UpdateWebExperienceResponse' => [ 'type' => 'structure', 'members' => [], ], 'Url' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^(https?|ftp|file)://([^\\s]*)$', ], 'UserAlias' => [ 'type' => 'structure', 'required' => [ 'userId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'indexId' => [ 'shape' => 'IndexId', ], 'userId' => [ 'shape' => 'String', ], ], ], 'UserAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAlias', ], ], 'UserGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UserId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'UserIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UserMessage' => [ 'type' => 'string', 'max' => 7000, 'min' => 1, ], 'UsersAndGroups' => [ 'type' => 'structure', 'members' => [ 'userGroups' => [ 'shape' => 'UserGroups', ], 'userIds' => [ 'shape' => 'UserIds', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', 'reason', ], 'members' => [ 'fields' => [ 'shape' => 'ValidationExceptionFields', ], 'message' => [ 'shape' => 'ErrorMessage', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'message', 'name', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'ValidationExceptionFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CANNOT_PARSE', 'FIELD_VALIDATION_FAILED', 'UNKNOWN_OPERATION', ], ], 'WebExperience' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'defaultEndpoint' => [ 'shape' => 'Url', ], 'status' => [ 'shape' => 'WebExperienceStatus', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', ], ], ], 'WebExperienceArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => '^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$', ], 'WebExperienceAuthConfiguration' => [ 'type' => 'structure', 'members' => [ 'samlConfiguration' => [ 'shape' => 'SamlConfiguration', ], ], 'union' => true, ], 'WebExperienceId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9-]*$', ], 'WebExperienceSamplePromptsControlMode' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'WebExperienceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'PENDING_AUTH_CONFIG', ], ], 'WebExperienceSubtitle' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'WebExperienceTitle' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^\\P{C}*$', ], 'WebExperienceWelcomeMessage' => [ 'type' => 'string', 'max' => 300, 'min' => 0, ], 'WebExperiences' => [ 'type' => 'list', 'member' => [ 'shape' => 'WebExperience', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2023-11-27', 'endpointPrefix' => 'qbusiness', 'protocol' => 'rest-json', 'protocolSettings' => [ 'h2' => 'eventstream', ], 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'QBusiness', 'serviceId' => 'QBusiness', 'signatureVersion' => 'v4', 'signingName' => 'qbusiness', 'uid' => 'qbusiness-2023-11-27', ], 'operations' => [ 'BatchDeleteDocument' => [ 'name' => 'BatchDeleteDocument', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/documents/delete', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchDeleteDocumentRequest', ], 'output' => [ 'shape' => 'BatchDeleteDocumentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'BatchPutDocument' => [ 'name' => 'BatchPutDocument', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/documents', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchPutDocumentRequest', ], 'output' => [ 'shape' => 'BatchPutDocumentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'ChatSync' => [ 'name' => 'ChatSync', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/conversations?sync', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ChatSyncInput', ], 'output' => [ 'shape' => 'ChatSyncOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateApplication' => [ 'name' => 'CreateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateApplicationRequest', ], 'output' => [ 'shape' => 'CreateApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateDataSource' => [ 'name' => 'CreateDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDataSourceRequest', ], 'output' => [ 'shape' => 'CreateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateIndex' => [ 'name' => 'CreateIndex', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateIndexRequest', ], 'output' => [ 'shape' => 'CreateIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'CreatePlugin' => [ 'name' => 'CreatePlugin', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/plugins', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreatePluginRequest', ], 'output' => [ 'shape' => 'CreatePluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateRetriever' => [ 'name' => 'CreateRetriever', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/retrievers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateRetrieverRequest', ], 'output' => [ 'shape' => 'CreateRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/users', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateUserRequest', ], 'output' => [ 'shape' => 'CreateUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateWebExperience' => [ 'name' => 'CreateWebExperience', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/experiences', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateWebExperienceRequest', ], 'output' => [ 'shape' => 'CreateWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'DeleteApplication' => [ 'name' => 'DeleteApplication', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteApplicationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteChatControlsConfiguration' => [ 'name' => 'DeleteChatControlsConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/chatcontrols', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteChatControlsConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteChatControlsConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteConversation' => [ 'name' => 'DeleteConversation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/conversations/{conversationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteConversationRequest', ], 'output' => [ 'shape' => 'DeleteConversationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups/{groupName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteIndex' => [ 'name' => 'DeleteIndex', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/indices/{indexId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteIndexRequest', ], 'output' => [ 'shape' => 'DeleteIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeletePlugin' => [ 'name' => 'DeletePlugin', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/plugins/{pluginId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeletePluginRequest', ], 'output' => [ 'shape' => 'DeletePluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteRetriever' => [ 'name' => 'DeleteRetriever', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/retrievers/{retrieverId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteRetrieverRequest', ], 'output' => [ 'shape' => 'DeleteRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/users/{userId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'output' => [ 'shape' => 'DeleteUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'DeleteWebExperience' => [ 'name' => 'DeleteWebExperience', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/applications/{applicationId}/experiences/{webExperienceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteWebExperienceRequest', ], 'output' => [ 'shape' => 'DeleteWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'GetApplication' => [ 'name' => 'GetApplication', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetApplicationRequest', ], 'output' => [ 'shape' => 'GetApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetChatControlsConfiguration' => [ 'name' => 'GetChatControlsConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/chatcontrols', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetChatControlsConfigurationRequest', ], 'output' => [ 'shape' => 'GetChatControlsConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetGroup' => [ 'name' => 'GetGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups/{groupName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupRequest', ], 'output' => [ 'shape' => 'GetGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetIndex' => [ 'name' => 'GetIndex', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetIndexRequest', ], 'output' => [ 'shape' => 'GetIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetPlugin' => [ 'name' => 'GetPlugin', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/plugins/{pluginId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetPluginRequest', ], 'output' => [ 'shape' => 'GetPluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetRetriever' => [ 'name' => 'GetRetriever', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/retrievers/{retrieverId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetRetrieverRequest', ], 'output' => [ 'shape' => 'GetRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetUser' => [ 'name' => 'GetUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/users/{userId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetUserRequest', ], 'output' => [ 'shape' => 'GetUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetWebExperience' => [ 'name' => 'GetWebExperience', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/experiences/{webExperienceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWebExperienceRequest', ], 'output' => [ 'shape' => 'GetWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListApplications' => [ 'name' => 'ListApplications', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListApplicationsRequest', ], 'output' => [ 'shape' => 'ListApplicationsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListConversations' => [ 'name' => 'ListConversations', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/conversations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListConversationsRequest', ], 'output' => [ 'shape' => 'ListConversationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListDataSourceSyncJobs' => [ 'name' => 'ListDataSourceSyncJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDataSourceSyncJobsRequest', ], 'output' => [ 'shape' => 'ListDataSourceSyncJobsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListDocuments' => [ 'name' => 'ListDocuments', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/index/{indexId}/documents', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDocumentsRequest', ], 'output' => [ 'shape' => 'ListDocumentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListIndices' => [ 'name' => 'ListIndices', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/indices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListIndicesRequest', ], 'output' => [ 'shape' => 'ListIndicesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListMessages' => [ 'name' => 'ListMessages', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/conversations/{conversationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListMessagesRequest', ], 'output' => [ 'shape' => 'ListMessagesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'LicenseNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListPlugins' => [ 'name' => 'ListPlugins', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/plugins', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListPluginsRequest', ], 'output' => [ 'shape' => 'ListPluginsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListRetrievers' => [ 'name' => 'ListRetrievers', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/retrievers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRetrieversRequest', ], 'output' => [ 'shape' => 'ListRetrieversResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/v1/tags/{resourceARN}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListWebExperiences' => [ 'name' => 'ListWebExperiences', 'http' => [ 'method' => 'GET', 'requestUri' => '/applications/{applicationId}/experiences', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWebExperiencesRequest', ], 'output' => [ 'shape' => 'ListWebExperiencesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutFeedback' => [ 'name' => 'PutFeedback', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutFeedbackRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutGroup' => [ 'name' => 'PutGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'PutGroupRequest', ], 'output' => [ 'shape' => 'PutGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'StartDataSourceSyncJob' => [ 'name' => 'StartDataSourceSyncJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartDataSourceSyncJobRequest', ], 'output' => [ 'shape' => 'StartDataSourceSyncJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'StopDataSourceSyncJob' => [ 'name' => 'StopDataSourceSyncJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StopDataSourceSyncJobRequest', ], 'output' => [ 'shape' => 'StopDataSourceSyncJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/v1/tags/{resourceARN}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v1/tags/{resourceARN}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateApplication' => [ 'name' => 'UpdateApplication', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateApplicationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateChatControlsConfiguration' => [ 'name' => 'UpdateChatControlsConfiguration', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/applications/{applicationId}/chatcontrols', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateChatControlsConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateChatControlsConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateIndex' => [ 'name' => 'UpdateIndex', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/indices/{indexId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateIndexRequest', ], 'output' => [ 'shape' => 'UpdateIndexResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdatePlugin' => [ 'name' => 'UpdatePlugin', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/plugins/{pluginId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdatePluginRequest', ], 'output' => [ 'shape' => 'UpdatePluginResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateRetriever' => [ 'name' => 'UpdateRetriever', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/retrievers/{retrieverId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateRetrieverRequest', ], 'output' => [ 'shape' => 'UpdateRetrieverResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateUser' => [ 'name' => 'UpdateUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/users/{userId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateUserRequest', ], 'output' => [ 'shape' => 'UpdateUserResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateWebExperience' => [ 'name' => 'UpdateWebExperience', 'http' => [ 'method' => 'PUT', 'requestUri' => '/applications/{applicationId}/experiences/{webExperienceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateWebExperienceRequest', ], 'output' => [ 'shape' => 'UpdateWebExperienceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'APISchema' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'Payload', ], 's3' => [ 'shape' => 'S3', ], ], 'union' => true, ], 'APISchemaType' => [ 'type' => 'string', 'enum' => [ 'OPEN_API_V3', ], ], 'AccessConfiguration' => [ 'type' => 'structure', 'required' => [ 'accessControls', ], 'members' => [ 'accessControls' => [ 'shape' => 'AccessControls', ], 'memberRelation' => [ 'shape' => 'MemberRelation', ], ], ], 'AccessControl' => [ 'type' => 'structure', 'required' => [ 'principals', ], 'members' => [ 'principals' => [ 'shape' => 'Principals', ], 'memberRelation' => [ 'shape' => 'MemberRelation', ], ], ], 'AccessControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControl', ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActionExecution' => [ 'type' => 'structure', 'required' => [ 'pluginId', 'payload', 'payloadFieldNameSeparator', ], 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], 'payload' => [ 'shape' => 'ActionExecutionPayload', ], 'payloadFieldNameSeparator' => [ 'shape' => 'ActionPayloadFieldNameSeparator', ], ], ], 'ActionExecutionEvent' => [ 'type' => 'structure', 'required' => [ 'pluginId', 'payload', 'payloadFieldNameSeparator', ], 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], 'payload' => [ 'shape' => 'ActionExecutionPayload', ], 'payloadFieldNameSeparator' => [ 'shape' => 'ActionPayloadFieldNameSeparator', ], ], 'event' => true, ], 'ActionExecutionPayload' => [ 'type' => 'map', 'key' => [ 'shape' => 'ActionPayloadFieldKey', ], 'value' => [ 'shape' => 'ActionExecutionPayloadField', ], ], 'ActionExecutionPayloadField' => [ 'type' => 'structure', 'required' => [ 'value', ], 'members' => [ 'value' => [ 'shape' => 'ActionPayloadFieldValue', ], ], ], 'ActionPayloadFieldKey' => [ 'type' => 'string', 'min' => 1, ], 'ActionPayloadFieldNameSeparator' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'ActionPayloadFieldType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'NUMBER', 'ARRAY', 'BOOLEAN', ], ], 'ActionPayloadFieldValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'ActionReview' => [ 'type' => 'structure', 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], 'pluginType' => [ 'shape' => 'PluginType', ], 'payload' => [ 'shape' => 'ActionReviewPayload', ], 'payloadFieldNameSeparator' => [ 'shape' => 'ActionPayloadFieldNameSeparator', ], ], ], 'ActionReviewEvent' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'userMessageId' => [ 'shape' => 'MessageId', ], 'systemMessageId' => [ 'shape' => 'MessageId', ], 'pluginId' => [ 'shape' => 'PluginId', ], 'pluginType' => [ 'shape' => 'PluginType', ], 'payload' => [ 'shape' => 'ActionReviewPayload', ], 'payloadFieldNameSeparator' => [ 'shape' => 'ActionPayloadFieldNameSeparator', ], ], 'event' => true, ], 'ActionReviewPayload' => [ 'type' => 'map', 'key' => [ 'shape' => 'ActionPayloadFieldKey', ], 'value' => [ 'shape' => 'ActionReviewPayloadField', ], ], 'ActionReviewPayloadField' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'String', ], 'displayOrder' => [ 'shape' => 'Integer', ], 'displayDescription' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'ActionPayloadFieldType', ], 'value' => [ 'shape' => 'ActionPayloadFieldValue', ], 'allowedValues' => [ 'shape' => 'ActionReviewPayloadFieldAllowedValues', ], 'allowedFormat' => [ 'shape' => 'String', ], 'required' => [ 'shape' => 'Boolean', ], ], ], 'ActionReviewPayloadFieldAllowedValue' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'ActionPayloadFieldValue', ], 'displayValue' => [ 'shape' => 'ActionPayloadFieldValue', ], ], ], 'ActionReviewPayloadFieldAllowedValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionReviewPayloadFieldAllowedValue', ], ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 1011, 'min' => 1, ], 'Application' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'ApplicationName', ], 'applicationId' => [ 'shape' => 'ApplicationId', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'ApplicationStatus', ], ], ], 'ApplicationArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'ApplicationId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'ApplicationName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'ApplicationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'UPDATING', ], ], 'Applications' => [ 'type' => 'list', 'member' => [ 'shape' => 'Application', ], ], 'AppliedAttachmentsConfiguration' => [ 'type' => 'structure', 'members' => [ 'attachmentsControlMode' => [ 'shape' => 'AttachmentsControlMode', ], ], ], 'AppliedCreatorModeConfiguration' => [ 'type' => 'structure', 'required' => [ 'creatorModeControl', ], 'members' => [ 'creatorModeControl' => [ 'shape' => 'CreatorModeControl', ], ], ], 'AttachmentInput' => [ 'type' => 'structure', 'required' => [ 'name', 'data', ], 'members' => [ 'name' => [ 'shape' => 'AttachmentName', ], 'data' => [ 'shape' => 'Blob', ], ], ], 'AttachmentInputEvent' => [ 'type' => 'structure', 'members' => [ 'attachment' => [ 'shape' => 'AttachmentInput', ], ], 'event' => true, ], 'AttachmentName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '\\P{C}*', ], 'AttachmentOutput' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'AttachmentName', ], 'status' => [ 'shape' => 'AttachmentStatus', ], 'error' => [ 'shape' => 'ErrorDetail', ], ], ], 'AttachmentStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', ], ], 'AttachmentsConfiguration' => [ 'type' => 'structure', 'required' => [ 'attachmentsControlMode', ], 'members' => [ 'attachmentsControlMode' => [ 'shape' => 'AttachmentsControlMode', ], ], ], 'AttachmentsControlMode' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AttachmentsInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentInput', ], 'min' => 1, ], 'AttachmentsOutput' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentOutput', ], ], 'AttributeFilter' => [ 'type' => 'structure', 'members' => [ 'andAllFilters' => [ 'shape' => 'AttributeFilters', ], 'orAllFilters' => [ 'shape' => 'AttributeFilters', ], 'notFilter' => [ 'shape' => 'AttributeFilter', ], 'equalsTo' => [ 'shape' => 'DocumentAttribute', ], 'containsAll' => [ 'shape' => 'DocumentAttribute', ], 'containsAny' => [ 'shape' => 'DocumentAttribute', ], 'greaterThan' => [ 'shape' => 'DocumentAttribute', ], 'greaterThanOrEquals' => [ 'shape' => 'DocumentAttribute', ], 'lessThan' => [ 'shape' => 'DocumentAttribute', ], 'lessThanOrEquals' => [ 'shape' => 'DocumentAttribute', ], ], ], 'AttributeFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeFilter', ], ], 'AttributeType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'STRING_LIST', 'NUMBER', 'DATE', ], ], 'AttributeValueOperator' => [ 'type' => 'string', 'enum' => [ 'DELETE', ], ], 'AuthChallengeRequest' => [ 'type' => 'structure', 'required' => [ 'authorizationUrl', ], 'members' => [ 'authorizationUrl' => [ 'shape' => 'Url', ], ], ], 'AuthChallengeRequestEvent' => [ 'type' => 'structure', 'required' => [ 'authorizationUrl', ], 'members' => [ 'authorizationUrl' => [ 'shape' => 'Url', ], ], 'event' => true, ], 'AuthChallengeResponse' => [ 'type' => 'structure', 'required' => [ 'responseMap', ], 'members' => [ 'responseMap' => [ 'shape' => 'AuthorizationResponseMap', ], ], ], 'AuthChallengeResponseEvent' => [ 'type' => 'structure', 'required' => [ 'responseMap', ], 'members' => [ 'responseMap' => [ 'shape' => 'AuthorizationResponseMap', ], ], 'event' => true, ], 'AuthResponseKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AuthResponseValue' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'AuthorizationResponseMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'AuthResponseKey', ], 'value' => [ 'shape' => 'AuthResponseValue', ], ], 'BasicAuthConfiguration' => [ 'type' => 'structure', 'required' => [ 'secretArn', 'roleArn', ], 'members' => [ 'secretArn' => [ 'shape' => 'SecretArn', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'BatchDeleteDocumentRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'documents', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'documents' => [ 'shape' => 'DeleteDocuments', ], 'dataSourceSyncId' => [ 'shape' => 'ExecutionId', ], ], ], 'BatchDeleteDocumentResponse' => [ 'type' => 'structure', 'members' => [ 'failedDocuments' => [ 'shape' => 'FailedDocuments', ], ], ], 'BatchPutDocumentRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'documents', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'documents' => [ 'shape' => 'Documents', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'dataSourceSyncId' => [ 'shape' => 'ExecutionId', ], ], ], 'BatchPutDocumentResponse' => [ 'type' => 'structure', 'members' => [ 'failedDocuments' => [ 'shape' => 'FailedDocuments', ], ], ], 'Blob' => [ 'type' => 'blob', ], 'BlockedPhrase' => [ 'type' => 'string', 'max' => 36, 'min' => 0, 'pattern' => '\\P{C}*', ], 'BlockedPhrases' => [ 'type' => 'list', 'member' => [ 'shape' => 'BlockedPhrase', ], 'max' => 5, 'min' => 0, ], 'BlockedPhrasesConfiguration' => [ 'type' => 'structure', 'members' => [ 'blockedPhrases' => [ 'shape' => 'BlockedPhrases', ], 'systemMessageOverride' => [ 'shape' => 'SystemMessageOverride', ], ], ], 'BlockedPhrasesConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'blockedPhrasesToCreateOrUpdate' => [ 'shape' => 'BlockedPhrases', ], 'blockedPhrasesToDelete' => [ 'shape' => 'BlockedPhrases', ], 'systemMessageOverride' => [ 'shape' => 'SystemMessageOverride', ], ], ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'BoostingDurationInSeconds' => [ 'type' => 'long', 'box' => true, 'max' => 999999999, 'min' => 0, ], 'ChatInput' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], 'userGroups' => [ 'shape' => 'UserGroups', 'location' => 'querystring', 'locationName' => 'userGroups', ], 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'querystring', 'locationName' => 'conversationId', ], 'parentMessageId' => [ 'shape' => 'MessageId', 'location' => 'querystring', 'locationName' => 'parentMessageId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, 'location' => 'querystring', 'locationName' => 'clientToken', ], 'inputStream' => [ 'shape' => 'ChatInputStream', ], ], 'payload' => 'inputStream', ], 'ChatInputStream' => [ 'type' => 'structure', 'members' => [ 'configurationEvent' => [ 'shape' => 'ConfigurationEvent', ], 'textEvent' => [ 'shape' => 'TextInputEvent', ], 'attachmentEvent' => [ 'shape' => 'AttachmentInputEvent', ], 'actionExecutionEvent' => [ 'shape' => 'ActionExecutionEvent', ], 'endOfInputEvent' => [ 'shape' => 'EndOfInputEvent', ], 'authChallengeResponseEvent' => [ 'shape' => 'AuthChallengeResponseEvent', ], ], 'eventstream' => true, ], 'ChatMode' => [ 'type' => 'string', 'enum' => [ 'RETRIEVAL_MODE', 'CREATOR_MODE', 'PLUGIN_MODE', ], ], 'ChatModeConfiguration' => [ 'type' => 'structure', 'members' => [ 'pluginConfiguration' => [ 'shape' => 'PluginConfiguration', ], ], 'union' => true, ], 'ChatOutput' => [ 'type' => 'structure', 'members' => [ 'outputStream' => [ 'shape' => 'ChatOutputStream', ], ], 'payload' => 'outputStream', ], 'ChatOutputStream' => [ 'type' => 'structure', 'members' => [ 'textEvent' => [ 'shape' => 'TextOutputEvent', ], 'metadataEvent' => [ 'shape' => 'MetadataEvent', ], 'actionReviewEvent' => [ 'shape' => 'ActionReviewEvent', ], 'failedAttachmentEvent' => [ 'shape' => 'FailedAttachmentEvent', ], 'authChallengeRequestEvent' => [ 'shape' => 'AuthChallengeRequestEvent', ], ], 'eventstream' => true, ], 'ChatSyncInput' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], 'userGroups' => [ 'shape' => 'UserGroups', 'location' => 'querystring', 'locationName' => 'userGroups', ], 'userMessage' => [ 'shape' => 'UserMessage', ], 'attachments' => [ 'shape' => 'AttachmentsInput', ], 'actionExecution' => [ 'shape' => 'ActionExecution', ], 'authChallengeResponse' => [ 'shape' => 'AuthChallengeResponse', ], 'conversationId' => [ 'shape' => 'ConversationId', ], 'parentMessageId' => [ 'shape' => 'MessageId', ], 'attributeFilter' => [ 'shape' => 'AttributeFilter', ], 'chatMode' => [ 'shape' => 'ChatMode', ], 'chatModeConfiguration' => [ 'shape' => 'ChatModeConfiguration', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'ChatSyncOutput' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'systemMessage' => [ 'shape' => 'String', ], 'systemMessageId' => [ 'shape' => 'MessageId', ], 'userMessageId' => [ 'shape' => 'MessageId', ], 'actionReview' => [ 'shape' => 'ActionReview', ], 'authChallengeRequest' => [ 'shape' => 'AuthChallengeRequest', ], 'sourceAttributions' => [ 'shape' => 'SourceAttributions', ], 'failedAttachments' => [ 'shape' => 'AttachmentsOutput', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'ConfigurationEvent' => [ 'type' => 'structure', 'members' => [ 'chatMode' => [ 'shape' => 'ChatMode', ], 'chatModeConfiguration' => [ 'shape' => 'ChatModeConfiguration', ], 'attributeFilter' => [ 'shape' => 'AttributeFilter', ], ], 'event' => true, ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', 'resourceId', 'resourceType', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'ContentBlockerRule' => [ 'type' => 'structure', 'members' => [ 'systemMessageOverride' => [ 'shape' => 'SystemMessageOverride', ], ], ], 'ContentRetrievalRule' => [ 'type' => 'structure', 'members' => [ 'eligibleDataSources' => [ 'shape' => 'EligibleDataSources', ], ], ], 'ContentType' => [ 'type' => 'string', 'enum' => [ 'PDF', 'HTML', 'MS_WORD', 'PLAIN_TEXT', 'PPT', 'RTF', 'XML', 'XSLT', 'MS_EXCEL', 'CSV', 'JSON', 'MD', ], ], 'Conversation' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'title' => [ 'shape' => 'ConversationTitle', ], 'startTime' => [ 'shape' => 'Timestamp', ], ], ], 'ConversationId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'ConversationTitle' => [ 'type' => 'string', ], 'Conversations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Conversation', ], ], 'CreateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'displayName', ], 'members' => [ 'displayName' => [ 'shape' => 'ApplicationName', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'identityCenterInstanceArn' => [ 'shape' => 'InstanceArn', ], 'description' => [ 'shape' => 'Description', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], 'tags' => [ 'shape' => 'Tags', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'attachmentsConfiguration' => [ 'shape' => 'AttachmentsConfiguration', ], ], ], 'CreateApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'applicationArn' => [ 'shape' => 'ApplicationArn', ], ], ], 'CreateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'displayName', 'configuration', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'configuration' => [ 'shape' => 'DataSourceConfiguration', ], 'vpcConfiguration' => [ 'shape' => 'DataSourceVpcConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'Tags', ], 'syncSchedule' => [ 'shape' => 'SyncSchedule', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], ], ], 'CreateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'dataSourceArn' => [ 'shape' => 'DataSourceArn', ], ], ], 'CreateIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'displayName', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'displayName' => [ 'shape' => 'IndexName', ], 'type' => [ 'shape' => 'IndexType', ], 'description' => [ 'shape' => 'Description', ], 'tags' => [ 'shape' => 'Tags', ], 'capacityConfiguration' => [ 'shape' => 'IndexCapacityConfiguration', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateIndexResponse' => [ 'type' => 'structure', 'members' => [ 'indexId' => [ 'shape' => 'IndexId', ], 'indexArn' => [ 'shape' => 'IndexArn', ], ], ], 'CreatePluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'displayName', 'type', 'authConfiguration', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'displayName' => [ 'shape' => 'PluginName', ], 'type' => [ 'shape' => 'PluginType', ], 'authConfiguration' => [ 'shape' => 'PluginAuthConfiguration', ], 'serverUrl' => [ 'shape' => 'Url', ], 'customPluginConfiguration' => [ 'shape' => 'CustomPluginConfiguration', ], 'tags' => [ 'shape' => 'Tags', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreatePluginResponse' => [ 'type' => 'structure', 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], 'pluginArn' => [ 'shape' => 'PluginArn', ], 'buildStatus' => [ 'shape' => 'PluginBuildStatus', ], ], ], 'CreateRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'type', 'displayName', 'configuration', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'type' => [ 'shape' => 'RetrieverType', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'configuration' => [ 'shape' => 'RetrieverConfiguration', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateRetrieverResponse' => [ 'type' => 'structure', 'members' => [ 'retrieverId' => [ 'shape' => 'RetrieverId', ], 'retrieverArn' => [ 'shape' => 'RetrieverArn', ], ], ], 'CreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'String', ], 'userAliases' => [ 'shape' => 'CreateUserRequestUserAliasesList', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateUserRequestUserAliasesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAlias', ], 'max' => 100, 'min' => 0, ], 'CreateUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'title' => [ 'shape' => 'WebExperienceTitle', ], 'subtitle' => [ 'shape' => 'WebExperienceSubtitle', ], 'welcomeMessage' => [ 'shape' => 'WebExperienceWelcomeMessage', ], 'samplePromptsControlMode' => [ 'shape' => 'WebExperienceSamplePromptsControlMode', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateWebExperienceResponse' => [ 'type' => 'structure', 'members' => [ 'webExperienceId' => [ 'shape' => 'WebExperienceId', ], 'webExperienceArn' => [ 'shape' => 'WebExperienceArn', ], ], ], 'CreatorModeConfiguration' => [ 'type' => 'structure', 'required' => [ 'creatorModeControl', ], 'members' => [ 'creatorModeControl' => [ 'shape' => 'CreatorModeControl', ], ], ], 'CreatorModeControl' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'CustomPluginConfiguration' => [ 'type' => 'structure', 'required' => [ 'description', 'apiSchemaType', 'apiSchema', ], 'members' => [ 'description' => [ 'shape' => 'PluginDescription', ], 'apiSchemaType' => [ 'shape' => 'APISchemaType', ], 'apiSchema' => [ 'shape' => 'APISchema', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'DataSourceName', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'type' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'DataSourceStatus', ], ], ], 'DataSourceArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'DataSourceConfiguration' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'DataSourceId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'DataSourceIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceId', ], 'max' => 1, 'min' => 1, ], 'DataSourceName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'DataSourceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_CREATION', 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'UPDATING', ], ], 'DataSourceSyncJob' => [ 'type' => 'structure', 'members' => [ 'executionId' => [ 'shape' => 'ExecutionId', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'endTime' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'DataSourceSyncJobStatus', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'dataSourceErrorCode' => [ 'shape' => 'String', ], 'metrics' => [ 'shape' => 'DataSourceSyncJobMetrics', ], ], ], 'DataSourceSyncJobMetrics' => [ 'type' => 'structure', 'members' => [ 'documentsAdded' => [ 'shape' => 'MetricValue', ], 'documentsModified' => [ 'shape' => 'MetricValue', ], 'documentsDeleted' => [ 'shape' => 'MetricValue', ], 'documentsFailed' => [ 'shape' => 'MetricValue', ], 'documentsScanned' => [ 'shape' => 'MetricValue', ], ], ], 'DataSourceSyncJobStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'SYNCING', 'INCOMPLETE', 'STOPPING', 'ABORTED', 'SYNCING_INDEXING', ], ], 'DataSourceSyncJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSyncJob', ], ], 'DataSourceUserId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '\\P{C}*', ], 'DataSourceVpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'subnetIds', 'securityGroupIds', ], 'members' => [ 'subnetIds' => [ 'shape' => 'SubnetIds', ], 'securityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'DataSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSource', ], ], 'DateAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], 'boostingDurationInSeconds' => [ 'shape' => 'BoostingDurationInSeconds', ], ], ], 'DeleteApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], ], ], 'DeleteApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteChatControlsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], ], ], 'DeleteChatControlsConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteConversationRequest' => [ 'type' => 'structure', 'required' => [ 'conversationId', 'applicationId', ], 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'uri', 'locationName' => 'conversationId', ], 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], ], ], 'DeleteConversationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'dataSourceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDocument' => [ 'type' => 'structure', 'required' => [ 'documentId', ], 'members' => [ 'documentId' => [ 'shape' => 'DocumentId', ], ], ], 'DeleteDocuments' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeleteDocument', ], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'groupName', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'groupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'groupName', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'querystring', 'locationName' => 'dataSourceId', ], ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'DeleteIndexResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeletePluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'pluginId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'pluginId' => [ 'shape' => 'PluginId', 'location' => 'uri', 'locationName' => 'pluginId', ], ], ], 'DeletePluginResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'retrieverId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', 'location' => 'uri', 'locationName' => 'retrieverId', ], ], ], 'DeleteRetrieverResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'userId', ], ], ], 'DeleteUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'webExperienceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', 'location' => 'uri', 'locationName' => 'webExperienceId', ], ], ], 'DeleteWebExperienceResponse' => [ 'type' => 'structure', 'members' => [], ], 'Description' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '\\P{C}*', ], 'Document' => [ 'type' => 'structure', 'required' => [ 'id', ], 'members' => [ 'id' => [ 'shape' => 'DocumentId', ], 'attributes' => [ 'shape' => 'DocumentAttributes', ], 'content' => [ 'shape' => 'DocumentContent', ], 'contentType' => [ 'shape' => 'ContentType', ], 'title' => [ 'shape' => 'Title', ], 'accessConfiguration' => [ 'shape' => 'AccessConfiguration', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], ], ], 'DocumentAttribute' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'DocumentAttributeKey', ], 'value' => [ 'shape' => 'DocumentAttributeValue', ], ], ], 'DocumentAttributeBoostingConfiguration' => [ 'type' => 'structure', 'members' => [ 'numberConfiguration' => [ 'shape' => 'NumberAttributeBoostingConfiguration', ], 'stringConfiguration' => [ 'shape' => 'StringAttributeBoostingConfiguration', ], 'dateConfiguration' => [ 'shape' => 'DateAttributeBoostingConfiguration', ], 'stringListConfiguration' => [ 'shape' => 'StringListAttributeBoostingConfiguration', ], ], 'union' => true, ], 'DocumentAttributeBoostingLevel' => [ 'type' => 'string', 'enum' => [ 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'VERY_HIGH', ], ], 'DocumentAttributeBoostingOverrideMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'DocumentAttributeKey', ], 'value' => [ 'shape' => 'DocumentAttributeBoostingConfiguration', ], 'min' => 1, ], 'DocumentAttributeCondition' => [ 'type' => 'structure', 'required' => [ 'key', 'operator', ], 'members' => [ 'key' => [ 'shape' => 'DocumentAttributeKey', ], 'operator' => [ 'shape' => 'DocumentEnrichmentConditionOperator', ], 'value' => [ 'shape' => 'DocumentAttributeValue', ], ], ], 'DocumentAttributeConfiguration' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DocumentMetadataConfigurationName', ], 'type' => [ 'shape' => 'AttributeType', ], 'search' => [ 'shape' => 'Status', ], ], ], 'DocumentAttributeConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocumentAttributeConfiguration', ], 'max' => 500, 'min' => 1, ], 'DocumentAttributeKey' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '[a-zA-Z0-9_][a-zA-Z0-9_-]*', ], 'DocumentAttributeStringListValue' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'DocumentAttributeTarget' => [ 'type' => 'structure', 'required' => [ 'key', ], 'members' => [ 'key' => [ 'shape' => 'DocumentAttributeKey', ], 'value' => [ 'shape' => 'DocumentAttributeValue', ], 'attributeValueOperator' => [ 'shape' => 'AttributeValueOperator', ], ], ], 'DocumentAttributeValue' => [ 'type' => 'structure', 'members' => [ 'stringValue' => [ 'shape' => 'DocumentAttributeValueStringValueString', ], 'stringListValue' => [ 'shape' => 'DocumentAttributeStringListValue', ], 'longValue' => [ 'shape' => 'Long', ], 'dateValue' => [ 'shape' => 'Timestamp', ], ], 'union' => true, ], 'DocumentAttributeValueStringValueString' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'DocumentAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocumentAttribute', ], 'max' => 500, 'min' => 1, ], 'DocumentContent' => [ 'type' => 'structure', 'members' => [ 'blob' => [ 'shape' => 'Blob', ], 's3' => [ 'shape' => 'S3', ], ], 'union' => true, ], 'DocumentContentOperator' => [ 'type' => 'string', 'enum' => [ 'DELETE', ], ], 'DocumentDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocumentDetails', ], ], 'DocumentDetails' => [ 'type' => 'structure', 'members' => [ 'documentId' => [ 'shape' => 'DocumentId', ], 'status' => [ 'shape' => 'DocumentStatus', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'DocumentEnrichmentConditionOperator' => [ 'type' => 'string', 'enum' => [ 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'EQUALS', 'NOT_EQUALS', 'CONTAINS', 'NOT_CONTAINS', 'EXISTS', 'NOT_EXISTS', 'BEGINS_WITH', ], ], 'DocumentEnrichmentConfiguration' => [ 'type' => 'structure', 'members' => [ 'inlineConfigurations' => [ 'shape' => 'InlineDocumentEnrichmentConfigurations', ], 'preExtractionHookConfiguration' => [ 'shape' => 'HookConfiguration', ], 'postExtractionHookConfiguration' => [ 'shape' => 'HookConfiguration', ], ], ], 'DocumentId' => [ 'type' => 'string', 'max' => 1825, 'min' => 1, 'pattern' => '\\P{C}*', ], 'DocumentMetadataConfigurationName' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9_][a-zA-Z0-9_-]*', ], 'DocumentStatus' => [ 'type' => 'string', 'enum' => [ 'RECEIVED', 'PROCESSING', 'INDEXED', 'UPDATED', 'FAILED', 'DELETING', 'DELETED', 'DOCUMENT_FAILED_TO_INDEX', ], ], 'Documents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Document', ], 'max' => 10, 'min' => 1, ], 'EligibleDataSource' => [ 'type' => 'structure', 'members' => [ 'indexId' => [ 'shape' => 'IndexId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], ], ], 'EligibleDataSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'EligibleDataSource', ], 'max' => 5, 'min' => 0, ], 'EncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'kmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'EndOfInputEvent' => [ 'type' => 'structure', 'members' => [], 'event' => true, ], 'ErrorCode' => [ 'type' => 'string', 'enum' => [ 'InternalError', 'InvalidRequest', 'ResourceInactive', 'ResourceNotFound', ], ], 'ErrorDetail' => [ 'type' => 'structure', 'members' => [ 'errorMessage' => [ 'shape' => 'ErrorMessage', ], 'errorCode' => [ 'shape' => 'ErrorCode', ], ], ], 'ErrorMessage' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '\\P{C}*', ], 'ExampleChatMessage' => [ 'type' => 'string', 'max' => 350, 'min' => 0, 'pattern' => '\\P{C}*', ], 'ExampleChatMessages' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExampleChatMessage', ], 'max' => 5, 'min' => 0, ], 'ExecutionId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'FailedAttachmentEvent' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'userMessageId' => [ 'shape' => 'MessageId', ], 'systemMessageId' => [ 'shape' => 'MessageId', ], 'attachment' => [ 'shape' => 'AttachmentOutput', ], ], 'event' => true, ], 'FailedDocument' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'DocumentId', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], ], ], 'FailedDocuments' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedDocument', ], ], 'GetApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], ], ], 'GetApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'ApplicationName', ], 'applicationId' => [ 'shape' => 'ApplicationId', ], 'applicationArn' => [ 'shape' => 'ApplicationArn', ], 'identityCenterApplicationArn' => [ 'shape' => 'IdcApplicationArn', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'ApplicationStatus', ], 'description' => [ 'shape' => 'Description', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'attachmentsConfiguration' => [ 'shape' => 'AppliedAttachmentsConfiguration', ], ], ], 'GetChatControlsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForGetTopicConfigurations', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetChatControlsConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'responseScope' => [ 'shape' => 'ResponseScope', ], 'blockedPhrases' => [ 'shape' => 'BlockedPhrasesConfiguration', ], 'topicConfigurations' => [ 'shape' => 'TopicConfigurations', ], 'creatorModeConfiguration' => [ 'shape' => 'AppliedCreatorModeConfiguration', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'dataSourceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'indexId' => [ 'shape' => 'IndexId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'dataSourceArn' => [ 'shape' => 'DataSourceArn', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'type' => [ 'shape' => 'String', ], 'configuration' => [ 'shape' => 'DataSourceConfiguration', ], 'vpcConfiguration' => [ 'shape' => 'DataSourceVpcConfiguration', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'description' => [ 'shape' => 'Description', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'syncSchedule' => [ 'shape' => 'SyncSchedule', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], ], ], 'GetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'groupName', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'groupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'groupName', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'querystring', 'locationName' => 'dataSourceId', ], ], ], 'GetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'GroupStatusDetail', ], 'statusHistory' => [ 'shape' => 'GroupStatusDetails', ], ], ], 'GetIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'GetIndexResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'indexId' => [ 'shape' => 'IndexId', ], 'displayName' => [ 'shape' => 'IndexName', ], 'type' => [ 'shape' => 'IndexType', ], 'indexArn' => [ 'shape' => 'IndexArn', ], 'status' => [ 'shape' => 'IndexStatus', ], 'description' => [ 'shape' => 'Description', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'capacityConfiguration' => [ 'shape' => 'IndexCapacityConfiguration', ], 'documentAttributeConfigurations' => [ 'shape' => 'DocumentAttributeConfigurations', ], 'error' => [ 'shape' => 'ErrorDetail', ], 'indexStatistics' => [ 'shape' => 'IndexStatistics', ], ], ], 'GetPluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'pluginId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'pluginId' => [ 'shape' => 'PluginId', 'location' => 'uri', 'locationName' => 'pluginId', ], ], ], 'GetPluginResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'pluginId' => [ 'shape' => 'PluginId', ], 'displayName' => [ 'shape' => 'PluginName', ], 'type' => [ 'shape' => 'PluginType', ], 'serverUrl' => [ 'shape' => 'Url', ], 'authConfiguration' => [ 'shape' => 'PluginAuthConfiguration', ], 'customPluginConfiguration' => [ 'shape' => 'CustomPluginConfiguration', ], 'buildStatus' => [ 'shape' => 'PluginBuildStatus', ], 'pluginArn' => [ 'shape' => 'PluginArn', ], 'state' => [ 'shape' => 'PluginState', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'GetRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'retrieverId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', 'location' => 'uri', 'locationName' => 'retrieverId', ], ], ], 'GetRetrieverResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', ], 'retrieverArn' => [ 'shape' => 'RetrieverArn', ], 'type' => [ 'shape' => 'RetrieverType', ], 'status' => [ 'shape' => 'RetrieverStatus', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'configuration' => [ 'shape' => 'RetrieverConfiguration', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'GetUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'userId', ], ], ], 'GetUserResponse' => [ 'type' => 'structure', 'members' => [ 'userAliases' => [ 'shape' => 'UserAliases', ], ], ], 'GetWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'webExperienceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', 'location' => 'uri', 'locationName' => 'webExperienceId', ], ], ], 'GetWebExperienceResponse' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', ], 'webExperienceArn' => [ 'shape' => 'WebExperienceArn', ], 'defaultEndpoint' => [ 'shape' => 'Url', ], 'status' => [ 'shape' => 'WebExperienceStatus', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'title' => [ 'shape' => 'WebExperienceTitle', ], 'subtitle' => [ 'shape' => 'WebExperienceSubtitle', ], 'welcomeMessage' => [ 'shape' => 'WebExperienceWelcomeMessage', ], 'samplePromptsControlMode' => [ 'shape' => 'WebExperienceSamplePromptsControlMode', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'authenticationConfiguration' => [ 'shape' => 'WebExperienceAuthConfiguration', 'deprecated' => true, 'deprecatedMessage' => 'Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.', ], 'error' => [ 'shape' => 'ErrorDetail', ], ], ], 'GroupMembers' => [ 'type' => 'structure', 'members' => [ 'memberGroups' => [ 'shape' => 'MemberGroups', ], 'memberUsers' => [ 'shape' => 'MemberUsers', ], ], ], 'GroupName' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '\\P{C}*', ], 'GroupStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'PROCESSING', 'DELETING', 'DELETED', ], ], 'GroupStatusDetail' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'GroupStatus', ], 'lastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'errorDetail' => [ 'shape' => 'ErrorDetail', ], ], ], 'GroupStatusDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupStatusDetail', ], ], 'GroupSummary' => [ 'type' => 'structure', 'members' => [ 'groupName' => [ 'shape' => 'GroupName', ], ], ], 'GroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupSummary', ], ], 'HookConfiguration' => [ 'type' => 'structure', 'members' => [ 'invocationCondition' => [ 'shape' => 'DocumentAttributeCondition', ], 'lambdaArn' => [ 'shape' => 'LambdaArn', ], 's3BucketName' => [ 'shape' => 'S3BucketName', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'IdcApplicationArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 10, 'pattern' => 'arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}', ], 'Index' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'IndexName', ], 'indexId' => [ 'shape' => 'IndexId', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'IndexStatus', ], ], ], 'IndexArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'IndexCapacityConfiguration' => [ 'type' => 'structure', 'members' => [ 'units' => [ 'shape' => 'IndexCapacityInteger', ], ], ], 'IndexCapacityInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'IndexId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'IndexName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'IndexStatistics' => [ 'type' => 'structure', 'members' => [ 'textDocumentStatistics' => [ 'shape' => 'TextDocumentStatistics', ], ], ], 'IndexStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'UPDATING', ], ], 'IndexType' => [ 'type' => 'string', 'enum' => [ 'ENTERPRISE', 'STARTER', ], ], 'IndexedTextBytes' => [ 'type' => 'long', 'box' => true, 'min' => 0, ], 'IndexedTextDocument' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'Indices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Index', ], ], 'InlineDocumentEnrichmentConfiguration' => [ 'type' => 'structure', 'members' => [ 'condition' => [ 'shape' => 'DocumentAttributeCondition', ], 'target' => [ 'shape' => 'DocumentAttributeTarget', ], 'documentContentOperator' => [ 'shape' => 'DocumentContentOperator', ], ], ], 'InlineDocumentEnrichmentConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InlineDocumentEnrichmentConfiguration', ], 'max' => 100, 'min' => 1, ], 'InstanceArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 10, 'pattern' => 'arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}', ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'KendraIndexConfiguration' => [ 'type' => 'structure', 'required' => [ 'indexId', ], 'members' => [ 'indexId' => [ 'shape' => 'KendraIndexId', ], ], ], 'KendraIndexId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'sensitive' => true, ], 'LambdaArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?', ], 'LicenseNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ListApplicationsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListApplications', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListApplicationsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'applications' => [ 'shape' => 'Applications', ], ], ], 'ListConversationsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListConversations', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListConversationsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'conversations' => [ 'shape' => 'Conversations', ], ], ], 'ListDataSourceSyncJobsRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'applicationId', 'indexId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListDataSourcesSyncJobs', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'startTime' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'startTime', ], 'endTime' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'endTime', ], 'statusFilter' => [ 'shape' => 'DataSourceSyncJobStatus', 'location' => 'querystring', 'locationName' => 'syncStatus', ], ], ], 'ListDataSourceSyncJobsResponse' => [ 'type' => 'structure', 'members' => [ 'history' => [ 'shape' => 'DataSourceSyncJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListDataSources', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'dataSources' => [ 'shape' => 'DataSources', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDocumentsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'dataSourceIds' => [ 'shape' => 'DataSourceIds', 'location' => 'querystring', 'locationName' => 'dataSourceIds', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListDocuments', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListDocumentsResponse' => [ 'type' => 'structure', 'members' => [ 'documentDetailList' => [ 'shape' => 'DocumentDetailList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'updatedEarlierThan', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'updatedEarlierThan' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'updatedEarlierThan', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'querystring', 'locationName' => 'dataSourceId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListGroupsRequest', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'items' => [ 'shape' => 'GroupSummaryList', ], ], ], 'ListIndicesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListIndices', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListIndicesResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'indices' => [ 'shape' => 'Indices', ], ], ], 'ListMessagesRequest' => [ 'type' => 'structure', 'required' => [ 'conversationId', 'applicationId', ], 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'uri', 'locationName' => 'conversationId', ], 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListMessages', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListMessagesResponse' => [ 'type' => 'structure', 'members' => [ 'messages' => [ 'shape' => 'Messages', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPluginsRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListPlugins', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPluginsResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'plugins' => [ 'shape' => 'Plugins', ], ], ], 'ListRetrieversRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListRetrieversRequest', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRetrieversResponse' => [ 'type' => 'structure', 'members' => [ 'retrievers' => [ 'shape' => 'Retrievers', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceARN', ], 'members' => [ 'resourceARN' => [ 'shape' => 'AmazonResourceName', 'location' => 'uri', 'locationName' => 'resourceARN', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListWebExperiencesRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResultsIntegerForListWebExperiencesRequest', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListWebExperiencesResponse' => [ 'type' => 'structure', 'members' => [ 'webExperiences' => [ 'shape' => 'WebExperiences', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'MaxResultsIntegerForGetTopicConfigurations' => [ 'type' => 'integer', 'box' => true, 'max' => 50, 'min' => 1, ], 'MaxResultsIntegerForListApplications' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListConversations' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListDataSources' => [ 'type' => 'integer', 'box' => true, 'max' => 10, 'min' => 1, ], 'MaxResultsIntegerForListDataSourcesSyncJobs' => [ 'type' => 'integer', 'box' => true, 'max' => 10, 'min' => 1, ], 'MaxResultsIntegerForListDocuments' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListGroupsRequest' => [ 'type' => 'integer', 'box' => true, 'max' => 10, 'min' => 1, ], 'MaxResultsIntegerForListIndices' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListMessages' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxResultsIntegerForListPlugins' => [ 'type' => 'integer', 'box' => true, 'max' => 50, 'min' => 1, ], 'MaxResultsIntegerForListRetrieversRequest' => [ 'type' => 'integer', 'box' => true, 'max' => 50, 'min' => 1, ], 'MaxResultsIntegerForListWebExperiencesRequest' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MemberGroup' => [ 'type' => 'structure', 'required' => [ 'groupName', ], 'members' => [ 'groupName' => [ 'shape' => 'GroupName', ], 'type' => [ 'shape' => 'MembershipType', ], ], ], 'MemberGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberGroup', ], 'max' => 1000, 'min' => 1, ], 'MemberRelation' => [ 'type' => 'string', 'enum' => [ 'AND', 'OR', ], ], 'MemberUser' => [ 'type' => 'structure', 'required' => [ 'userId', ], 'members' => [ 'userId' => [ 'shape' => 'DataSourceUserId', ], 'type' => [ 'shape' => 'MembershipType', ], ], ], 'MemberUsers' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberUser', ], 'max' => 1000, 'min' => 1, ], 'MembershipType' => [ 'type' => 'string', 'enum' => [ 'INDEX', 'DATASOURCE', ], ], 'Message' => [ 'type' => 'structure', 'members' => [ 'messageId' => [ 'shape' => 'String', ], 'body' => [ 'shape' => 'MessageBody', ], 'time' => [ 'shape' => 'Timestamp', ], 'type' => [ 'shape' => 'MessageType', ], 'attachments' => [ 'shape' => 'AttachmentsOutput', ], 'sourceAttribution' => [ 'shape' => 'SourceAttributions', ], 'actionReview' => [ 'shape' => 'ActionReview', ], 'actionExecution' => [ 'shape' => 'ActionExecution', ], ], ], 'MessageBody' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '\\P{C}*$}', ], 'MessageId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'MessageType' => [ 'type' => 'string', 'enum' => [ 'USER', 'SYSTEM', ], ], 'MessageUsefulness' => [ 'type' => 'string', 'enum' => [ 'USEFUL', 'NOT_USEFUL', ], ], 'MessageUsefulnessComment' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '\\P{C}*', ], 'MessageUsefulnessFeedback' => [ 'type' => 'structure', 'required' => [ 'usefulness', 'submittedAt', ], 'members' => [ 'usefulness' => [ 'shape' => 'MessageUsefulness', ], 'reason' => [ 'shape' => 'MessageUsefulnessReason', ], 'comment' => [ 'shape' => 'MessageUsefulnessComment', ], 'submittedAt' => [ 'shape' => 'Timestamp', ], ], ], 'MessageUsefulnessReason' => [ 'type' => 'string', 'enum' => [ 'NOT_FACTUALLY_CORRECT', 'HARMFUL_OR_UNSAFE', 'INCORRECT_OR_MISSING_SOURCES', 'NOT_HELPFUL', 'FACTUALLY_CORRECT', 'COMPLETE', 'RELEVANT_SOURCES', 'HELPFUL', 'NOT_BASED_ON_DOCUMENTS', 'NOT_COMPLETE', 'NOT_CONCISE', 'OTHER', ], ], 'Messages' => [ 'type' => 'list', 'member' => [ 'shape' => 'Message', ], ], 'MetadataEvent' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'userMessageId' => [ 'shape' => 'MessageId', ], 'systemMessageId' => [ 'shape' => 'MessageId', ], 'sourceAttributions' => [ 'shape' => 'SourceAttributions', ], 'finalTextMessage' => [ 'shape' => 'String', ], ], 'event' => true, ], 'MetricValue' => [ 'type' => 'string', 'pattern' => '(([1-9][0-9]*)|0)', ], 'NativeIndexConfiguration' => [ 'type' => 'structure', 'required' => [ 'indexId', ], 'members' => [ 'indexId' => [ 'shape' => 'IndexId', ], 'boostingOverride' => [ 'shape' => 'DocumentAttributeBoostingOverrideMap', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 800, 'min' => 1, ], 'NoAuthConfiguration' => [ 'type' => 'structure', 'members' => [], ], 'NumberAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], 'boostingType' => [ 'shape' => 'NumberAttributeBoostingType', ], ], ], 'NumberAttributeBoostingType' => [ 'type' => 'string', 'enum' => [ 'PRIORITIZE_LARGER_VALUES', 'PRIORITIZE_SMALLER_VALUES', ], ], 'OAuth2ClientCredentialConfiguration' => [ 'type' => 'structure', 'required' => [ 'secretArn', 'roleArn', ], 'members' => [ 'secretArn' => [ 'shape' => 'SecretArn', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'Payload' => [ 'type' => 'string', 'sensitive' => true, ], 'Plugin' => [ 'type' => 'structure', 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], 'displayName' => [ 'shape' => 'PluginName', ], 'type' => [ 'shape' => 'PluginType', ], 'serverUrl' => [ 'shape' => 'Url', ], 'state' => [ 'shape' => 'PluginState', ], 'buildStatus' => [ 'shape' => 'PluginBuildStatus', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'PluginArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'PluginAuthConfiguration' => [ 'type' => 'structure', 'members' => [ 'basicAuthConfiguration' => [ 'shape' => 'BasicAuthConfiguration', ], 'oAuth2ClientCredentialConfiguration' => [ 'shape' => 'OAuth2ClientCredentialConfiguration', ], 'noAuthConfiguration' => [ 'shape' => 'NoAuthConfiguration', ], ], 'union' => true, ], 'PluginBuildStatus' => [ 'type' => 'string', 'enum' => [ 'READY', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_FAILED', ], ], 'PluginConfiguration' => [ 'type' => 'structure', 'required' => [ 'pluginId', ], 'members' => [ 'pluginId' => [ 'shape' => 'PluginId', ], ], ], 'PluginDescription' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'PluginId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}', ], 'PluginName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'PluginState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'PluginType' => [ 'type' => 'string', 'enum' => [ 'SERVICE_NOW', 'SALESFORCE', 'JIRA', 'ZENDESK', 'CUSTOM', ], ], 'Plugins' => [ 'type' => 'list', 'member' => [ 'shape' => 'Plugin', ], ], 'Principal' => [ 'type' => 'structure', 'members' => [ 'user' => [ 'shape' => 'PrincipalUser', ], 'group' => [ 'shape' => 'PrincipalGroup', ], ], 'union' => true, ], 'PrincipalGroup' => [ 'type' => 'structure', 'required' => [ 'access', ], 'members' => [ 'name' => [ 'shape' => 'GroupName', ], 'access' => [ 'shape' => 'ReadAccessType', ], 'membershipType' => [ 'shape' => 'MembershipType', ], ], ], 'PrincipalUser' => [ 'type' => 'structure', 'required' => [ 'access', ], 'members' => [ 'id' => [ 'shape' => 'UserId', ], 'access' => [ 'shape' => 'ReadAccessType', ], 'membershipType' => [ 'shape' => 'MembershipType', ], ], ], 'Principals' => [ 'type' => 'list', 'member' => [ 'shape' => 'Principal', ], ], 'PutFeedbackRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'conversationId', 'messageId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'userId', ], 'conversationId' => [ 'shape' => 'ConversationId', 'location' => 'uri', 'locationName' => 'conversationId', ], 'messageId' => [ 'shape' => 'SystemMessageId', 'location' => 'uri', 'locationName' => 'messageId', ], 'messageCopiedAt' => [ 'shape' => 'Timestamp', ], 'messageUsefulness' => [ 'shape' => 'MessageUsefulnessFeedback', ], ], ], 'PutGroupRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'groupName', 'type', 'groupMembers', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'groupName' => [ 'shape' => 'GroupName', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'type' => [ 'shape' => 'MembershipType', ], 'groupMembers' => [ 'shape' => 'GroupMembers', ], ], ], 'PutGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'ReadAccessType' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', 'resourceId', 'resourceType', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResponseScope' => [ 'type' => 'string', 'enum' => [ 'ENTERPRISE_CONTENT_ONLY', 'EXTENDED_KNOWLEDGE_ENABLED', ], ], 'Retriever' => [ 'type' => 'structure', 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', ], 'type' => [ 'shape' => 'RetrieverType', ], 'status' => [ 'shape' => 'RetrieverStatus', ], 'displayName' => [ 'shape' => 'RetrieverName', ], ], ], 'RetrieverArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'RetrieverConfiguration' => [ 'type' => 'structure', 'members' => [ 'nativeIndexConfiguration' => [ 'shape' => 'NativeIndexConfiguration', ], 'kendraIndexConfiguration' => [ 'shape' => 'KendraIndexConfiguration', ], ], 'union' => true, ], 'RetrieverId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'RetrieverName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'RetrieverStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'FAILED', ], ], 'RetrieverType' => [ 'type' => 'string', 'enum' => [ 'NATIVE_INDEX', 'KENDRA_INDEX', ], ], 'Retrievers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Retriever', ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'ruleType', ], 'members' => [ 'includedUsersAndGroups' => [ 'shape' => 'UsersAndGroups', ], 'excludedUsersAndGroups' => [ 'shape' => 'UsersAndGroups', ], 'ruleType' => [ 'shape' => 'RuleType', ], 'ruleConfiguration' => [ 'shape' => 'RuleConfiguration', ], ], ], 'RuleConfiguration' => [ 'type' => 'structure', 'members' => [ 'contentBlockerRule' => [ 'shape' => 'ContentBlockerRule', ], 'contentRetrievalRule' => [ 'shape' => 'ContentRetrievalRule', ], ], 'union' => true, ], 'RuleType' => [ 'type' => 'string', 'enum' => [ 'CONTENT_BLOCKER_RULE', 'CONTENT_RETRIEVAL_RULE', ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], 'max' => 10, 'min' => 0, ], 'S3' => [ 'type' => 'structure', 'required' => [ 'bucket', 'key', ], 'members' => [ 'bucket' => [ 'shape' => 'S3BucketName', ], 'key' => [ 'shape' => 'S3ObjectKey', ], ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'S3ObjectKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SamlAttribute' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'SamlConfiguration' => [ 'type' => 'structure', 'required' => [ 'metadataXML', 'roleArn', 'userIdAttribute', ], 'members' => [ 'metadataXML' => [ 'shape' => 'SamlMetadataXML', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'userIdAttribute' => [ 'shape' => 'SamlAttribute', ], 'userGroupAttribute' => [ 'shape' => 'SamlAttribute', ], ], ], 'SamlMetadataXML' => [ 'type' => 'string', 'max' => 10000000, 'min' => 1000, 'pattern' => '.*', ], 'SecretArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 10, 'min' => 1, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', 'resourceId', 'resourceType', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'SnippetExcerpt' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'SnippetExcerptText', ], ], ], 'SnippetExcerptText' => [ 'type' => 'string', ], 'SourceAttribution' => [ 'type' => 'structure', 'members' => [ 'title' => [ 'shape' => 'String', ], 'snippet' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'String', ], 'citationNumber' => [ 'shape' => 'Integer', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'textMessageSegments' => [ 'shape' => 'TextSegmentList', ], ], ], 'SourceAttributions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAttribution', ], ], 'StartDataSourceSyncJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'applicationId', 'indexId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'StartDataSourceSyncJobResponse' => [ 'type' => 'structure', 'members' => [ 'executionId' => [ 'shape' => 'ExecutionId', ], ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'StopDataSourceSyncJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'applicationId', 'indexId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], ], ], 'StopDataSourceSyncJobResponse' => [ 'type' => 'structure', 'members' => [], ], 'String' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'StringAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], 'attributeValueBoosting' => [ 'shape' => 'StringAttributeValueBoosting', ], ], ], 'StringAttributeValueBoosting' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'StringAttributeValueBoostingLevel', ], 'max' => 10, 'min' => 1, ], 'StringAttributeValueBoostingLevel' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', 'VERY_HIGH', ], ], 'StringListAttributeBoostingConfiguration' => [ 'type' => 'structure', 'required' => [ 'boostingLevel', ], 'members' => [ 'boostingLevel' => [ 'shape' => 'DocumentAttributeBoostingLevel', ], ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '[-0-9a-zA-Z]+', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], ], 'SyncSchedule' => [ 'type' => 'string', 'max' => 998, 'min' => 0, 'pattern' => '\\P{C}*', ], 'SystemMessageId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{35}', ], 'SystemMessageOverride' => [ 'type' => 'string', 'max' => 350, 'min' => 0, 'pattern' => '\\P{C}*', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceARN', 'tags', ], 'members' => [ 'resourceARN' => [ 'shape' => 'AmazonResourceName', 'location' => 'uri', 'locationName' => 'resourceARN', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'TextDocumentStatistics' => [ 'type' => 'structure', 'members' => [ 'indexedTextBytes' => [ 'shape' => 'IndexedTextBytes', ], 'indexedTextDocumentCount' => [ 'shape' => 'IndexedTextDocument', ], ], ], 'TextInputEvent' => [ 'type' => 'structure', 'required' => [ 'userMessage', ], 'members' => [ 'userMessage' => [ 'shape' => 'UserMessage', ], ], 'event' => true, ], 'TextOutputEvent' => [ 'type' => 'structure', 'members' => [ 'conversationId' => [ 'shape' => 'ConversationId', ], 'userMessageId' => [ 'shape' => 'MessageId', ], 'systemMessageId' => [ 'shape' => 'MessageId', ], 'systemMessage' => [ 'shape' => 'String', ], ], 'event' => true, ], 'TextSegment' => [ 'type' => 'structure', 'members' => [ 'beginOffset' => [ 'shape' => 'Integer', ], 'endOffset' => [ 'shape' => 'Integer', ], 'snippetExcerpt' => [ 'shape' => 'SnippetExcerpt', ], ], ], 'TextSegmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TextSegment', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'Title' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'TopicConfiguration' => [ 'type' => 'structure', 'required' => [ 'name', 'rules', ], 'members' => [ 'name' => [ 'shape' => 'TopicConfigurationName', ], 'description' => [ 'shape' => 'TopicDescription', ], 'exampleChatMessages' => [ 'shape' => 'ExampleChatMessages', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'TopicConfigurationName' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]{0,35}', ], 'TopicConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicConfiguration', ], 'max' => 10, 'min' => 0, ], 'TopicDescription' => [ 'type' => 'string', 'max' => 350, 'min' => 0, 'pattern' => '\\P{C}*', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceARN', 'tagKeys', ], 'members' => [ 'resourceARN' => [ 'shape' => 'AmazonResourceName', 'location' => 'uri', 'locationName' => 'resourceARN', ], 'tagKeys' => [ 'shape' => 'TagKeys', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'identityCenterInstanceArn' => [ 'shape' => 'InstanceArn', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'description' => [ 'shape' => 'Description', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'attachmentsConfiguration' => [ 'shape' => 'AttachmentsConfiguration', ], ], ], 'UpdateApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateChatControlsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'responseScope' => [ 'shape' => 'ResponseScope', ], 'blockedPhrasesConfigurationUpdate' => [ 'shape' => 'BlockedPhrasesConfigurationUpdate', ], 'topicConfigurationsToCreateOrUpdate' => [ 'shape' => 'TopicConfigurations', ], 'topicConfigurationsToDelete' => [ 'shape' => 'TopicConfigurations', ], 'creatorModeConfiguration' => [ 'shape' => 'CreatorModeConfiguration', ], ], ], 'UpdateChatControlsConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', 'dataSourceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'displayName' => [ 'shape' => 'DataSourceName', ], 'configuration' => [ 'shape' => 'DataSourceConfiguration', ], 'vpcConfiguration' => [ 'shape' => 'DataSourceVpcConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'syncSchedule' => [ 'shape' => 'SyncSchedule', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'documentEnrichmentConfiguration' => [ 'shape' => 'DocumentEnrichmentConfiguration', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateIndexRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'indexId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'indexId' => [ 'shape' => 'IndexId', 'location' => 'uri', 'locationName' => 'indexId', ], 'displayName' => [ 'shape' => 'ApplicationName', ], 'description' => [ 'shape' => 'Description', ], 'capacityConfiguration' => [ 'shape' => 'IndexCapacityConfiguration', ], 'documentAttributeConfigurations' => [ 'shape' => 'DocumentAttributeConfigurations', ], ], ], 'UpdateIndexResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePluginRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'pluginId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'pluginId' => [ 'shape' => 'PluginId', 'location' => 'uri', 'locationName' => 'pluginId', ], 'displayName' => [ 'shape' => 'PluginName', ], 'state' => [ 'shape' => 'PluginState', ], 'serverUrl' => [ 'shape' => 'Url', ], 'customPluginConfiguration' => [ 'shape' => 'CustomPluginConfiguration', ], 'authConfiguration' => [ 'shape' => 'PluginAuthConfiguration', ], ], ], 'UpdatePluginResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateRetrieverRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'retrieverId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'retrieverId' => [ 'shape' => 'RetrieverId', 'location' => 'uri', 'locationName' => 'retrieverId', ], 'configuration' => [ 'shape' => 'RetrieverConfiguration', ], 'displayName' => [ 'shape' => 'RetrieverName', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateRetrieverResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateUserRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'userId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'userId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'userId', ], 'userAliasesToUpdate' => [ 'shape' => 'UserAliases', ], 'userAliasesToDelete' => [ 'shape' => 'UserAliases', ], ], ], 'UpdateUserResponse' => [ 'type' => 'structure', 'members' => [ 'userAliasesAdded' => [ 'shape' => 'UserAliases', ], 'userAliasesUpdated' => [ 'shape' => 'UserAliases', ], 'userAliasesDeleted' => [ 'shape' => 'UserAliases', ], ], ], 'UpdateWebExperienceRequest' => [ 'type' => 'structure', 'required' => [ 'applicationId', 'webExperienceId', ], 'members' => [ 'applicationId' => [ 'shape' => 'ApplicationId', 'location' => 'uri', 'locationName' => 'applicationId', ], 'webExperienceId' => [ 'shape' => 'WebExperienceId', 'location' => 'uri', 'locationName' => 'webExperienceId', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'authenticationConfiguration' => [ 'shape' => 'WebExperienceAuthConfiguration', 'deprecated' => true, 'deprecatedMessage' => 'Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.', ], 'title' => [ 'shape' => 'WebExperienceTitle', ], 'subtitle' => [ 'shape' => 'WebExperienceSubtitle', ], 'welcomeMessage' => [ 'shape' => 'WebExperienceWelcomeMessage', ], 'samplePromptsControlMode' => [ 'shape' => 'WebExperienceSamplePromptsControlMode', ], ], ], 'UpdateWebExperienceResponse' => [ 'type' => 'structure', 'members' => [], ], 'Url' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(https?|ftp|file)://([^\\s]*)', ], 'UserAlias' => [ 'type' => 'structure', 'required' => [ 'userId', ], 'members' => [ 'indexId' => [ 'shape' => 'IndexId', ], 'dataSourceId' => [ 'shape' => 'DataSourceId', ], 'userId' => [ 'shape' => 'String', ], ], ], 'UserAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAlias', ], ], 'UserGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UserId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '\\P{C}*', ], 'UserIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UserMessage' => [ 'type' => 'string', 'max' => 7000, 'min' => 1, ], 'UsersAndGroups' => [ 'type' => 'structure', 'members' => [ 'userIds' => [ 'shape' => 'UserIds', ], 'userGroups' => [ 'shape' => 'UserGroups', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', 'reason', ], 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], 'fields' => [ 'shape' => 'ValidationExceptionFields', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'name', 'message', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], ], 'ValidationExceptionFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'CANNOT_PARSE', 'FIELD_VALIDATION_FAILED', 'UNKNOWN_OPERATION', ], ], 'WebExperience' => [ 'type' => 'structure', 'members' => [ 'webExperienceId' => [ 'shape' => 'WebExperienceId', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'defaultEndpoint' => [ 'shape' => 'Url', ], 'status' => [ 'shape' => 'WebExperienceStatus', ], ], ], 'WebExperienceArn' => [ 'type' => 'string', 'max' => 1284, 'min' => 0, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'WebExperienceAuthConfiguration' => [ 'type' => 'structure', 'members' => [ 'samlConfiguration' => [ 'shape' => 'SamlConfiguration', ], ], 'union' => true, ], 'WebExperienceId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9-]*', ], 'WebExperienceSamplePromptsControlMode' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'WebExperienceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'FAILED', 'PENDING_AUTH_CONFIG', ], ], 'WebExperienceSubtitle' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '\\P{C}*', ], 'WebExperienceTitle' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '\\P{C}*', ], 'WebExperienceWelcomeMessage' => [ 'type' => 'string', 'max' => 300, 'min' => 0, ], 'WebExperiences' => [ 'type' => 'list', 'member' => [ 'shape' => 'WebExperience', ], ], ],]; diff --git a/src/data/qbusiness/2023-11-27/docs-2.json b/src/data/qbusiness/2023-11-27/docs-2.json index bc32535618..3ed937a1a7 100644 --- a/src/data/qbusiness/2023-11-27/docs-2.json +++ b/src/data/qbusiness/2023-11-27/docs-2.json @@ -1,11 +1,12 @@ { "version": "2.0", - "service": "

Amazon Q is in preview release and is subject to change.

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

You can use the following AWS SDKs to access Amazon Q Business APIs:

The following resources provide additional information about using the Amazon Q Business API:

", + "service": "

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

You can use the following AWS SDKs to access Amazon Q Business APIs:

The following resources provide additional information about using the Amazon Q Business API:

", "operations": { "BatchDeleteDocument": "

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

", "BatchPutDocument": "

Adds one or more documents to an Amazon Q Business index.

You use this API to:

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

", + "Chat": "

Starts or continues a streaming Amazon Q Business conversation.

", "ChatSync": "

Starts or continues a non-streaming Amazon Q Business conversation.

", - "CreateApplication": "

Creates an Amazon Q Business application.

", + "CreateApplication": "

Creates an Amazon Q Business application.

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

", "CreateDataSource": "

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

", "CreateIndex": "

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

", "CreatePlugin": "

Creates an Amazon Q Business plugin.

", @@ -59,6 +60,18 @@ "UpdateWebExperience": "

Updates an Amazon Q Business web experience.

" }, "shapes": { + "APISchema": { + "base": "

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

", + "refs": { + "CustomPluginConfiguration$apiSchema": "

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

" + } + }, + "APISchemaType": { + "base": null, + "refs": { + "CustomPluginConfiguration$apiSchemaType": "

The type of OpenAPI schema to use.

" + } + }, "AccessConfiguration": { "base": "

Used to configure access permissions for a document.

", "refs": { @@ -89,10 +102,17 @@ "Message$actionExecution": null } }, + "ActionExecutionEvent": { + "base": "

A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.

", + "refs": { + "ChatInputStream$actionExecutionEvent": "

A request from an end user to perform an Amazon Q Business plugin action.

" + } + }, "ActionExecutionPayload": { "base": null, "refs": { - "ActionExecution$payload": "

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

" + "ActionExecution$payload": "

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

", + "ActionExecutionEvent$payload": "

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

" } }, "ActionExecutionPayloadField": { @@ -112,7 +132,9 @@ "base": null, "refs": { "ActionExecution$payloadFieldNameSeparator": "

A string used to retain information about the hierarchical contexts within an action execution event payload.

", - "ActionReview$payloadFieldNameSeparator": "

A string used to retain information about the hierarchical contexts within an action review payload.

" + "ActionExecutionEvent$payloadFieldNameSeparator": "

A string used to retain information about the hierarchical contexts within a action execution event payload.

", + "ActionReview$payloadFieldNameSeparator": "

A string used to retain information about the hierarchical contexts within an action review payload.

", + "ActionReviewEvent$payloadFieldNameSeparator": "

A string used to retain information about the hierarchical contexts within an action review event payload.

" } }, "ActionPayloadFieldType": { @@ -126,8 +148,8 @@ "refs": { "ActionExecutionPayloadField$value": "

The content of a user input field in an plugin action execution payload.

", "ActionReviewPayloadField$value": "

The field value.

", - "ActionReviewPayloadFieldAllowedValue$displayValue": "

The name of the field.

", - "ActionReviewPayloadFieldAllowedValue$value": "

The field value.

" + "ActionReviewPayloadFieldAllowedValue$value": "

The field value.

", + "ActionReviewPayloadFieldAllowedValue$displayValue": "

The name of the field.

" } }, "ActionReview": { @@ -137,10 +159,17 @@ "Message$actionReview": null } }, + "ActionReviewEvent": { + "base": "

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

", + "refs": { + "ChatOutputStream$actionReviewEvent": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

" + } + }, "ActionReviewPayload": { "base": null, "refs": { - "ActionReview$payload": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" + "ActionReview$payload": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

", + "ActionReviewEvent$payload": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" } }, "ActionReviewPayloadField": { @@ -188,6 +217,7 @@ "Application$applicationId": "

The identifier for the Amazon Q Business application.

", "BatchDeleteDocumentRequest$applicationId": "

The identifier of the Amazon Q Business application.

", "BatchPutDocumentRequest$applicationId": "

The identifier of the Amazon Q Business application.

", + "ChatInput$applicationId": "

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

", "ChatSyncInput$applicationId": "

The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

", "CreateApplicationResponse$applicationId": "

The identifier of the Amazon Q Business application.

", "CreateDataSourceRequest$applicationId": "

The identifier of the Amazon Q Business application the data source will be attached to.

", @@ -284,9 +314,16 @@ "AttachmentInput": { "base": "

A file directly uploaded into a web experience chat.

", "refs": { + "AttachmentInputEvent$attachment": null, "AttachmentsInput$member": null } }, + "AttachmentInputEvent": { + "base": "

A file input event activated by a end user request to upload files into their web experience chat.

", + "refs": { + "ChatInputStream$attachmentEvent": "

A request by an end user to upload a file during chat.

" + } + }, "AttachmentName": { "base": null, "refs": { @@ -297,7 +334,8 @@ "AttachmentOutput": { "base": "

The details of a file uploaded during chat.

", "refs": { - "AttachmentsOutput$member": null + "AttachmentsOutput$member": null, + "FailedAttachmentEvent$attachment": null } }, "AttachmentStatus": { @@ -338,7 +376,8 @@ "refs": { "AttributeFilter$notFilter": "

Performs a logical NOT operation on all supplied filters.

", "AttributeFilters$member": null, - "ChatSyncInput$attributeFilter": "

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

" + "ChatSyncInput$attributeFilter": "

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

", + "ConfigurationEvent$attributeFilter": null } }, "AttributeFilters": { @@ -360,6 +399,49 @@ "DocumentAttributeTarget$attributeValueOperator": "

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

" } }, + "AuthChallengeRequest": { + "base": "

A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.

", + "refs": { + "ChatSyncOutput$authChallengeRequest": "

An authentication verification event activated by an end user request to use a custom plugin.

" + } + }, + "AuthChallengeRequestEvent": { + "base": "

An authentication verification event activated by an end user request to use a custom plugin.

", + "refs": { + "ChatOutputStream$authChallengeRequestEvent": "

An authentication verification event activated by an end user request to use a custom plugin.

" + } + }, + "AuthChallengeResponse": { + "base": "

Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.

", + "refs": { + "ChatSyncInput$authChallengeResponse": "

An authentication verification event response by a third party authentication server to Amazon Q Business.

" + } + }, + "AuthChallengeResponseEvent": { + "base": "

An authentication verification event response by a third party authentication server to Amazon Q Business.

", + "refs": { + "ChatInputStream$authChallengeResponseEvent": "

An authentication verification event response by a third party authentication server to Amazon Q Business.

" + } + }, + "AuthResponseKey": { + "base": null, + "refs": { + "AuthorizationResponseMap$key": null + } + }, + "AuthResponseValue": { + "base": null, + "refs": { + "AuthorizationResponseMap$value": null + } + }, + "AuthorizationResponseMap": { + "base": null, + "refs": { + "AuthChallengeResponse$responseMap": "

The mapping of key-value pairs in an authentication challenge response.

", + "AuthChallengeResponseEvent$responseMap": "

The mapping of key-value pairs in an authentication challenge response.

" + } + }, "BasicAuthConfiguration": { "base": "

Information about the basic authentication credentials used to configure a plugin.

", "refs": { @@ -431,16 +513,40 @@ "DateAttributeBoostingConfiguration$boostingDurationInSeconds": "

Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

" } }, + "ChatInput": { + "base": null, + "refs": { + } + }, + "ChatInputStream": { + "base": "

The streaming input for the Chat API.

", + "refs": { + "ChatInput$inputStream": "

The streaming input for the Chat API.

" + } + }, "ChatMode": { "base": null, "refs": { - "ChatSyncInput$chatMode": "

The chat modes available in an Amazon Q Business web experience.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

" + "ChatSyncInput$chatMode": "

The chat modes available to an Amazon Q Business end user.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

", + "ConfigurationEvent$chatMode": "

The chat modes available to an Amazon Q Business end user.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

" } }, "ChatModeConfiguration": { "base": "

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

", "refs": { - "ChatSyncInput$chatModeConfiguration": "

The chat mode configuration for an Amazon Q Business application.

" + "ChatSyncInput$chatModeConfiguration": "

The chat mode configuration for an Amazon Q Business application.

", + "ConfigurationEvent$chatModeConfiguration": null + } + }, + "ChatOutput": { + "base": null, + "refs": { + } + }, + "ChatOutputStream": { + "base": "

The streaming output for the Chat API.

", + "refs": { + "ChatOutput$outputStream": "

The streaming output for the Chat API.

" } }, "ChatSyncInput": { @@ -456,6 +562,7 @@ "ClientToken": { "base": null, "refs": { + "ChatInput$clientToken": "

A token that you provide to identify the chat input.

", "ChatSyncInput$clientToken": "

A token that you provide to identify a chat request.

", "CreateApplicationRequest$clientToken": "

A token that you provide to identify the request to create your Amazon Q Business application.

", "CreateDataSourceRequest$clientToken": "

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

", @@ -467,6 +574,12 @@ "UpdateChatControlsConfigurationRequest$clientToken": "

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

" } }, + "ConfigurationEvent": { + "base": "

A configuration event activated by an end user request to select a specific chat mode.

", + "refs": { + "ChatInputStream$configurationEvent": "

A configuration event activated by an end user request to select a specific chat mode.

" + } + }, "ConflictException": { "base": "

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

", "refs": { @@ -499,12 +612,17 @@ "ConversationId": { "base": null, "refs": { + "ActionReviewEvent$conversationId": "

The identifier of the conversation with which the action review event is associated.

", + "ChatInput$conversationId": "

The identifier of the Amazon Q Business conversation.

", "ChatSyncInput$conversationId": "

The identifier of the Amazon Q Business conversation.

", "ChatSyncOutput$conversationId": "

The identifier of the Amazon Q Business conversation.

", "Conversation$conversationId": "

The identifier of the Amazon Q Business conversation.

", "DeleteConversationRequest$conversationId": "

The identifier of the Amazon Q Business web experience conversation being deleted.

", + "FailedAttachmentEvent$conversationId": "

The identifier of the conversation associated with the failed file upload.

", "ListMessagesRequest$conversationId": "

The identifier of the Amazon Q Business web experience conversation.

", - "PutFeedbackRequest$conversationId": "

The identifier of the conversation the feedback is attached to.

" + "MetadataEvent$conversationId": "

The identifier of the conversation with which the generated metadata is associated.

", + "PutFeedbackRequest$conversationId": "

The identifier of the conversation the feedback is attached to.

", + "TextOutputEvent$conversationId": "

The identifier of the conversation with which the text output event is associated.

" } }, "ConversationTitle": { @@ -608,6 +726,14 @@ "CreatorModeConfiguration$creatorModeControl": "

Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.

" } }, + "CustomPluginConfiguration": { + "base": "

Configuration information required to create a custom plugin.

", + "refs": { + "CreatePluginRequest$customPluginConfiguration": "

Contains configuration for a custom plugin.

", + "GetPluginResponse$customPluginConfiguration": "

Configuration information required to create a custom plugin.

", + "UpdatePluginRequest$customPluginConfiguration": "

The configuration for a custom plugin.

" + } + }, "DataSource": { "base": "

A data source in an Amazon Q Business application.

", "refs": { @@ -859,9 +985,9 @@ "DocumentAttribute": { "base": "

A document attribute or metadata field.

", "refs": { + "AttributeFilter$equalsTo": "

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

", "AttributeFilter$containsAll": "

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

", "AttributeFilter$containsAny": "

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

", - "AttributeFilter$equalsTo": "

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

", "AttributeFilter$greaterThan": "

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

", "AttributeFilter$greaterThanOrEquals": "

Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

", "AttributeFilter$lessThan": "

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

", @@ -978,7 +1104,7 @@ "DocumentEnrichmentConditionOperator": { "base": null, "refs": { - "DocumentAttributeCondition$operator": "

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

" + "DocumentAttributeCondition$operator": "

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

" } }, "DocumentEnrichmentConfiguration": { @@ -999,6 +1125,12 @@ "FailedDocument$id": "

The identifier of the document that couldn't be removed from the Amazon Q Business index.

" } }, + "DocumentMetadataConfigurationName": { + "base": null, + "refs": { + "DocumentAttributeConfiguration$name": "

The name of the document attribute.

" + } + }, "DocumentStatus": { "base": null, "refs": { @@ -1030,6 +1162,12 @@ "GetApplicationResponse$encryptionConfiguration": "

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

" } }, + "EndOfInputEvent": { + "base": "

The end of the streaming input for the Chat API.

", + "refs": { + "ChatInputStream$endOfInputEvent": "

The end of the streaming input for the Chat API.

" + } + }, "ErrorCode": { "base": null, "refs": { @@ -1085,6 +1223,12 @@ "StartDataSourceSyncJobResponse$executionId": "

The identifier for a particular synchronization job.

" } }, + "FailedAttachmentEvent": { + "base": "

A failed file upload during web experience chat.

", + "refs": { + "ChatOutputStream$failedAttachmentEvent": "

A failed file upload event during a web experience chat.

" + } + }, "FailedDocument": { "base": "

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

", "refs": { @@ -1237,10 +1381,10 @@ } }, "HookConfiguration": { - "base": "

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

", + "base": "

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

", "refs": { - "DocumentEnrichmentConfiguration$postExtractionHookConfiguration": null, - "DocumentEnrichmentConfiguration$preExtractionHookConfiguration": null + "DocumentEnrichmentConfiguration$preExtractionHookConfiguration": null, + "DocumentEnrichmentConfiguration$postExtractionHookConfiguration": null } }, "IdcApplicationArn": { @@ -1327,6 +1471,13 @@ "Index$status": "

The current status of the index. When the status is ACTIVE, the index is ready.

" } }, + "IndexType": { + "base": null, + "refs": { + "CreateIndexRequest$type": "

The index type that's suitable for your needs. For more information on what's included in each type of index or index tier, see Amazon Q Business tiers.

", + "GetIndexResponse$type": "

The type of index attached to your Amazon Q Business application.

" + } + }, "IndexedTextBytes": { "base": null, "refs": { @@ -1360,7 +1511,8 @@ "InstanceArn": { "base": null, "refs": { - "CreateApplicationRequest$identityCenterInstanceArn": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

" + "CreateApplicationRequest$identityCenterInstanceArn": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

", + "UpdateApplicationRequest$identityCenterInstanceArn": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

" } }, "Integer": { @@ -1660,9 +1812,18 @@ "MessageId": { "base": null, "refs": { + "ActionReviewEvent$userMessageId": "

The identifier of the conversation with which the plugin action is associated.

", + "ActionReviewEvent$systemMessageId": "

The identifier of an Amazon Q Business AI generated associated with the action review event.

", + "ChatInput$parentMessageId": "

The identifier used to associate a user message with a AI generated response.

", "ChatSyncInput$parentMessageId": "

The identifier of the previous end user text input message in a conversation.

", "ChatSyncOutput$systemMessageId": "

The identifier of an Amazon Q Business AI generated message within the conversation.

", - "ChatSyncOutput$userMessageId": "

The identifier of an Amazon Q Business end user text input message within the conversation.

" + "ChatSyncOutput$userMessageId": "

The identifier of an Amazon Q Business end user text input message within the conversation.

", + "FailedAttachmentEvent$userMessageId": "

The identifier of the end user chat message associated with the file upload.

", + "FailedAttachmentEvent$systemMessageId": "

The identifier of the AI-generated message associated with the file upload.

", + "MetadataEvent$userMessageId": "

The identifier of an Amazon Q Business end user text input message within the conversation.

", + "MetadataEvent$systemMessageId": "

The identifier of an Amazon Q Business AI generated message within the conversation.

", + "TextOutputEvent$userMessageId": "

The identifier of an end user message in a TextOutputEvent.

", + "TextOutputEvent$systemMessageId": "

The identifier of an AI-generated message in a TextOutputEvent.

" } }, "MessageType": { @@ -1701,13 +1862,19 @@ "ListMessagesResponse$messages": "

An array of information on one or more messages.

" } }, + "MetadataEvent": { + "base": "

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

", + "refs": { + "ChatOutputStream$metadataEvent": "

A metadata event for a AI-generated text output message in a Amazon Q Business conversation.

" + } + }, "MetricValue": { "base": null, "refs": { "DataSourceSyncJobMetrics$documentsAdded": "

The current count of documents added from the data source during the data source sync.

", + "DataSourceSyncJobMetrics$documentsModified": "

The current count of documents modified in the data source during the data source sync.

", "DataSourceSyncJobMetrics$documentsDeleted": "

The current count of documents deleted from the data source during the data source sync.

", "DataSourceSyncJobMetrics$documentsFailed": "

The current count of documents that failed to sync from the data source during the data source sync.

", - "DataSourceSyncJobMetrics$documentsModified": "

The current count of documents modified in the data source during the data source sync.

", "DataSourceSyncJobMetrics$documentsScanned": "

The current count of documents crawled by the ongoing sync job in the data source.

" } }, @@ -1746,6 +1913,12 @@ "ListWebExperiencesResponse$nextToken": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

" } }, + "NoAuthConfiguration": { + "base": "

Information about invoking a custom plugin without any authentication or authorization requirement.

", + "refs": { + "PluginAuthConfiguration$noAuthConfiguration": "

Information about invoking a custom plugin without any authentication.

" + } + }, "NumberAttributeBoostingConfiguration": { "base": "

Provides information on boosting NUMBER type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

", "refs": { @@ -1764,6 +1937,12 @@ "PluginAuthConfiguration$oAuth2ClientCredentialConfiguration": "

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" } }, + "Payload": { + "base": null, + "refs": { + "APISchema$payload": "

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

" + } + }, "Plugin": { "base": "

Information about an Amazon Q Business plugin and its configuration.

", "refs": { @@ -1785,17 +1964,33 @@ "UpdatePluginRequest$authConfiguration": "

The authentication configuration the plugin is using.

" } }, + "PluginBuildStatus": { + "base": null, + "refs": { + "CreatePluginResponse$buildStatus": "

The current status of a plugin. A plugin is modified asynchronously.

", + "GetPluginResponse$buildStatus": "

The current status of a plugin. A plugin is modified asynchronously.

", + "Plugin$buildStatus": "

The status of the plugin.

" + } + }, "PluginConfiguration": { "base": "

Configuration information required to invoke chat in PLUGIN_MODE.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

", "refs": { "ChatModeConfiguration$pluginConfiguration": "

Configuration information required to invoke chat in PLUGIN_MODE.

" } }, + "PluginDescription": { + "base": null, + "refs": { + "CustomPluginConfiguration$description": "

A description for your custom plugin configuration.

" + } + }, "PluginId": { "base": null, "refs": { "ActionExecution$pluginId": "

The identifier of the plugin the action is attached to.

", + "ActionExecutionEvent$pluginId": "

The identifier of the plugin for which the action is being requested.

", "ActionReview$pluginId": "

The identifier of the plugin associated with the action review.

", + "ActionReviewEvent$pluginId": "

The identifier of the plugin associated with the action review event.

", "CreatePluginResponse$pluginId": "

The identifier of the plugin created.

", "DeletePluginRequest$pluginId": "

The identifier of the plugin being deleted.

", "GetPluginRequest$pluginId": "

The identifier of the plugin.

", @@ -1826,6 +2021,7 @@ "base": null, "refs": { "ActionReview$pluginType": "

The type of plugin.

", + "ActionReviewEvent$pluginType": "

The type of plugin.

", "CreatePluginRequest$type": "

The type of plugin you want to create.

", "GetPluginResponse$type": "

The type of the plugin.

", "Plugin$type": "

The type of the plugin.

" @@ -1975,7 +2171,8 @@ "SamlConfiguration$roleArn": "

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

", "UpdateApplicationRequest$roleArn": "

An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.

", "UpdateDataSourceRequest$roleArn": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

", - "UpdateRetrieverRequest$roleArn": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

" + "UpdateRetrieverRequest$roleArn": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

", + "UpdateWebExperienceRequest$roleArn": "

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

" } }, "Rule": { @@ -2005,6 +2202,7 @@ "S3": { "base": "

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

", "refs": { + "APISchema$s3": "

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

", "DocumentContent$s3": "

The path to the document in an Amazon S3 bucket.

" } }, @@ -2024,8 +2222,8 @@ "SamlAttribute": { "base": null, "refs": { - "SamlConfiguration$userGroupAttribute": "

The group attribute name in your IdP that maps to user groups.

", - "SamlConfiguration$userIdAttribute": "

The user attribute name in your IdP that maps to the user email.

" + "SamlConfiguration$userIdAttribute": "

The user attribute name in your IdP that maps to the user email.

", + "SamlConfiguration$userGroupAttribute": "

The group attribute name in your IdP that maps to user groups.

" } }, "SamlConfiguration": { @@ -2064,6 +2262,18 @@ "refs": { } }, + "SnippetExcerpt": { + "base": "

Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

", + "refs": { + "TextSegment$snippetExcerpt": "

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

" + } + }, + "SnippetExcerptText": { + "base": null, + "refs": { + "SnippetExcerpt$text": "

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.

" + } + }, "SourceAttribution": { "base": "

The documents used to generate an Amazon Q Business web experience response.

", "refs": { @@ -2074,7 +2284,8 @@ "base": null, "refs": { "ChatSyncOutput$sourceAttributions": "

The source documents used to generate the conversation response.

", - "Message$sourceAttribution": "

The source documents used to generate Amazon Q Business web experience message.

" + "Message$sourceAttribution": "

The source documents used to generate Amazon Q Business web experience message.

", + "MetadataEvent$sourceAttributions": "

The source documents used to generate the conversation response.

" } }, "StartDataSourceSyncJobRequest": { @@ -2107,6 +2318,8 @@ "base": null, "refs": { "ActionReviewPayloadField$displayName": "

The name of the field.

", + "ActionReviewPayloadField$displayDescription": "

The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.

", + "ActionReviewPayloadField$allowedFormat": "

The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.

", "ChatSyncOutput$systemMessage": "

An AI-generated message in a conversation.

", "ConflictException$resourceId": "

The identifier of the resource affected.

", "ConflictException$resourceType": "

The type of the resource affected.

", @@ -2114,25 +2327,26 @@ "DataSource$type": "

The type of the Amazon Q Business data source.

", "DataSourceSyncJob$dataSourceErrorCode": "

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

", "DeleteUserRequest$userId": "

The user email being deleted.

", - "DocumentAttributeConfiguration$name": "

The name of the document attribute.

", "DocumentAttributeStringListValue$member": null, "GetDataSourceResponse$type": "

The type of the data source connector. For example, S3.

", "GetUserRequest$userId": "

The user email address attached to the user.

", "Message$messageId": "

The identifier of the Amazon Q Business web experience message.

", + "MetadataEvent$finalTextMessage": "

The final text output message generated by the system.

", "ResourceNotFoundException$resourceId": "

The identifier of the resource affected.

", "ResourceNotFoundException$resourceType": "

The type of the resource affected.

", "ServiceQuotaExceededException$resourceId": "

The identifier of the resource affected.

", "ServiceQuotaExceededException$resourceType": "

The type of the resource affected.

", - "SourceAttribution$snippet": "

The content extract from the document on which the generated response is based.

", "SourceAttribution$title": "

The title of the document which is the source for the Amazon Q Business generated response.

", + "SourceAttribution$snippet": "

The content extract from the document on which the generated response is based.

", "SourceAttribution$url": "

The URL of the document which is the source for the Amazon Q Business generated response.

", "StringAttributeValueBoosting$key": null, + "TextOutputEvent$systemMessage": "

An AI-generated message in a TextOutputEvent.

", "UpdateUserRequest$userId": "

The email id attached to the user.

", "UserAlias$userId": "

The identifier of the user id associated with the user aliases.

", "UserGroups$member": null, "UserIds$member": null, - "ValidationExceptionField$message": "

A message about the validation exception.

", - "ValidationExceptionField$name": "

The field name where the invalid entry was detected.

" + "ValidationExceptionField$name": "

The field name where the invalid entry was detected.

", + "ValidationExceptionField$message": "

A message about the validation exception.

" } }, "StringAttributeBoostingConfiguration": { @@ -2247,6 +2461,18 @@ "IndexStatistics$textDocumentStatistics": "

The number of documents indexed.

" } }, + "TextInputEvent": { + "base": "

An input event for a end user message in an Amazon Q Business web experience.

", + "refs": { + "ChatInputStream$textEvent": "

Information about the payload of the ChatInputStream event containing the end user message input.

" + } + }, + "TextOutputEvent": { + "base": "

An output event for an AI-generated response in an Amazon Q Business web experience.

", + "refs": { + "ChatOutputStream$textEvent": "

Information about the payload of the ChatOutputStream event containing the AI-generated message output.

" + } + }, "TextSegment": { "base": "

Provides information about a text extract in a chat response that can be attributed to a source document.

", "refs": { @@ -2272,8 +2498,8 @@ "Conversation$startTime": "

The start time of the conversation.

", "DataSource$createdAt": "

The Unix timestamp when the Amazon Q Business data source was created.

", "DataSource$updatedAt": "

The Unix timestamp when the Amazon Q Business data source was last updated.

", - "DataSourceSyncJob$endTime": "

The Unix timestamp when the synchronization job completed.

", "DataSourceSyncJob$startTime": "

The Unix time stamp when the data source synchronization job started.

", + "DataSourceSyncJob$endTime": "

The Unix timestamp when the synchronization job completed.

", "DocumentAttributeValue$dateValue": "

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

", "DocumentDetails$createdAt": "

The timestamp for when the document was created.

", "DocumentDetails$updatedAt": "

The timestamp for when the document was last updated.

", @@ -2287,13 +2513,13 @@ "GetPluginResponse$updatedAt": "

The timestamp for when the plugin was last updated.

", "GetRetrieverResponse$createdAt": "

The Unix timestamp when the retriever was created.

", "GetRetrieverResponse$updatedAt": "

The Unix timestamp when the retriever was last updated.

", - "GetWebExperienceResponse$createdAt": "

The Unix timestamp when the retriever was created.

", - "GetWebExperienceResponse$updatedAt": "

The Unix timestamp when the data source connector was last updated.

", + "GetWebExperienceResponse$createdAt": "

The Unix timestamp when the Amazon Q Business web experience was last created.

", + "GetWebExperienceResponse$updatedAt": "

The Unix timestamp when the Amazon Q Business web experience was last updated.

", "GroupStatusDetail$lastUpdatedAt": "

The Unix timestamp when the Amazon Q Business application was last updated.

", "Index$createdAt": "

The Unix timestamp when the index was created.

", "Index$updatedAt": "

The Unix timestamp when the index was last updated.

", - "ListDataSourceSyncJobsRequest$endTime": "

The end time of the data source connector sync.

", "ListDataSourceSyncJobsRequest$startTime": "

The start time of the data source connector sync.

", + "ListDataSourceSyncJobsRequest$endTime": "

The end time of the data source connector sync.

", "ListGroupsRequest$updatedEarlierThan": "

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

", "Message$time": "

The timestamp of the first Amazon Q Business web experience message.

", "MessageUsefulnessFeedback$submittedAt": "

The timestamp for when the feedback was submitted.

", @@ -2430,6 +2656,8 @@ "Url": { "base": null, "refs": { + "AuthChallengeRequest$authorizationUrl": "

The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.

", + "AuthChallengeRequestEvent$authorizationUrl": "

The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.

", "CreatePluginRequest$serverUrl": "

The source URL used for plugin configuration.

", "GetPluginResponse$serverUrl": "

The source URL used for plugin configuration.

", "GetWebExperienceResponse$defaultEndpoint": "

The endpoint of your Amazon Q Business web experience.

", @@ -2449,16 +2677,17 @@ "base": null, "refs": { "GetUserResponse$userAliases": "

A list of user aliases attached to a user.

", - "UpdateUserRequest$userAliasesToDelete": "

The user aliases attached to the user id that are to be deleted.

", "UpdateUserRequest$userAliasesToUpdate": "

The user aliases attached to the user id that are to be updated.

", + "UpdateUserRequest$userAliasesToDelete": "

The user aliases attached to the user id that are to be deleted.

", "UpdateUserResponse$userAliasesAdded": "

The user aliases that have been to be added to a user id.

", - "UpdateUserResponse$userAliasesDeleted": "

The user aliases that have been deleted from a user id.

", - "UpdateUserResponse$userAliasesUpdated": "

The user aliases attached to a user id that have been updated.

" + "UpdateUserResponse$userAliasesUpdated": "

The user aliases attached to a user id that have been updated.

", + "UpdateUserResponse$userAliasesDeleted": "

The user aliases that have been deleted from a user id.

" } }, "UserGroups": { "base": null, "refs": { + "ChatInput$userGroups": "

The groups that a user associated with the chat input belongs to.

", "ChatSyncInput$userGroups": "

The groups that a user associated with the chat input belongs to.

", "UsersAndGroups$userGroups": "

The user groups associated with a topic control rule.

" } @@ -2466,6 +2695,7 @@ "UserId": { "base": null, "refs": { + "ChatInput$userId": "

The identifier of the user attached to the chat input.

", "ChatSyncInput$userId": "

The identifier of the user attached to the chat input.

", "DeleteConversationRequest$userId": "

The identifier of the user who is deleting the conversation.

", "ListConversationsRequest$userId": "

The identifier of the user involved in the Amazon Q Business web experience conversation.

", @@ -2483,14 +2713,15 @@ "UserMessage": { "base": null, "refs": { - "ChatSyncInput$userMessage": "

A end user message in a conversation.

" + "ChatSyncInput$userMessage": "

A end user message in a conversation.

", + "TextInputEvent$userMessage": "

A user message in a text message input event.

" } }, "UsersAndGroups": { "base": "

Provides information about users and groups associated with a topic control rule.

", "refs": { - "Rule$excludedUsersAndGroups": "

Users and groups to be excluded from a rule.

", - "Rule$includedUsersAndGroups": "

Users and groups to be included in a rule.

" + "Rule$includedUsersAndGroups": "

Users and groups to be included in a rule.

", + "Rule$excludedUsersAndGroups": "

Users and groups to be excluded from a rule.

" } }, "ValidationException": { diff --git a/src/data/qbusiness/2023-11-27/docs-2.json.php b/src/data/qbusiness/2023-11-27/docs-2.json.php index c63134bc65..4fa7d7b366 100644 --- a/src/data/qbusiness/2023-11-27/docs-2.json.php +++ b/src/data/qbusiness/2023-11-27/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon Q is in preview release and is subject to change.

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

You can use the following AWS SDKs to access Amazon Q Business APIs:

The following resources provide additional information about using the Amazon Q Business API:

', 'operations' => [ 'BatchDeleteDocument' => '

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

', 'BatchPutDocument' => '

Adds one or more documents to an Amazon Q Business index.

You use this API to:

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

', 'ChatSync' => '

Starts or continues a non-streaming Amazon Q Business conversation.

', 'CreateApplication' => '

Creates an Amazon Q Business application.

', 'CreateDataSource' => '

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

', 'CreateIndex' => '

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

', 'CreatePlugin' => '

Creates an Amazon Q Business plugin.

', 'CreateRetriever' => '

Adds a retriever to your Amazon Q Business application.

', 'CreateUser' => '

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

', 'CreateWebExperience' => '

Creates an Amazon Q Business web experience.

', 'DeleteApplication' => '

Deletes an Amazon Q Business application.

', 'DeleteChatControlsConfiguration' => '

Deletes chat controls configured for an existing Amazon Q Business application.

', 'DeleteConversation' => '

Deletes an Amazon Q Business web experience conversation.

', 'DeleteDataSource' => '

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

', 'DeleteGroup' => '

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.

If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.

', 'DeleteIndex' => '

Deletes an Amazon Q Business index.

', 'DeletePlugin' => '

Deletes an Amazon Q Business plugin.

', 'DeleteRetriever' => '

Deletes the retriever used by an Amazon Q Business application.

', 'DeleteUser' => '

Deletes a user by email id.

', 'DeleteWebExperience' => '

Deletes an Amazon Q Business web experience.

', 'GetApplication' => '

Gets information about an existing Amazon Q Business application.

', 'GetChatControlsConfiguration' => '

Gets information about an chat controls configured for an existing Amazon Q Business application.

', 'GetDataSource' => '

Gets information about an existing Amazon Q Business data source connector.

', 'GetGroup' => '

Describes a group by group name.

', 'GetIndex' => '

Gets information about an existing Amazon Q Business index.

', 'GetPlugin' => '

Gets information about an existing Amazon Q Business plugin.

', 'GetRetriever' => '

Gets information about an existing retriever used by an Amazon Q Business application.

', 'GetUser' => '

Describes the universally unique identifier (UUID) associated with a local user in a data source.

', 'GetWebExperience' => '

Gets information about an existing Amazon Q Business web experience.

', 'ListApplications' => '

Lists Amazon Q Business applications.

', 'ListConversations' => '

Lists one or more Amazon Q Business conversations.

', 'ListDataSourceSyncJobs' => '

Get information about an Amazon Q Business data source connector synchronization.

', 'ListDataSources' => '

Lists the Amazon Q Business data source connectors that you have created.

', 'ListDocuments' => '

A list of documents attached to an index.

', 'ListGroups' => '

Provides a list of groups that are mapped to users.

', 'ListIndices' => '

Lists the Amazon Q Business indices you have created.

', 'ListMessages' => '

Gets a list of messages associated with an Amazon Q Business web experience.

', 'ListPlugins' => '

Lists configured Amazon Q Business plugins.

', 'ListRetrievers' => '

Lists the retriever used by an Amazon Q Business application.

', 'ListTagsForResource' => '

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

', 'ListWebExperiences' => '

Lists one or more Amazon Q Business Web Experiences.

', 'PutFeedback' => '

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

', 'PutGroup' => '

Create, or updates, a mapping of users—who have access to a document—to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

', 'StartDataSourceSyncJob' => '

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

', 'StopDataSourceSyncJob' => '

Stops an Amazon Q Business data source connector synchronization job already in progress.

', 'TagResource' => '

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

', 'UntagResource' => '

Removes a tag from an Amazon Q Business application or a data source.

', 'UpdateApplication' => '

Updates an existing Amazon Q Business application.

', 'UpdateChatControlsConfiguration' => '

Updates an set of chat controls configured for an existing Amazon Q Business application.

', 'UpdateDataSource' => '

Updates an existing Amazon Q Business data source connector.

', 'UpdateIndex' => '

Updates an Amazon Q Business index.

', 'UpdatePlugin' => '

Updates an Amazon Q Business plugin.

', 'UpdateRetriever' => '

Updates the retriever used for your Amazon Q Business application.

', 'UpdateUser' => '

Updates a information associated with a user id.

', 'UpdateWebExperience' => '

Updates an Amazon Q Business web experience.

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

Used to configure access permissions for a document.

', 'refs' => [ 'Document$accessConfiguration' => '

Configuration information for access permission to a document.

', ], ], 'AccessControl' => [ 'base' => '

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

', 'refs' => [ 'AccessControls$member' => NULL, ], ], 'AccessControls' => [ 'base' => NULL, 'refs' => [ 'AccessConfiguration$accessControls' => '

A list of AccessControlList objects.

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

You don\'t have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

', 'refs' => [], ], 'ActionExecution' => [ 'base' => '

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

', 'refs' => [ 'ChatSyncInput$actionExecution' => '

A request from an end user to perform an Amazon Q Business plugin action.

', 'Message$actionExecution' => NULL, ], ], 'ActionExecutionPayload' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$payload' => '

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

', ], ], 'ActionExecutionPayloadField' => [ 'base' => '

A user input field in an plugin action execution payload.

', 'refs' => [ 'ActionExecutionPayload$value' => NULL, ], ], 'ActionPayloadFieldKey' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionPayload$key' => NULL, 'ActionReviewPayload$key' => NULL, ], ], 'ActionPayloadFieldNameSeparator' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$payloadFieldNameSeparator' => '

A string used to retain information about the hierarchical contexts within an action execution event payload.

', 'ActionReview$payloadFieldNameSeparator' => '

A string used to retain information about the hierarchical contexts within an action review payload.

', ], ], 'ActionPayloadFieldType' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$type' => '

The type of field.

', ], ], 'ActionPayloadFieldValue' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionPayloadField$value' => '

The content of a user input field in an plugin action execution payload.

', 'ActionReviewPayloadField$value' => '

The field value.

', 'ActionReviewPayloadFieldAllowedValue$displayValue' => '

The name of the field.

', 'ActionReviewPayloadFieldAllowedValue$value' => '

The field value.

', ], ], 'ActionReview' => [ 'base' => '

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

', 'refs' => [ 'ChatSyncOutput$actionReview' => '

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

', 'Message$actionReview' => NULL, ], ], 'ActionReviewPayload' => [ 'base' => NULL, 'refs' => [ 'ActionReview$payload' => '

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', ], ], 'ActionReviewPayloadField' => [ 'base' => '

A user input field in an plugin action review payload.

', 'refs' => [ 'ActionReviewPayload$value' => NULL, ], ], 'ActionReviewPayloadFieldAllowedValue' => [ 'base' => '

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', 'refs' => [ 'ActionReviewPayloadFieldAllowedValues$member' => NULL, ], ], 'ActionReviewPayloadFieldAllowedValues' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$allowedValues' => '

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceARN' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.

', 'TagResourceRequest$resourceARN' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.

', 'UntagResourceRequest$resourceARN' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.

', ], ], 'Application' => [ 'base' => '

Summary information for an Amazon Q Business application.

', 'refs' => [ 'Applications$member' => NULL, ], ], 'ApplicationArn' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationResponse$applicationArn' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application.

', 'GetApplicationResponse$applicationArn' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application.

', ], ], 'ApplicationId' => [ 'base' => NULL, 'refs' => [ 'Application$applicationId' => '

The identifier for the Amazon Q Business application.

', 'BatchDeleteDocumentRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'BatchPutDocumentRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'ChatSyncInput$applicationId' => '

The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

', 'CreateApplicationResponse$applicationId' => '

The identifier of the Amazon Q Business application.

', 'CreateDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application the data source will be attached to.

', 'CreateIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application using the index.

', 'CreatePluginRequest$applicationId' => '

The identifier of the application that will contain the plugin.

', 'CreateRetrieverRequest$applicationId' => '

The identifier of your Amazon Q Business application.

', 'CreateUserRequest$applicationId' => '

The identifier of the application for which the user mapping will be created.

', 'CreateWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business web experience.

', 'DeleteApplicationRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'DeleteChatControlsConfigurationRequest$applicationId' => '

The identifier of the application the chat controls have been configured for.

', 'DeleteConversationRequest$applicationId' => '

The identifier of the Amazon Q Business application associated with the conversation.

', 'DeleteDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application used with the data source connector.

', 'DeleteGroupRequest$applicationId' => '

The identifier of the application in which the group mapping belongs.

', 'DeleteIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.

', 'DeletePluginRequest$applicationId' => '

The identifier the application attached to the Amazon Q Business plugin.

', 'DeleteRetrieverRequest$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'DeleteUserRequest$applicationId' => '

The identifier of the application from which the user is being deleted.

', 'DeleteWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.

', 'GetApplicationRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetApplicationResponse$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetChatControlsConfigurationRequest$applicationId' => '

The identifier of the application for which the chat controls are configured.

', 'GetDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetDataSourceResponse$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetGroupRequest$applicationId' => '

The identifier of the application id the group is attached to.

', 'GetIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the index.

', 'GetIndexResponse$applicationId' => '

The identifier of the Amazon Q Business application associated with the index.

', 'GetPluginRequest$applicationId' => '

The identifier of the application which contains the plugin.

', 'GetPluginResponse$applicationId' => '

The identifier of the application which contains the plugin.

', 'GetRetrieverRequest$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'GetRetrieverResponse$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'GetUserRequest$applicationId' => '

The identifier of the application connected to the user.

', 'GetWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the web experience.

', 'GetWebExperienceResponse$applicationId' => '

The identifier of the Amazon Q Business application linked to the web experience.

', 'ListConversationsRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'ListDataSourceSyncJobsRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the data source.

', 'ListDataSourcesRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the data source connectors.

', 'ListDocumentsRequest$applicationId' => '

The identifier of the application id the documents are attached to.

', 'ListGroupsRequest$applicationId' => '

The identifier of the application for getting a list of groups mapped to users.

', 'ListIndicesRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the index.

', 'ListMessagesRequest$applicationId' => '

The identifier for the Amazon Q Business application.

', 'ListPluginsRequest$applicationId' => '

The identifier of the application the plugin is attached to.

', 'ListRetrieversRequest$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'ListWebExperiencesRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the listed web experiences.

', 'PutFeedbackRequest$applicationId' => '

The identifier of the application associated with the feedback.

', 'PutGroupRequest$applicationId' => '

The identifier of the application in which the user and group mapping belongs.

', 'Retriever$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'StartDataSourceSyncJobRequest$applicationId' => '

The identifier of Amazon Q Business application the data source is connected to.

', 'StopDataSourceSyncJobRequest$applicationId' => '

The identifier of the Amazon Q Business application that the data source is connected to.

', 'UpdateApplicationRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'UpdateChatControlsConfigurationRequest$applicationId' => '

The identifier of the application for which the chat controls are configured.

', 'UpdateDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application the data source is attached to.

', 'UpdateIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the index.

', 'UpdatePluginRequest$applicationId' => '

The identifier of the application the plugin is attached to.

', 'UpdateRetrieverRequest$applicationId' => '

The identifier of your Amazon Q Business application.

', 'UpdateUserRequest$applicationId' => '

The identifier of the application the user is attached to.

', 'UpdateWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business application attached to the web experience.

', ], ], 'ApplicationName' => [ 'base' => NULL, 'refs' => [ 'Application$displayName' => '

The name of the Amazon Q Business application.

', 'CreateApplicationRequest$displayName' => '

A name for the Amazon Q Business application.

', 'GetApplicationResponse$displayName' => '

The name of the Amazon Q Business application.

', 'UpdateApplicationRequest$displayName' => '

A name for the Amazon Q Business application.

', 'UpdateIndexRequest$displayName' => '

The name of the Amazon Q Business index.

', ], ], 'ApplicationStatus' => [ 'base' => NULL, 'refs' => [ 'Application$status' => '

The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.

', 'GetApplicationResponse$status' => '

The status of the Amazon Q Business application.

', ], ], 'Applications' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsResponse$applications' => '

An array of summary information on the configuration of one or more Amazon Q Business applications.

', ], ], 'AppliedAttachmentsConfiguration' => [ 'base' => '

Configuration information about the file upload during chat feature for your application.

', 'refs' => [ 'GetApplicationResponse$attachmentsConfiguration' => '

Settings for whether end users can upload files directly during chat.

', ], ], 'AppliedCreatorModeConfiguration' => [ 'base' => '

The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.

For more information, see Admin controls and guardrails and Conversation settings.

', 'refs' => [ 'GetChatControlsConfigurationResponse$creatorModeConfiguration' => '

The configuration details for CREATOR_MODE.

', ], ], 'AttachmentInput' => [ 'base' => '

A file directly uploaded into a web experience chat.

', 'refs' => [ 'AttachmentsInput$member' => NULL, ], ], 'AttachmentName' => [ 'base' => NULL, 'refs' => [ 'AttachmentInput$name' => '

The name of the file.

', 'AttachmentOutput$name' => '

The name of a file uploaded during chat.

', ], ], 'AttachmentOutput' => [ 'base' => '

The details of a file uploaded during chat.

', 'refs' => [ 'AttachmentsOutput$member' => NULL, ], ], 'AttachmentStatus' => [ 'base' => NULL, 'refs' => [ 'AttachmentOutput$status' => '

The status of a file uploaded during chat.

', ], ], 'AttachmentsConfiguration' => [ 'base' => '

Configuration information for the file upload during chat feature.

', 'refs' => [ 'CreateApplicationRequest$attachmentsConfiguration' => '

An option to allow end users to upload files directly during chat.

', 'UpdateApplicationRequest$attachmentsConfiguration' => '

An option to allow end users to upload files directly during chat.

', ], ], 'AttachmentsControlMode' => [ 'base' => NULL, 'refs' => [ 'AppliedAttachmentsConfiguration$attachmentsControlMode' => '

Information about whether file upload during chat functionality is activated for your application.

', 'AttachmentsConfiguration$attachmentsControlMode' => '

Status information about whether file upload functionality is activated or deactivated for your end user.

', ], ], 'AttachmentsInput' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$attachments' => '

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

', ], ], 'AttachmentsOutput' => [ 'base' => NULL, 'refs' => [ 'ChatSyncOutput$failedAttachments' => '

A list of files which failed to upload during chat.

', 'Message$attachments' => '

A file directly uploaded into an Amazon Q Business web experience chat.

', ], ], 'AttributeFilter' => [ 'base' => '

Enables filtering of responses based on document attributes or metadata fields.

', 'refs' => [ 'AttributeFilter$notFilter' => '

Performs a logical NOT operation on all supplied filters.

', 'AttributeFilters$member' => NULL, 'ChatSyncInput$attributeFilter' => '

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

', ], ], 'AttributeFilters' => [ 'base' => NULL, 'refs' => [ 'AttributeFilter$andAllFilters' => '

Performs a logical AND operation on all supplied filters.

', 'AttributeFilter$orAllFilters' => '

Performs a logical OR operation on all supplied filters.

', ], ], 'AttributeType' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeConfiguration$type' => '

The type of document attribute.

', ], ], 'AttributeValueOperator' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeTarget$attributeValueOperator' => '

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

', ], ], 'BasicAuthConfiguration' => [ 'base' => '

Information about the basic authentication credentials used to configure a plugin.

', 'refs' => [ 'PluginAuthConfiguration$basicAuthConfiguration' => '

Information about the basic authentication credentials used to configure a plugin.

', ], ], 'BatchDeleteDocumentRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteDocumentResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutDocumentRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutDocumentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'AttachmentInput$data' => '

The data contained within the uploaded file.

', 'DocumentContent$blob' => '

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you\'re using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

', ], ], 'BlockedPhrase' => [ 'base' => NULL, 'refs' => [ 'BlockedPhrases$member' => NULL, ], ], 'BlockedPhrases' => [ 'base' => NULL, 'refs' => [ 'BlockedPhrasesConfiguration$blockedPhrases' => '

A list of phrases blocked from a Amazon Q Business web experience chat.

', 'BlockedPhrasesConfigurationUpdate$blockedPhrasesToCreateOrUpdate' => '

Creates or updates a blocked phrases configuration in your Amazon Q Business application.

', 'BlockedPhrasesConfigurationUpdate$blockedPhrasesToDelete' => '

Deletes a blocked phrases configuration in your Amazon Q Business application.

', ], ], 'BlockedPhrasesConfiguration' => [ 'base' => '

Provides information about the phrases blocked from chat by your chat control configuration.

', 'refs' => [ 'GetChatControlsConfigurationResponse$blockedPhrases' => '

The phrases blocked from chat by your chat control configuration.

', ], ], 'BlockedPhrasesConfigurationUpdate' => [ 'base' => '

Updates a blocked phrases configuration in your Amazon Q Business application.

', 'refs' => [ 'UpdateChatControlsConfigurationRequest$blockedPhrasesConfigurationUpdate' => '

The phrases blocked from chat by your chat control configuration.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$required' => '

Information about whether the field is required.

', ], ], 'BoostingDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'DateAttributeBoostingConfiguration$boostingDurationInSeconds' => '

Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

', ], ], 'ChatMode' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$chatMode' => '

The chat modes available in an Amazon Q Business web experience.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

', ], ], 'ChatModeConfiguration' => [ 'base' => '

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

', 'refs' => [ 'ChatSyncInput$chatModeConfiguration' => '

The chat mode configuration for an Amazon Q Business application.

', ], ], 'ChatSyncInput' => [ 'base' => NULL, 'refs' => [], ], 'ChatSyncOutput' => [ 'base' => NULL, 'refs' => [], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$clientToken' => '

A token that you provide to identify a chat request.

', 'CreateApplicationRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business application.

', 'CreateDataSourceRequest$clientToken' => '

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

', 'CreateIndexRequest$clientToken' => '

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

', 'CreatePluginRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business plugin.

', 'CreateRetrieverRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business application retriever.

', 'CreateUserRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business user mapping.

', 'CreateWebExperienceRequest$clientToken' => '

A token you provide to identify a request to create an Amazon Q Business web experience.

', 'UpdateChatControlsConfigurationRequest$clientToken' => '

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

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

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

', 'refs' => [], ], 'ContentBlockerRule' => [ 'base' => '

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

', 'refs' => [ 'RuleConfiguration$contentBlockerRule' => '

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

', ], ], 'ContentRetrievalRule' => [ 'base' => '

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

', 'refs' => [ 'RuleConfiguration$contentRetrievalRule' => NULL, ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'Document$contentType' => '

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

', ], ], 'Conversation' => [ 'base' => '

A conversation in an Amazon Q Business application.

', 'refs' => [ 'Conversations$member' => NULL, ], ], 'ConversationId' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'ChatSyncOutput$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'Conversation$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'DeleteConversationRequest$conversationId' => '

The identifier of the Amazon Q Business web experience conversation being deleted.

', 'ListMessagesRequest$conversationId' => '

The identifier of the Amazon Q Business web experience conversation.

', 'PutFeedbackRequest$conversationId' => '

The identifier of the conversation the feedback is attached to.

', ], ], 'ConversationTitle' => [ 'base' => NULL, 'refs' => [ 'Conversation$title' => '

The title of the conversation.

', ], ], 'Conversations' => [ 'base' => NULL, 'refs' => [ 'ListConversationsResponse$conversations' => '

An array of summary information on the configuration of one or more Amazon Q Business web experiences.

', ], ], 'CreateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequestUserAliasesList' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$userAliases' => '

The list of user aliases in the mapping.

', ], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatorModeConfiguration' => [ 'base' => '

Configuration information required to invoke chat in CREATOR_MODE.

For more information, see Admin controls and guardrails and Conversation settings.

', 'refs' => [ 'UpdateChatControlsConfigurationRequest$creatorModeConfiguration' => '

The configuration details for CREATOR_MODE.

', ], ], 'CreatorModeControl' => [ 'base' => NULL, 'refs' => [ 'AppliedCreatorModeConfiguration$creatorModeControl' => '

Information about whether creator mode is enabled or disabled for an Amazon Q Business application.

', 'CreatorModeConfiguration$creatorModeControl' => '

Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.

', ], ], 'DataSource' => [ 'base' => '

A data source in an Amazon Q Business application.

', 'refs' => [ 'DataSources$member' => NULL, ], ], 'DataSourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceResponse$dataSourceArn' => '

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

', 'GetDataSourceResponse$dataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', ], ], 'DataSourceConfiguration' => [ 'base' => '

Provides the configuration information for an Amazon Q Business data source.

', 'refs' => [ 'CreateDataSourceRequest$configuration' => '

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

', 'GetDataSourceResponse$configuration' => '

The details of how the data source connector is configured.

', 'UpdateDataSourceRequest$configuration' => NULL, ], ], 'DataSourceId' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceResponse$dataSourceId' => '

The identifier of the data source connector.

', 'DataSource$dataSourceId' => '

The identifier of the Amazon Q Business data source.

', 'DataSourceIds$member' => NULL, 'DeleteDataSourceRequest$dataSourceId' => '

The identifier of the data source connector that you want to delete.

', 'DeleteGroupRequest$dataSourceId' => '

The identifier of the data source linked to the group

A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company\'s documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

', 'EligibleDataSource$dataSourceId' => '

The identifier of the data source.

', 'FailedDocument$dataSourceId' => '

The identifier of the Amazon Q Business data source connector that contains the failed document.

', 'GetDataSourceRequest$dataSourceId' => '

The identifier of the data source connector.

', 'GetDataSourceResponse$dataSourceId' => '

The identifier of the data source connector.

', 'GetGroupRequest$dataSourceId' => '

The identifier of the data source the group is attached to.

', 'ListDataSourceSyncJobsRequest$dataSourceId' => '

The identifier of the data source connector.

', 'ListGroupsRequest$dataSourceId' => '

The identifier of the data source for getting a list of groups mapped to users.

', 'PutGroupRequest$dataSourceId' => '

The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company\'s documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

', 'StartDataSourceSyncJobRequest$dataSourceId' => '

The identifier of the data source connector.

', 'StopDataSourceSyncJobRequest$dataSourceId' => '

The identifier of the data source connector.

', 'UpdateDataSourceRequest$dataSourceId' => '

The identifier of the data source connector.

', 'UserAlias$dataSourceId' => '

The identifier of the data source that the user aliases are associated with.

', ], ], 'DataSourceIds' => [ 'base' => NULL, 'refs' => [ 'ListDocumentsRequest$dataSourceIds' => '

The identifier of the data sources the documents are attached to.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceRequest$displayName' => '

A name for the data source connector.

', 'DataSource$displayName' => '

The name of the Amazon Q Business data source.

', 'GetDataSourceResponse$displayName' => '

The name for the data source connector.

', 'UpdateDataSourceRequest$displayName' => '

A name of the data source connector.

', ], ], 'DataSourceStatus' => [ 'base' => NULL, 'refs' => [ 'DataSource$status' => '

The status of the Amazon Q Business data source.

', 'GetDataSourceResponse$status' => '

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', ], ], 'DataSourceSyncJob' => [ 'base' => '

Provides information about an Amazon Q Business data source connector synchronization job.

', 'refs' => [ 'DataSourceSyncJobs$member' => NULL, ], ], 'DataSourceSyncJobMetrics' => [ 'base' => '

Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.

', 'refs' => [ 'DataSourceSyncJob$metrics' => '

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

', ], ], 'DataSourceSyncJobStatus' => [ 'base' => NULL, 'refs' => [ 'DataSourceSyncJob$status' => '

The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

', 'ListDataSourceSyncJobsRequest$statusFilter' => '

Only returns synchronization jobs with the Status field equal to the specified status.

', ], ], 'DataSourceSyncJobs' => [ 'base' => NULL, 'refs' => [ 'ListDataSourceSyncJobsResponse$history' => '

A history of synchronization jobs for the data source connector.

', ], ], 'DataSourceUserId' => [ 'base' => NULL, 'refs' => [ 'MemberUser$userId' => '

The identifier of the user you want to map to a group.

', ], ], 'DataSourceVpcConfiguration' => [ 'base' => '

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

', 'refs' => [ 'CreateDataSourceRequest$vpcConfiguration' => '

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.

', 'GetDataSourceResponse$vpcConfiguration' => '

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

', 'UpdateDataSourceRequest$vpcConfiguration' => NULL, ], ], 'DataSources' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$dataSources' => '

An array of summary information for one or more data source connector.

', ], ], 'DateAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting DATE type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$dateConfiguration' => '

Provides information on boosting DATE type document attributes.

', ], ], 'DeleteApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChatControlsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChatControlsConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConversationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConversationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDocument' => [ 'base' => '

A document deleted from an Amazon Q Business data source connector.

', 'refs' => [ 'DeleteDocuments$member' => NULL, ], ], 'DeleteDocuments' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentRequest$documents' => '

Documents deleted from the Amazon Q Business index.

', ], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$description' => '

A description for the Amazon Q Business application.

', 'CreateDataSourceRequest$description' => '

A description for the data source connector.

', 'CreateIndexRequest$description' => '

A description for the Amazon Q Business index.

', 'GetApplicationResponse$description' => '

A description for the Amazon Q Business application.

', 'GetDataSourceResponse$description' => '

The description for the data source connector.

', 'GetIndexResponse$description' => '

The description for the Amazon Q Business index.

', 'UpdateApplicationRequest$description' => '

A description for the Amazon Q Business application.

', 'UpdateDataSourceRequest$description' => '

The description of the data source connector.

', 'UpdateIndexRequest$description' => '

The description of the Amazon Q Business index.

', ], ], 'Document' => [ 'base' => '

A document in an Amazon Q Business application.

', 'refs' => [ 'Documents$member' => NULL, ], ], 'DocumentAttribute' => [ 'base' => '

A document attribute or metadata field.

', 'refs' => [ 'AttributeFilter$containsAll' => '

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

', 'AttributeFilter$containsAny' => '

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

', 'AttributeFilter$equalsTo' => '

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

', 'AttributeFilter$greaterThan' => '

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

', 'AttributeFilter$greaterThanOrEquals' => '

Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

', 'AttributeFilter$lessThan' => '

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

', 'AttributeFilter$lessThanOrEquals' => '

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

', 'DocumentAttributes$member' => NULL, ], ], 'DocumentAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven\'t enabled searching on these attributes, you can\'t boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingOverrideMap$value' => NULL, ], ], 'DocumentAttributeBoostingLevel' => [ 'base' => NULL, 'refs' => [ 'DateAttributeBoostingConfiguration$boostingLevel' => '

Specifies how much a document attribute is boosted.

', 'NumberAttributeBoostingConfiguration$boostingLevel' => '

Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

', 'StringAttributeBoostingConfiguration$boostingLevel' => '

Specifies how much a document attribute is boosted.

', 'StringListAttributeBoostingConfiguration$boostingLevel' => '

Specifies how much a document attribute is boosted.

', ], ], 'DocumentAttributeBoostingOverrideMap' => [ 'base' => NULL, 'refs' => [ 'NativeIndexConfiguration$boostingOverride' => '

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

', ], ], 'DocumentAttributeCondition' => [ 'base' => '

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the \'Department\' target field and have it prefill department names associated with the documents based on information in the \'Source_URI\' field. Set the condition that if the \'Source_URI\' field contains \'financial\' in its URI value, then prefill the target field \'Department\' with the target value \'Finance\' for the document.

Amazon Q Business can\'t create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

', 'refs' => [ 'HookConfiguration$invocationCondition' => '

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

', 'InlineDocumentEnrichmentConfiguration$condition' => NULL, ], ], 'DocumentAttributeConfiguration' => [ 'base' => '

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

', 'refs' => [ 'DocumentAttributeConfigurations$member' => NULL, ], ], 'DocumentAttributeConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetIndexResponse$documentAttributeConfigurations' => '

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

', 'UpdateIndexRequest$documentAttributeConfigurations' => '

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

', ], ], 'DocumentAttributeKey' => [ 'base' => NULL, 'refs' => [ 'DocumentAttribute$name' => '

The identifier for the attribute.

', 'DocumentAttributeBoostingOverrideMap$key' => NULL, 'DocumentAttributeCondition$key' => '

The identifier of the document attribute used for the condition.

For example, \'Source_URI\' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn\'t support _document_body as an attribute key used for the condition.

', 'DocumentAttributeTarget$key' => '

The identifier of the target document attribute or metadata field. For example, \'Department\' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

', ], ], 'DocumentAttributeStringListValue' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeValue$stringListValue' => '

A list of strings.

', ], ], 'DocumentAttributeTarget' => [ 'base' => '

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called \'Customer_ID\' by setting the target key as \'Customer_ID\' and the deletion flag to TRUE. This removes all customer ID values in the field \'Customer_ID\'. This would scrub personally identifiable information from each document\'s metadata.

Amazon Q Business can\'t create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

', 'refs' => [ 'InlineDocumentEnrichmentConfiguration$target' => NULL, ], ], 'DocumentAttributeValue' => [ 'base' => '

The value of a document attribute. You can only provide one value for a document attribute.

', 'refs' => [ 'DocumentAttribute$value' => '

The value of the attribute.

', 'DocumentAttributeCondition$value' => NULL, 'DocumentAttributeTarget$value' => NULL, ], ], 'DocumentAttributeValueStringValueString' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeValue$stringValue' => '

A string.

', ], ], 'DocumentAttributes' => [ 'base' => NULL, 'refs' => [ 'Document$attributes' => '

Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

', ], ], 'DocumentContent' => [ 'base' => '

The contents of a document.

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

The contents of the document.

', ], ], 'DocumentContentOperator' => [ 'base' => NULL, 'refs' => [ 'InlineDocumentEnrichmentConfiguration$documentContentOperator' => '

TRUE to delete content if the condition used for the target attribute is met.

', ], ], 'DocumentDetailList' => [ 'base' => NULL, 'refs' => [ 'ListDocumentsResponse$documentDetailList' => '

A list of document details.

', ], ], 'DocumentDetails' => [ 'base' => '

The details of a document within an Amazon Q Business index.

', 'refs' => [ 'DocumentDetailList$member' => NULL, ], ], 'DocumentEnrichmentConditionOperator' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeCondition$operator' => '

The identifier of the document attribute used for the condition.

For example, \'Source_URI\' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

', ], ], 'DocumentEnrichmentConfiguration' => [ 'base' => '

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

', 'refs' => [ 'CreateDataSourceRequest$documentEnrichmentConfiguration' => NULL, 'Document$documentEnrichmentConfiguration' => '

The configuration information for altering document metadata and content during the document ingestion process.

', 'GetDataSourceResponse$documentEnrichmentConfiguration' => NULL, 'UpdateDataSourceRequest$documentEnrichmentConfiguration' => NULL, ], ], 'DocumentId' => [ 'base' => NULL, 'refs' => [ 'DeleteDocument$documentId' => '

The identifier of the deleted document.

', 'Document$id' => '

The identifier of the document.

', 'DocumentDetails$documentId' => '

The identifier of the document.

', 'FailedDocument$id' => '

The identifier of the document that couldn\'t be removed from the Amazon Q Business index.

', ], ], 'DocumentStatus' => [ 'base' => NULL, 'refs' => [ 'DocumentDetails$status' => '

The current status of the document.

', ], ], 'Documents' => [ 'base' => NULL, 'refs' => [ 'BatchPutDocumentRequest$documents' => '

One or more documents to add to the index.

', ], ], 'EligibleDataSource' => [ 'base' => '

The identifier of the data source Amazon Q Business will generate responses from.

', 'refs' => [ 'EligibleDataSources$member' => NULL, ], ], 'EligibleDataSources' => [ 'base' => NULL, 'refs' => [ 'ContentRetrievalRule$eligibleDataSources' => '

Specifies data sources in a Amazon Q Business application to use for content generation.

', ], ], 'EncryptionConfiguration' => [ 'base' => '

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn\'t support asymmetric keys.

', 'refs' => [ 'CreateApplicationRequest$encryptionConfiguration' => '

The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn\'t support asymmetric keys.

', 'GetApplicationResponse$encryptionConfiguration' => '

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn\'t support asymmetric keys.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'ErrorDetail$errorCode' => '

The code associated with the data source sync error.

', ], ], 'ErrorDetail' => [ 'base' => '

Provides information about a data source sync error.

', 'refs' => [ 'AttachmentOutput$error' => '

An error associated with a file uploaded during chat.

', 'DataSourceSyncJob$error' => '

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

', 'DocumentDetails$error' => '

An error message associated with the document.

', 'FailedDocument$error' => '

An explanation for why the document couldn\'t be removed from the index.

', 'GetApplicationResponse$error' => '

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

', 'GetDataSourceResponse$error' => '

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', 'GetIndexResponse$error' => '

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

', 'GetWebExperienceResponse$error' => '

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', 'GroupStatusDetail$errorDetail' => '

The details of an error associated a group status.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => '

The message describing a ConflictException.

', 'ErrorDetail$errorMessage' => '

The message explaining the data source sync error.

', 'InternalServerException$message' => NULL, 'LicenseNotFoundException$message' => NULL, 'ResourceNotFoundException$message' => '

The message describing a ResourceNotFoundException.

', 'ServiceQuotaExceededException$message' => '

The message describing a ServiceQuotaExceededException.

', 'ThrottlingException$message' => NULL, 'ValidationException$message' => '

The message describing the ValidationException.

', ], ], 'ExampleChatMessage' => [ 'base' => NULL, 'refs' => [ 'ExampleChatMessages$member' => NULL, ], ], 'ExampleChatMessages' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$exampleChatMessages' => '

A list of example phrases that you expect the end user to use in relation to the topic.

', ], ], 'ExecutionId' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentRequest$dataSourceSyncId' => '

The identifier of the data source sync during which the documents were deleted.

', 'BatchPutDocumentRequest$dataSourceSyncId' => '

The identifier of the data source sync during which the documents were added.

', 'DataSourceSyncJob$executionId' => '

The identifier of a data source synchronization job.

', 'StartDataSourceSyncJobResponse$executionId' => '

The identifier for a particular synchronization job.

', ], ], 'FailedDocument' => [ 'base' => '

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn\'t be removed from the index.

', 'refs' => [ 'FailedDocuments$member' => NULL, ], ], 'FailedDocuments' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentResponse$failedDocuments' => '

A list of documents that couldn\'t be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn\'t be removed from the index.

', 'BatchPutDocumentResponse$failedDocuments' => '

A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn\'t be added to the index.

', ], ], 'GetApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetChatControlsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetChatControlsConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GroupMembers' => [ 'base' => '

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

', 'refs' => [ 'PutGroupRequest$groupMembers' => NULL, ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'DeleteGroupRequest$groupName' => '

The name of the group you want to delete.

', 'GetGroupRequest$groupName' => '

The name of the group.

', 'GroupSummary$groupName' => '

The name of the group the summary information is for.

', 'MemberGroup$groupName' => '

The name of the sub group.

', 'PrincipalGroup$name' => '

The name of the group.

', 'PutGroupRequest$groupName' => '

The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

', ], ], 'GroupStatus' => [ 'base' => NULL, 'refs' => [ 'GroupStatusDetail$status' => '

The status of a group.

', ], ], 'GroupStatusDetail' => [ 'base' => '

Provides the details of a group\'s status.

', 'refs' => [ 'GetGroupResponse$status' => '

The current status of the group.

', 'GroupStatusDetails$member' => NULL, ], ], 'GroupStatusDetails' => [ 'base' => NULL, 'refs' => [ 'GetGroupResponse$statusHistory' => '

The status history of the group.

', ], ], 'GroupSummary' => [ 'base' => '

Summary information for groups.

', 'refs' => [ 'GroupSummaryList$member' => NULL, ], ], 'GroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$items' => '

Summary information for list of groups that are mapped to users.

', ], ], 'HookConfiguration' => [ 'base' => '

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

', 'refs' => [ 'DocumentEnrichmentConfiguration$postExtractionHookConfiguration' => NULL, 'DocumentEnrichmentConfiguration$preExtractionHookConfiguration' => NULL, ], ], 'IdcApplicationArn' => [ 'base' => NULL, 'refs' => [ 'GetApplicationResponse$identityCenterApplicationArn' => '

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

', ], ], 'Index' => [ 'base' => '

Summary information for your Amazon Q Business index.

', 'refs' => [ 'Indices$member' => NULL, ], ], 'IndexArn' => [ 'base' => NULL, 'refs' => [ 'CreateIndexResponse$indexArn' => '

The Amazon Resource Name (ARN) of an Amazon Q Business index.

', 'GetIndexResponse$indexArn' => '

The Amazon Resource Name (ARN) of the Amazon Q Business index.

', ], ], 'IndexCapacityConfiguration' => [ 'base' => '

Provides information about index capacity configuration.

', 'refs' => [ 'CreateIndexRequest$capacityConfiguration' => '

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

', 'GetIndexResponse$capacityConfiguration' => '

The storage capacity units chosen for your Amazon Q Business index.

', 'UpdateIndexRequest$capacityConfiguration' => '

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

', ], ], 'IndexCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'IndexCapacityConfiguration$units' => '

The number of storage units configured for an Amazon Q Business index.

', ], ], 'IndexId' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentRequest$indexId' => '

The identifier of the Amazon Q Business index that contains the documents to delete.

', 'BatchPutDocumentRequest$indexId' => '

The identifier of the Amazon Q Business index to add the documents to.

', 'CreateDataSourceRequest$indexId' => '

The identifier of the index that you want to use with the data source connector.

', 'CreateIndexResponse$indexId' => '

The identifier for the Amazon Q Business index.

', 'DeleteDataSourceRequest$indexId' => '

The identifier of the index used with the data source connector.

', 'DeleteGroupRequest$indexId' => '

The identifier of the index you want to delete the group from.

', 'DeleteIndexRequest$indexId' => '

The identifier of the Amazon Q Business index.

', 'EligibleDataSource$indexId' => '

The identifier of the index the data source is attached to.

', 'GetDataSourceRequest$indexId' => '

The identfier of the index used with the data source connector.

', 'GetDataSourceResponse$indexId' => '

The identifier of the index linked to the data source connector.

', 'GetGroupRequest$indexId' => '

The identifier of the index the group is attached to.

', 'GetIndexRequest$indexId' => '

The identifier of the Amazon Q Business index you want information on.

', 'GetIndexResponse$indexId' => '

The identifier of the Amazon Q Business index.

', 'Index$indexId' => '

The identifier for the index.

', 'ListDataSourceSyncJobsRequest$indexId' => '

The identifier of the index used with the Amazon Q Business data source connector.

', 'ListDataSourcesRequest$indexId' => '

The identifier of the index used with one or more data source connectors.

', 'ListDocumentsRequest$indexId' => '

The identifier of the index the documents are attached to.

', 'ListGroupsRequest$indexId' => '

The identifier of the index for getting a list of groups mapped to users.

', 'NativeIndexConfiguration$indexId' => '

The identifier for the Amazon Q Business index.

', 'PutGroupRequest$indexId' => '

The identifier of the index in which you want to map users to their groups.

', 'StartDataSourceSyncJobRequest$indexId' => '

The identifier of the index used with the data source connector.

', 'StopDataSourceSyncJobRequest$indexId' => '

The identifier of the index used with the Amazon Q Business data source connector.

', 'UpdateDataSourceRequest$indexId' => '

The identifier of the index attached to the data source connector.

', 'UpdateIndexRequest$indexId' => '

The identifier of the Amazon Q Business index.

', 'UserAlias$indexId' => '

The identifier of the index that the user aliases are associated with.

', ], ], 'IndexName' => [ 'base' => NULL, 'refs' => [ 'CreateIndexRequest$displayName' => '

A name for the Amazon Q Business index.

', 'GetIndexResponse$displayName' => '

The name of the Amazon Q Business index.

', 'Index$displayName' => '

The name of the index.

', ], ], 'IndexStatistics' => [ 'base' => '

Provides information about the number of documents in an index.

', 'refs' => [ 'GetIndexResponse$indexStatistics' => '

Provides information about the number of documents indexed.

', ], ], 'IndexStatus' => [ 'base' => NULL, 'refs' => [ 'GetIndexResponse$status' => '

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

', 'Index$status' => '

The current status of the index. When the status is ACTIVE, the index is ready.

', ], ], 'IndexedTextBytes' => [ 'base' => NULL, 'refs' => [ 'TextDocumentStatistics$indexedTextBytes' => '

The total size, in bytes, of the indexed documents.

', ], ], 'IndexedTextDocument' => [ 'base' => NULL, 'refs' => [ 'TextDocumentStatistics$indexedTextDocumentCount' => '

The number of text documents indexed.

', ], ], 'Indices' => [ 'base' => NULL, 'refs' => [ 'ListIndicesResponse$indices' => '

An array of information on the items in one or more indexes.

', ], ], 'InlineDocumentEnrichmentConfiguration' => [ 'base' => '

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Custom document enrichment.

', 'refs' => [ 'InlineDocumentEnrichmentConfigurations$member' => NULL, ], ], 'InlineDocumentEnrichmentConfigurations' => [ 'base' => NULL, 'refs' => [ 'DocumentEnrichmentConfiguration$inlineConfigurations' => '

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

', ], ], 'InstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$identityCenterInstanceArn' => '

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$displayOrder' => '

The display order of fields in a payload.

', 'SourceAttribution$citationNumber' => '

The number attached to a citation in an Amazon Q Business generated response.

', 'TextSegment$beginOffset' => '

The zero-based location in the response string where the source attribution starts.

', 'TextSegment$endOffset' => '

The zero-based location in the response string where the source attribution ends.

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

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

', 'refs' => [], ], 'KendraIndexConfiguration' => [ 'base' => '

Stores an Amazon Kendra index as a retriever.

', 'refs' => [ 'RetrieverConfiguration$kendraIndexConfiguration' => '

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

', ], ], 'KendraIndexId' => [ 'base' => NULL, 'refs' => [ 'KendraIndexConfiguration$indexId' => '

The identifier of the Amazon Kendra index.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsKeyId' => '

The identifier of the KMS key. Amazon Q Business doesn\'t support asymmetric keys.

', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'HookConfiguration$lambdaArn' => '

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

', ], ], 'LicenseNotFoundException' => [ 'base' => '

You don\'t have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

', 'refs' => [], ], 'ListApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConversationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConversationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourceSyncJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourceSyncJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDocumentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDocumentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIndicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIndicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMessagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMessagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPluginsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPluginsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRetrieversRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRetrieversResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWebExperiencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWebExperiencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeValue$longValue' => '

A long integer value.

', ], ], 'MaxResultsIntegerForGetTopicConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetChatControlsConfigurationRequest$maxResults' => '

The maximum number of configured chat controls to return.

', ], ], 'MaxResultsIntegerForListApplications' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsRequest$maxResults' => '

The maximum number of Amazon Q Business applications to return.

', ], ], 'MaxResultsIntegerForListConversations' => [ 'base' => NULL, 'refs' => [ 'ListConversationsRequest$maxResults' => '

The maximum number of Amazon Q Business conversations to return.

', ], ], 'MaxResultsIntegerForListDataSources' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesRequest$maxResults' => '

The maximum number of data source connectors to return.

', ], ], 'MaxResultsIntegerForListDataSourcesSyncJobs' => [ 'base' => NULL, 'refs' => [ 'ListDataSourceSyncJobsRequest$maxResults' => '

The maximum number of synchronization jobs to return in the response.

', ], ], 'MaxResultsIntegerForListDocuments' => [ 'base' => NULL, 'refs' => [ 'ListDocumentsRequest$maxResults' => '

The maximum number of documents to return.

', ], ], 'MaxResultsIntegerForListGroupsRequest' => [ 'base' => NULL, 'refs' => [ 'ListGroupsRequest$maxResults' => '

The maximum number of returned groups that are mapped to users.

', ], ], 'MaxResultsIntegerForListIndices' => [ 'base' => NULL, 'refs' => [ 'ListIndicesRequest$maxResults' => '

The maximum number of indices to return.

', ], ], 'MaxResultsIntegerForListMessages' => [ 'base' => NULL, 'refs' => [ 'ListMessagesRequest$maxResults' => '

The maximum number of messages to return.

', ], ], 'MaxResultsIntegerForListPlugins' => [ 'base' => NULL, 'refs' => [ 'ListPluginsRequest$maxResults' => '

The maximum number of documents to return.

', ], ], 'MaxResultsIntegerForListRetrieversRequest' => [ 'base' => NULL, 'refs' => [ 'ListRetrieversRequest$maxResults' => '

The maximum number of retrievers returned.

', ], ], 'MaxResultsIntegerForListWebExperiencesRequest' => [ 'base' => NULL, 'refs' => [ 'ListWebExperiencesRequest$maxResults' => '

The maximum number of Amazon Q Business Web Experiences to return.

', ], ], 'MemberGroup' => [ 'base' => '

The sub groups that belong to a group.

', 'refs' => [ 'MemberGroups$member' => NULL, ], ], 'MemberGroups' => [ 'base' => NULL, 'refs' => [ 'GroupMembers$memberGroups' => '

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

', ], ], 'MemberRelation' => [ 'base' => NULL, 'refs' => [ 'AccessConfiguration$memberRelation' => '

Describes the member relation within the AccessControlList object.

', 'AccessControl$memberRelation' => '

Describes the member relation within a principal list.

', ], ], 'MemberUser' => [ 'base' => '

The users that belong to a group.

', 'refs' => [ 'MemberUsers$member' => NULL, ], ], 'MemberUsers' => [ 'base' => NULL, 'refs' => [ 'GroupMembers$memberUsers' => '

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

', ], ], 'MembershipType' => [ 'base' => NULL, 'refs' => [ 'MemberGroup$type' => '

The type of the sub group.

', 'MemberUser$type' => '

The type of the user.

', 'PrincipalGroup$membershipType' => '

The type of group.

', 'PrincipalUser$membershipType' => '

The type of group.

', 'PutGroupRequest$type' => '

The type of the group.

', ], ], 'Message' => [ 'base' => '

A message in an Amazon Q Business web experience.

', 'refs' => [ 'Messages$member' => NULL, ], ], 'MessageBody' => [ 'base' => NULL, 'refs' => [ 'Message$body' => '

The content of the Amazon Q Business web experience message.

', ], ], 'MessageId' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$parentMessageId' => '

The identifier of the previous end user text input message in a conversation.

', 'ChatSyncOutput$systemMessageId' => '

The identifier of an Amazon Q Business AI generated message within the conversation.

', 'ChatSyncOutput$userMessageId' => '

The identifier of an Amazon Q Business end user text input message within the conversation.

', ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'Message$type' => '

The type of Amazon Q Business message, whether HUMAN or AI generated.

', ], ], 'MessageUsefulness' => [ 'base' => NULL, 'refs' => [ 'MessageUsefulnessFeedback$usefulness' => '

The usefulness value assigned by an end user to a message.

', ], ], 'MessageUsefulnessComment' => [ 'base' => NULL, 'refs' => [ 'MessageUsefulnessFeedback$comment' => '

A comment given by an end user on the usefulness of an AI-generated chat message.

', ], ], 'MessageUsefulnessFeedback' => [ 'base' => '

End user feedback on an AI-generated web experience chat message usefulness.

', 'refs' => [ 'PutFeedbackRequest$messageUsefulness' => '

The feedback usefulness value given by the user to the chat message.

', ], ], 'MessageUsefulnessReason' => [ 'base' => NULL, 'refs' => [ 'MessageUsefulnessFeedback$reason' => '

The reason for a usefulness rating.

', ], ], 'Messages' => [ 'base' => NULL, 'refs' => [ 'ListMessagesResponse$messages' => '

An array of information on one or more messages.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'DataSourceSyncJobMetrics$documentsAdded' => '

The current count of documents added from the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsDeleted' => '

The current count of documents deleted from the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsFailed' => '

The current count of documents that failed to sync from the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsModified' => '

The current count of documents modified in the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsScanned' => '

The current count of documents crawled by the ongoing sync job in the data source.

', ], ], 'NativeIndexConfiguration' => [ 'base' => '

Configuration information for an Amazon Q Business index.

', 'refs' => [ 'RetrieverConfiguration$nativeIndexConfiguration' => '

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

', 'GetChatControlsConfigurationResponse$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

', 'ListApplicationsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

', 'ListApplicationsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.

', 'ListConversationsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

', 'ListConversationsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

', 'ListDataSourceSyncJobsRequest$nextToken' => '

If the maxResults response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.

', 'ListDataSourceSyncJobsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.

', 'ListDataSourcesRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.

', 'ListDataSourcesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.

', 'ListDocumentsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

', 'ListDocumentsResponse$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

', 'ListGroupsRequest$nextToken' => '

If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

', 'ListGroupsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.

', 'ListIndicesRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.

', 'ListIndicesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.

', 'ListMessagesRequest$nextToken' => '

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

', 'ListMessagesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

', 'ListPluginsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

', 'ListPluginsResponse$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

', 'ListRetrieversRequest$nextToken' => '

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

', 'ListRetrieversResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.

', 'ListWebExperiencesRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

', 'ListWebExperiencesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

', ], ], 'NumberAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting NUMBER type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$numberConfiguration' => '

Provides information on boosting NUMBER type document attributes.

', ], ], 'NumberAttributeBoostingType' => [ 'base' => NULL, 'refs' => [ 'NumberAttributeBoostingConfiguration$boostingType' => '

Specifies how much a document attribute is boosted.

', ], ], 'OAuth2ClientCredentialConfiguration' => [ 'base' => '

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

', 'refs' => [ 'PluginAuthConfiguration$oAuth2ClientCredentialConfiguration' => '

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

', ], ], 'Plugin' => [ 'base' => '

Information about an Amazon Q Business plugin and its configuration.

', 'refs' => [ 'Plugins$member' => NULL, ], ], 'PluginArn' => [ 'base' => NULL, 'refs' => [ 'CreatePluginResponse$pluginArn' => '

The Amazon Resource Name (ARN) of a plugin.

', 'GetPluginResponse$pluginArn' => '

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

', ], ], 'PluginAuthConfiguration' => [ 'base' => '

Authentication configuration information for an Amazon Q Business plugin.

', 'refs' => [ 'CreatePluginRequest$authConfiguration' => NULL, 'GetPluginResponse$authConfiguration' => NULL, 'UpdatePluginRequest$authConfiguration' => '

The authentication configuration the plugin is using.

', ], ], 'PluginConfiguration' => [ 'base' => '

Configuration information required to invoke chat in PLUGIN_MODE.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

', 'refs' => [ 'ChatModeConfiguration$pluginConfiguration' => '

Configuration information required to invoke chat in PLUGIN_MODE.

', ], ], 'PluginId' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$pluginId' => '

The identifier of the plugin the action is attached to.

', 'ActionReview$pluginId' => '

The identifier of the plugin associated with the action review.

', 'CreatePluginResponse$pluginId' => '

The identifier of the plugin created.

', 'DeletePluginRequest$pluginId' => '

The identifier of the plugin being deleted.

', 'GetPluginRequest$pluginId' => '

The identifier of the plugin.

', 'GetPluginResponse$pluginId' => '

The identifier of the plugin.

', 'Plugin$pluginId' => '

The identifier of the plugin.

', 'PluginConfiguration$pluginId' => '

The identifier of the plugin you want to use.

', 'UpdatePluginRequest$pluginId' => '

The identifier of the plugin.

', ], ], 'PluginName' => [ 'base' => NULL, 'refs' => [ 'CreatePluginRequest$displayName' => '

A the name for your plugin.

', 'GetPluginResponse$displayName' => '

The name of the plugin.

', 'Plugin$displayName' => '

The name of the plugin.

', 'UpdatePluginRequest$displayName' => '

The name of the plugin.

', ], ], 'PluginState' => [ 'base' => NULL, 'refs' => [ 'GetPluginResponse$state' => '

The current state of the plugin.

', 'Plugin$state' => '

The current status of the plugin.

', 'UpdatePluginRequest$state' => '

The status of the plugin.

', ], ], 'PluginType' => [ 'base' => NULL, 'refs' => [ 'ActionReview$pluginType' => '

The type of plugin.

', 'CreatePluginRequest$type' => '

The type of plugin you want to create.

', 'GetPluginResponse$type' => '

The type of the plugin.

', 'Plugin$type' => '

The type of the plugin.

', ], ], 'Plugins' => [ 'base' => NULL, 'refs' => [ 'ListPluginsResponse$plugins' => '

Information about a configured plugin.

', ], ], 'Principal' => [ 'base' => '

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

', 'refs' => [ 'Principals$member' => NULL, ], ], 'PrincipalGroup' => [ 'base' => '

Provides information about a group associated with the principal.

', 'refs' => [ 'Principal$group' => '

The group associated with the principal.

', ], ], 'PrincipalUser' => [ 'base' => '

Provides information about a user associated with a principal.

', 'refs' => [ 'Principal$user' => '

The user associated with the principal.

', ], ], 'Principals' => [ 'base' => NULL, 'refs' => [ 'AccessControl$principals' => '

Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

', ], ], 'PutFeedbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReadAccessType' => [ 'base' => NULL, 'refs' => [ 'PrincipalGroup$access' => '

Provides information about whether to allow or deny access to the principal.

', 'PrincipalUser$access' => '

Provides information about whether to allow or deny access to the principal.

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

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

', 'refs' => [], ], 'ResponseScope' => [ 'base' => NULL, 'refs' => [ 'GetChatControlsConfigurationResponse$responseScope' => '

The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

', 'UpdateChatControlsConfigurationRequest$responseScope' => '

The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

', ], ], 'Retriever' => [ 'base' => '

Summary information for the retriever used for your Amazon Q Business application.

', 'refs' => [ 'Retrievers$member' => NULL, ], ], 'RetrieverArn' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverResponse$retrieverArn' => '

The Amazon Resource Name (ARN) of an IAM role associated with a retriever.

', 'GetRetrieverResponse$retrieverArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

', ], ], 'RetrieverConfiguration' => [ 'base' => '

Provides information on how the retriever used for your Amazon Q Business application is configured.

', 'refs' => [ 'CreateRetrieverRequest$configuration' => NULL, 'GetRetrieverResponse$configuration' => NULL, 'UpdateRetrieverRequest$configuration' => NULL, ], ], 'RetrieverId' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverResponse$retrieverId' => '

The identifier of the retriever you are using.

', 'DeleteRetrieverRequest$retrieverId' => '

The identifier of the retriever being deleted.

', 'GetRetrieverRequest$retrieverId' => '

The identifier of the retriever.

', 'GetRetrieverResponse$retrieverId' => '

The identifier of the retriever.

', 'Retriever$retrieverId' => '

The identifier of the retriever used by your Amazon Q Business application.

', 'UpdateRetrieverRequest$retrieverId' => '

The identifier of your retriever.

', ], ], 'RetrieverName' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverRequest$displayName' => '

The name of your retriever.

', 'GetRetrieverResponse$displayName' => '

The name of the retriever.

', 'Retriever$displayName' => '

The name of your retriever.

', 'UpdateRetrieverRequest$displayName' => '

The name of your retriever.

', ], ], 'RetrieverStatus' => [ 'base' => NULL, 'refs' => [ 'GetRetrieverResponse$status' => '

The status of the retriever.

', 'Retriever$status' => '

The status of your retriever.

', ], ], 'RetrieverType' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverRequest$type' => '

The type of retriever you are using.

', 'GetRetrieverResponse$type' => '

The type of the retriever.

', 'Retriever$type' => '

The type of your retriever.

', ], ], 'Retrievers' => [ 'base' => NULL, 'refs' => [ 'ListRetrieversResponse$retrievers' => '

An array of summary information for one or more retrievers.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'BasicAuthConfiguration$roleArn' => '

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

', 'BatchPutDocumentRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

', 'CreateApplicationRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

', 'CreateDataSourceRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

', 'CreateRetrieverRequest$roleArn' => '

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

', 'CreateWebExperienceRequest$roleArn' => '

The Amazon Resource Name (ARN) of the service role attached to your web experience.

', 'GetApplicationResponse$roleArn' => '

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

', 'GetDataSourceResponse$roleArn' => '

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

', 'GetRetrieverResponse$roleArn' => '

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

', 'GetWebExperienceResponse$roleArn' => '

The Amazon Resource Name (ARN) of the service role attached to your web experience.

', 'HookConfiguration$roleArn' => '

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

', 'OAuth2ClientCredentialConfiguration$roleArn' => '

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

', 'SamlConfiguration$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

', 'UpdateApplicationRequest$roleArn' => '

An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.

', 'UpdateDataSourceRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

', 'UpdateRetrieverRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

', ], ], 'Rule' => [ 'base' => '

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

', 'refs' => [ 'Rules$member' => NULL, ], ], 'RuleConfiguration' => [ 'base' => '

Provides configuration information about a rule.

', 'refs' => [ 'Rule$ruleConfiguration' => '

The configuration information for a rule.

', ], ], 'RuleType' => [ 'base' => NULL, 'refs' => [ 'Rule$ruleType' => '

The type of rule.

', ], ], 'Rules' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$rules' => '

Rules defined for a topic configuration.

', ], ], 'S3' => [ 'base' => '

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

', 'refs' => [ 'DocumentContent$s3' => '

The path to the document in an Amazon S3 bucket.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'HookConfiguration$s3BucketName' => '

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

', 'S3$bucket' => '

The name of the S3 bucket that contains the file.

', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'S3$key' => '

The name of the file.

', ], ], 'SamlAttribute' => [ 'base' => NULL, 'refs' => [ 'SamlConfiguration$userGroupAttribute' => '

The group attribute name in your IdP that maps to user groups.

', 'SamlConfiguration$userIdAttribute' => '

The user attribute name in your IdP that maps to the user email.

', ], ], 'SamlConfiguration' => [ 'base' => '

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

', 'refs' => [ 'WebExperienceAuthConfiguration$samlConfiguration' => NULL, ], ], 'SamlMetadataXML' => [ 'base' => NULL, 'refs' => [ 'SamlConfiguration$metadataXML' => '

The metadata XML that your IdP generated.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'BasicAuthConfiguration$secretArn' => '

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

', 'OAuth2ClientCredentialConfiguration$secretArn' => '

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DataSourceVpcConfiguration$securityGroupIds' => '

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.

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

You have exceeded the set limits for your Amazon Q Business service.

', 'refs' => [], ], 'SourceAttribution' => [ 'base' => '

The documents used to generate an Amazon Q Business web experience response.

', 'refs' => [ 'SourceAttributions$member' => NULL, ], ], 'SourceAttributions' => [ 'base' => NULL, 'refs' => [ 'ChatSyncOutput$sourceAttributions' => '

The source documents used to generate the conversation response.

', 'Message$sourceAttribution' => '

The source documents used to generate Amazon Q Business web experience message.

', ], ], 'StartDataSourceSyncJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataSourceSyncJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeConfiguration$search' => '

Information about whether the document attribute can be used by an end user to search for information on their web experience.

', ], ], 'StopDataSourceSyncJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopDataSourceSyncJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$displayName' => '

The name of the field.

', 'ChatSyncOutput$systemMessage' => '

An AI-generated message in a conversation.

', 'ConflictException$resourceId' => '

The identifier of the resource affected.

', 'ConflictException$resourceType' => '

The type of the resource affected.

', 'CreateUserRequest$userId' => '

The user emails attached to a user mapping.

', 'DataSource$type' => '

The type of the Amazon Q Business data source.

', 'DataSourceSyncJob$dataSourceErrorCode' => '

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

', 'DeleteUserRequest$userId' => '

The user email being deleted.

', 'DocumentAttributeConfiguration$name' => '

The name of the document attribute.

', 'DocumentAttributeStringListValue$member' => NULL, 'GetDataSourceResponse$type' => '

The type of the data source connector. For example, S3.

', 'GetUserRequest$userId' => '

The user email address attached to the user.

', 'Message$messageId' => '

The identifier of the Amazon Q Business web experience message.

', 'ResourceNotFoundException$resourceId' => '

The identifier of the resource affected.

', 'ResourceNotFoundException$resourceType' => '

The type of the resource affected.

', 'ServiceQuotaExceededException$resourceId' => '

The identifier of the resource affected.

', 'ServiceQuotaExceededException$resourceType' => '

The type of the resource affected.

', 'SourceAttribution$snippet' => '

The content extract from the document on which the generated response is based.

', 'SourceAttribution$title' => '

The title of the document which is the source for the Amazon Q Business generated response.

', 'SourceAttribution$url' => '

The URL of the document which is the source for the Amazon Q Business generated response.

', 'StringAttributeValueBoosting$key' => NULL, 'UpdateUserRequest$userId' => '

The email id attached to the user.

', 'UserAlias$userId' => '

The identifier of the user id associated with the user aliases.

', 'UserGroups$member' => NULL, 'UserIds$member' => NULL, 'ValidationExceptionField$message' => '

A message about the validation exception.

', 'ValidationExceptionField$name' => '

The field name where the invalid entry was detected.

', ], ], 'StringAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting STRING type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven\'t enabled searching on these attributes, you can\'t boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$stringConfiguration' => '

Provides information on boosting STRING type document attributes.

', ], ], 'StringAttributeValueBoosting' => [ 'base' => NULL, 'refs' => [ 'StringAttributeBoostingConfiguration$attributeValueBoosting' => '

Specifies specific values of a STRING type document attribute being boosted.

', ], ], 'StringAttributeValueBoostingLevel' => [ 'base' => NULL, 'refs' => [ 'StringAttributeValueBoosting$value' => NULL, ], ], 'StringListAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting STRING_LIST type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven\'t enabled searching on these attributes, you can\'t boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$stringListConfiguration' => '

Provides information on boosting STRING_LIST type document attributes.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'DataSourceVpcConfiguration$subnetIds' => '

A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

', ], ], 'SyncSchedule' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceRequest$syncSchedule' => '

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don\'t set a schedule, Amazon Q Business won\'t periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can\'t specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

', 'GetDataSourceResponse$syncSchedule' => '

The schedule for Amazon Q Business to update the index.

', 'UpdateDataSourceRequest$syncSchedule' => '

The chosen update frequency for your data source.

', ], ], 'SystemMessageId' => [ 'base' => NULL, 'refs' => [ 'PutFeedbackRequest$messageId' => '

The identifier of the chat message that the feedback was given for.

', ], ], 'SystemMessageOverride' => [ 'base' => NULL, 'refs' => [ 'BlockedPhrasesConfiguration$systemMessageOverride' => '

The configured custom message displayed to an end user informing them that they\'ve used a blocked phrase during chat.

', 'BlockedPhrasesConfigurationUpdate$systemMessageOverride' => '

The configured custom message displayed to your end user when they use blocked phrase during chat.

', 'ContentBlockerRule$systemMessageOverride' => '

The configured custom message displayed to an end user informing them that they\'ve used a blocked phrase during chat.

', ], ], 'Tag' => [ 'base' => '

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The value associated with the tag. The value may be an empty string but it can\'t be null.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$tags' => '

A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateDataSourceRequest$tags' => '

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateIndexRequest$tags' => '

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreatePluginRequest$tags' => '

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateRetrieverRequest$tags' => '

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateWebExperienceRequest$tags' => '

A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'ListTagsForResourceResponse$tags' => '

A list of tags associated with the Amazon Q Business application or data source.

', 'TagResourceRequest$tags' => '

A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.

', ], ], 'TextDocumentStatistics' => [ 'base' => '

Provides information about text documents in an index.

', 'refs' => [ 'IndexStatistics$textDocumentStatistics' => '

The number of documents indexed.

', ], ], 'TextSegment' => [ 'base' => '

Provides information about a text extract in a chat response that can be attributed to a source document.

', 'refs' => [ 'TextSegmentList$member' => NULL, ], ], 'TextSegmentList' => [ 'base' => NULL, 'refs' => [ 'SourceAttribution$textMessageSegments' => '

A text extract from a source document that is used for source attribution.

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

The request was denied due to throttling. Reduce the number of requests and try again.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Application$createdAt' => '

The Unix timestamp when the Amazon Q Business application was created.

', 'Application$updatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'Conversation$startTime' => '

The start time of the conversation.

', 'DataSource$createdAt' => '

The Unix timestamp when the Amazon Q Business data source was created.

', 'DataSource$updatedAt' => '

The Unix timestamp when the Amazon Q Business data source was last updated.

', 'DataSourceSyncJob$endTime' => '

The Unix timestamp when the synchronization job completed.

', 'DataSourceSyncJob$startTime' => '

The Unix time stamp when the data source synchronization job started.

', 'DocumentAttributeValue$dateValue' => '

A date expressed as an ISO 8601 string.

It\'s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

', 'DocumentDetails$createdAt' => '

The timestamp for when the document was created.

', 'DocumentDetails$updatedAt' => '

The timestamp for when the document was last updated.

', 'GetApplicationResponse$createdAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'GetApplicationResponse$updatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'GetDataSourceResponse$createdAt' => '

The Unix timestamp when the data source connector was created.

', 'GetDataSourceResponse$updatedAt' => '

The Unix timestamp when the data source connector was last updated.

', 'GetIndexResponse$createdAt' => '

The Unix timestamp when the Amazon Q Business index was created.

', 'GetIndexResponse$updatedAt' => '

The Unix timestamp when the Amazon Q Business index was last updated.

', 'GetPluginResponse$createdAt' => '

The timestamp for when the plugin was created.

', 'GetPluginResponse$updatedAt' => '

The timestamp for when the plugin was last updated.

', 'GetRetrieverResponse$createdAt' => '

The Unix timestamp when the retriever was created.

', 'GetRetrieverResponse$updatedAt' => '

The Unix timestamp when the retriever was last updated.

', 'GetWebExperienceResponse$createdAt' => '

The Unix timestamp when the retriever was created.

', 'GetWebExperienceResponse$updatedAt' => '

The Unix timestamp when the data source connector was last updated.

', 'GroupStatusDetail$lastUpdatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'Index$createdAt' => '

The Unix timestamp when the index was created.

', 'Index$updatedAt' => '

The Unix timestamp when the index was last updated.

', 'ListDataSourceSyncJobsRequest$endTime' => '

The end time of the data source connector sync.

', 'ListDataSourceSyncJobsRequest$startTime' => '

The start time of the data source connector sync.

', 'ListGroupsRequest$updatedEarlierThan' => '

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

', 'Message$time' => '

The timestamp of the first Amazon Q Business web experience message.

', 'MessageUsefulnessFeedback$submittedAt' => '

The timestamp for when the feedback was submitted.

', 'Plugin$createdAt' => '

The timestamp for when the plugin was created.

', 'Plugin$updatedAt' => '

The timestamp for when the plugin was last updated.

', 'PutFeedbackRequest$messageCopiedAt' => '

The timestamp for when the feedback was recorded.

', 'SourceAttribution$updatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'WebExperience$createdAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'WebExperience$updatedAt' => '

The Unix timestamp when your Amazon Q Business web experience was updated.

', ], ], 'Title' => [ 'base' => NULL, 'refs' => [ 'Document$title' => '

The title of the document.

', ], ], 'TopicConfiguration' => [ 'base' => '

The topic specific controls configured for an Amazon Q Business application.

', 'refs' => [ 'TopicConfigurations$member' => NULL, ], ], 'TopicConfigurationName' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$name' => '

A name for your topic control configuration.

', ], ], 'TopicConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetChatControlsConfigurationResponse$topicConfigurations' => '

The topic specific controls configured for a Amazon Q Business application.

', 'UpdateChatControlsConfigurationRequest$topicConfigurationsToCreateOrUpdate' => '

The configured topic specific chat controls you want to update.

', 'UpdateChatControlsConfigurationRequest$topicConfigurationsToDelete' => '

The configured topic specific chat controls you want to delete.

', ], ], 'TopicDescription' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$description' => '

A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChatControlsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChatControlsConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'CreatePluginRequest$serverUrl' => '

The source URL used for plugin configuration.

', 'GetPluginResponse$serverUrl' => '

The source URL used for plugin configuration.

', 'GetWebExperienceResponse$defaultEndpoint' => '

The endpoint of your Amazon Q Business web experience.

', 'Plugin$serverUrl' => '

The plugin server URL used for configuration.

', 'UpdatePluginRequest$serverUrl' => '

The source URL used for plugin configuration.

', 'WebExperience$defaultEndpoint' => '

The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.

', ], ], 'UserAlias' => [ 'base' => '

Aliases attached to a user id within an Amazon Q Business application.

', 'refs' => [ 'CreateUserRequestUserAliasesList$member' => NULL, 'UserAliases$member' => NULL, ], ], 'UserAliases' => [ 'base' => NULL, 'refs' => [ 'GetUserResponse$userAliases' => '

A list of user aliases attached to a user.

', 'UpdateUserRequest$userAliasesToDelete' => '

The user aliases attached to the user id that are to be deleted.

', 'UpdateUserRequest$userAliasesToUpdate' => '

The user aliases attached to the user id that are to be updated.

', 'UpdateUserResponse$userAliasesAdded' => '

The user aliases that have been to be added to a user id.

', 'UpdateUserResponse$userAliasesDeleted' => '

The user aliases that have been deleted from a user id.

', 'UpdateUserResponse$userAliasesUpdated' => '

The user aliases attached to a user id that have been updated.

', ], ], 'UserGroups' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$userGroups' => '

The groups that a user associated with the chat input belongs to.

', 'UsersAndGroups$userGroups' => '

The user groups associated with a topic control rule.

', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$userId' => '

The identifier of the user attached to the chat input.

', 'DeleteConversationRequest$userId' => '

The identifier of the user who is deleting the conversation.

', 'ListConversationsRequest$userId' => '

The identifier of the user involved in the Amazon Q Business web experience conversation.

', 'ListMessagesRequest$userId' => '

The identifier of the user involved in the Amazon Q Business web experience conversation.

', 'PrincipalUser$id' => '

The identifier of the user.

', 'PutFeedbackRequest$userId' => '

The identifier of the user giving the feedback.

', ], ], 'UserIds' => [ 'base' => NULL, 'refs' => [ 'UsersAndGroups$userIds' => '

The user ids associated with a topic control rule.

', ], ], 'UserMessage' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$userMessage' => '

A end user message in a conversation.

', ], ], 'UsersAndGroups' => [ 'base' => '

Provides information about users and groups associated with a topic control rule.

', 'refs' => [ 'Rule$excludedUsersAndGroups' => '

Users and groups to be excluded from a rule.

', 'Rule$includedUsersAndGroups' => '

Users and groups to be included in a rule.

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

The input doesn\'t meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '

The input failed to meet the constraints specified by Amazon Q Business in a specified field.

', 'refs' => [ 'ValidationExceptionFields$member' => NULL, ], ], 'ValidationExceptionFields' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fields' => '

The input field(s) that failed validation.

', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '

The reason for the ValidationException.

', ], ], 'WebExperience' => [ 'base' => '

Provides information for an Amazon Q Business web experience.

', 'refs' => [ 'WebExperiences$member' => NULL, ], ], 'WebExperienceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceResponse$webExperienceArn' => '

The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

', 'GetWebExperienceResponse$webExperienceArn' => '

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

', ], ], 'WebExperienceAuthConfiguration' => [ 'base' => '

Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

', 'refs' => [ 'GetWebExperienceResponse$authenticationConfiguration' => '

The authentication configuration information for your Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$authenticationConfiguration' => '

The authentication configuration of the Amazon Q Business web experience.

', ], ], 'WebExperienceId' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceResponse$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'DeleteWebExperienceRequest$webExperienceId' => '

The identifier of the Amazon Q Business web experience being deleted.

', 'GetWebExperienceRequest$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'GetWebExperienceResponse$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'WebExperience$webExperienceId' => '

The identifier of your Amazon Q Business web experience.

', ], ], 'WebExperienceSamplePromptsControlMode' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$samplePromptsControlMode' => '

Determines whether sample prompts are enabled in the web experience for an end user.

', 'GetWebExperienceResponse$samplePromptsControlMode' => '

Determines whether sample prompts are enabled in the web experience for an end user.

', 'UpdateWebExperienceRequest$samplePromptsControlMode' => '

Determines whether sample prompts are enabled in the web experience for an end user.

', ], ], 'WebExperienceStatus' => [ 'base' => NULL, 'refs' => [ 'GetWebExperienceResponse$status' => '

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', 'WebExperience$status' => '

The status of your Amazon Q Business web experience.

', ], ], 'WebExperienceSubtitle' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$subtitle' => '

A subtitle to personalize your Amazon Q Business web experience.

', 'GetWebExperienceResponse$subtitle' => '

The subtitle for your Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$subtitle' => '

The subtitle of the Amazon Q Business web experience.

', ], ], 'WebExperienceTitle' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$title' => '

The title for your Amazon Q Business web experience.

', 'GetWebExperienceResponse$title' => '

The title for your Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$title' => '

The title of the Amazon Q Business web experience.

', ], ], 'WebExperienceWelcomeMessage' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$welcomeMessage' => '

The customized welcome message for end users of an Amazon Q Business web experience.

', 'GetWebExperienceResponse$welcomeMessage' => '

The customized welcome message for end users of an Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$welcomeMessage' => '

A customized welcome message for an end user in an Amazon Q Business web experience.

', ], ], 'WebExperiences' => [ 'base' => NULL, 'refs' => [ 'ListWebExperiencesResponse$webExperiences' => '

An array of summary information for one or more Amazon Q Business experiences.

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

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

You can use the following AWS SDKs to access Amazon Q Business APIs:

The following resources provide additional information about using the Amazon Q Business API:

', 'operations' => [ 'BatchDeleteDocument' => '

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

', 'BatchPutDocument' => '

Adds one or more documents to an Amazon Q Business index.

You use this API to:

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

', 'Chat' => '

Starts or continues a streaming Amazon Q Business conversation.

', 'ChatSync' => '

Starts or continues a non-streaming Amazon Q Business conversation.

', 'CreateApplication' => '

Creates an Amazon Q Business application.

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what\'s included in Amazon Q Business Lite and what\'s included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

', 'CreateDataSource' => '

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

', 'CreateIndex' => '

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

', 'CreatePlugin' => '

Creates an Amazon Q Business plugin.

', 'CreateRetriever' => '

Adds a retriever to your Amazon Q Business application.

', 'CreateUser' => '

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

', 'CreateWebExperience' => '

Creates an Amazon Q Business web experience.

', 'DeleteApplication' => '

Deletes an Amazon Q Business application.

', 'DeleteChatControlsConfiguration' => '

Deletes chat controls configured for an existing Amazon Q Business application.

', 'DeleteConversation' => '

Deletes an Amazon Q Business web experience conversation.

', 'DeleteDataSource' => '

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

', 'DeleteGroup' => '

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.

If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.

', 'DeleteIndex' => '

Deletes an Amazon Q Business index.

', 'DeletePlugin' => '

Deletes an Amazon Q Business plugin.

', 'DeleteRetriever' => '

Deletes the retriever used by an Amazon Q Business application.

', 'DeleteUser' => '

Deletes a user by email id.

', 'DeleteWebExperience' => '

Deletes an Amazon Q Business web experience.

', 'GetApplication' => '

Gets information about an existing Amazon Q Business application.

', 'GetChatControlsConfiguration' => '

Gets information about an chat controls configured for an existing Amazon Q Business application.

', 'GetDataSource' => '

Gets information about an existing Amazon Q Business data source connector.

', 'GetGroup' => '

Describes a group by group name.

', 'GetIndex' => '

Gets information about an existing Amazon Q Business index.

', 'GetPlugin' => '

Gets information about an existing Amazon Q Business plugin.

', 'GetRetriever' => '

Gets information about an existing retriever used by an Amazon Q Business application.

', 'GetUser' => '

Describes the universally unique identifier (UUID) associated with a local user in a data source.

', 'GetWebExperience' => '

Gets information about an existing Amazon Q Business web experience.

', 'ListApplications' => '

Lists Amazon Q Business applications.

', 'ListConversations' => '

Lists one or more Amazon Q Business conversations.

', 'ListDataSourceSyncJobs' => '

Get information about an Amazon Q Business data source connector synchronization.

', 'ListDataSources' => '

Lists the Amazon Q Business data source connectors that you have created.

', 'ListDocuments' => '

A list of documents attached to an index.

', 'ListGroups' => '

Provides a list of groups that are mapped to users.

', 'ListIndices' => '

Lists the Amazon Q Business indices you have created.

', 'ListMessages' => '

Gets a list of messages associated with an Amazon Q Business web experience.

', 'ListPlugins' => '

Lists configured Amazon Q Business plugins.

', 'ListRetrievers' => '

Lists the retriever used by an Amazon Q Business application.

', 'ListTagsForResource' => '

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

', 'ListWebExperiences' => '

Lists one or more Amazon Q Business Web Experiences.

', 'PutFeedback' => '

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

', 'PutGroup' => '

Create, or updates, a mapping of users—who have access to a document—to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

', 'StartDataSourceSyncJob' => '

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

', 'StopDataSourceSyncJob' => '

Stops an Amazon Q Business data source connector synchronization job already in progress.

', 'TagResource' => '

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

', 'UntagResource' => '

Removes a tag from an Amazon Q Business application or a data source.

', 'UpdateApplication' => '

Updates an existing Amazon Q Business application.

', 'UpdateChatControlsConfiguration' => '

Updates an set of chat controls configured for an existing Amazon Q Business application.

', 'UpdateDataSource' => '

Updates an existing Amazon Q Business data source connector.

', 'UpdateIndex' => '

Updates an Amazon Q Business index.

', 'UpdatePlugin' => '

Updates an Amazon Q Business plugin.

', 'UpdateRetriever' => '

Updates the retriever used for your Amazon Q Business application.

', 'UpdateUser' => '

Updates a information associated with a user id.

', 'UpdateWebExperience' => '

Updates an Amazon Q Business web experience.

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

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

', 'refs' => [ 'CustomPluginConfiguration$apiSchema' => '

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

', ], ], 'APISchemaType' => [ 'base' => NULL, 'refs' => [ 'CustomPluginConfiguration$apiSchemaType' => '

The type of OpenAPI schema to use.

', ], ], 'AccessConfiguration' => [ 'base' => '

Used to configure access permissions for a document.

', 'refs' => [ 'Document$accessConfiguration' => '

Configuration information for access permission to a document.

', ], ], 'AccessControl' => [ 'base' => '

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

', 'refs' => [ 'AccessControls$member' => NULL, ], ], 'AccessControls' => [ 'base' => NULL, 'refs' => [ 'AccessConfiguration$accessControls' => '

A list of AccessControlList objects.

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

You don\'t have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

', 'refs' => [], ], 'ActionExecution' => [ 'base' => '

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

', 'refs' => [ 'ChatSyncInput$actionExecution' => '

A request from an end user to perform an Amazon Q Business plugin action.

', 'Message$actionExecution' => NULL, ], ], 'ActionExecutionEvent' => [ 'base' => '

A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.

', 'refs' => [ 'ChatInputStream$actionExecutionEvent' => '

A request from an end user to perform an Amazon Q Business plugin action.

', ], ], 'ActionExecutionPayload' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$payload' => '

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

', 'ActionExecutionEvent$payload' => '

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

', ], ], 'ActionExecutionPayloadField' => [ 'base' => '

A user input field in an plugin action execution payload.

', 'refs' => [ 'ActionExecutionPayload$value' => NULL, ], ], 'ActionPayloadFieldKey' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionPayload$key' => NULL, 'ActionReviewPayload$key' => NULL, ], ], 'ActionPayloadFieldNameSeparator' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$payloadFieldNameSeparator' => '

A string used to retain information about the hierarchical contexts within an action execution event payload.

', 'ActionExecutionEvent$payloadFieldNameSeparator' => '

A string used to retain information about the hierarchical contexts within a action execution event payload.

', 'ActionReview$payloadFieldNameSeparator' => '

A string used to retain information about the hierarchical contexts within an action review payload.

', 'ActionReviewEvent$payloadFieldNameSeparator' => '

A string used to retain information about the hierarchical contexts within an action review event payload.

', ], ], 'ActionPayloadFieldType' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$type' => '

The type of field.

', ], ], 'ActionPayloadFieldValue' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionPayloadField$value' => '

The content of a user input field in an plugin action execution payload.

', 'ActionReviewPayloadField$value' => '

The field value.

', 'ActionReviewPayloadFieldAllowedValue$value' => '

The field value.

', 'ActionReviewPayloadFieldAllowedValue$displayValue' => '

The name of the field.

', ], ], 'ActionReview' => [ 'base' => '

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

', 'refs' => [ 'ChatSyncOutput$actionReview' => '

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

', 'Message$actionReview' => NULL, ], ], 'ActionReviewEvent' => [ 'base' => '

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

', 'refs' => [ 'ChatOutputStream$actionReviewEvent' => '

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

', ], ], 'ActionReviewPayload' => [ 'base' => NULL, 'refs' => [ 'ActionReview$payload' => '

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', 'ActionReviewEvent$payload' => '

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', ], ], 'ActionReviewPayloadField' => [ 'base' => '

A user input field in an plugin action review payload.

', 'refs' => [ 'ActionReviewPayload$value' => NULL, ], ], 'ActionReviewPayloadFieldAllowedValue' => [ 'base' => '

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', 'refs' => [ 'ActionReviewPayloadFieldAllowedValues$member' => NULL, ], ], 'ActionReviewPayloadFieldAllowedValues' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$allowedValues' => '

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceARN' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.

', 'TagResourceRequest$resourceARN' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.

', 'UntagResourceRequest$resourceARN' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.

', ], ], 'Application' => [ 'base' => '

Summary information for an Amazon Q Business application.

', 'refs' => [ 'Applications$member' => NULL, ], ], 'ApplicationArn' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationResponse$applicationArn' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application.

', 'GetApplicationResponse$applicationArn' => '

The Amazon Resource Name (ARN) of the Amazon Q Business application.

', ], ], 'ApplicationId' => [ 'base' => NULL, 'refs' => [ 'Application$applicationId' => '

The identifier for the Amazon Q Business application.

', 'BatchDeleteDocumentRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'BatchPutDocumentRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'ChatInput$applicationId' => '

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

', 'ChatSyncInput$applicationId' => '

The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

', 'CreateApplicationResponse$applicationId' => '

The identifier of the Amazon Q Business application.

', 'CreateDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application the data source will be attached to.

', 'CreateIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application using the index.

', 'CreatePluginRequest$applicationId' => '

The identifier of the application that will contain the plugin.

', 'CreateRetrieverRequest$applicationId' => '

The identifier of your Amazon Q Business application.

', 'CreateUserRequest$applicationId' => '

The identifier of the application for which the user mapping will be created.

', 'CreateWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business web experience.

', 'DeleteApplicationRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'DeleteChatControlsConfigurationRequest$applicationId' => '

The identifier of the application the chat controls have been configured for.

', 'DeleteConversationRequest$applicationId' => '

The identifier of the Amazon Q Business application associated with the conversation.

', 'DeleteDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application used with the data source connector.

', 'DeleteGroupRequest$applicationId' => '

The identifier of the application in which the group mapping belongs.

', 'DeleteIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.

', 'DeletePluginRequest$applicationId' => '

The identifier the application attached to the Amazon Q Business plugin.

', 'DeleteRetrieverRequest$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'DeleteUserRequest$applicationId' => '

The identifier of the application from which the user is being deleted.

', 'DeleteWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.

', 'GetApplicationRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetApplicationResponse$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetChatControlsConfigurationRequest$applicationId' => '

The identifier of the application for which the chat controls are configured.

', 'GetDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetDataSourceResponse$applicationId' => '

The identifier of the Amazon Q Business application.

', 'GetGroupRequest$applicationId' => '

The identifier of the application id the group is attached to.

', 'GetIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the index.

', 'GetIndexResponse$applicationId' => '

The identifier of the Amazon Q Business application associated with the index.

', 'GetPluginRequest$applicationId' => '

The identifier of the application which contains the plugin.

', 'GetPluginResponse$applicationId' => '

The identifier of the application which contains the plugin.

', 'GetRetrieverRequest$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'GetRetrieverResponse$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'GetUserRequest$applicationId' => '

The identifier of the application connected to the user.

', 'GetWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the web experience.

', 'GetWebExperienceResponse$applicationId' => '

The identifier of the Amazon Q Business application linked to the web experience.

', 'ListConversationsRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'ListDataSourceSyncJobsRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the data source.

', 'ListDataSourcesRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the data source connectors.

', 'ListDocumentsRequest$applicationId' => '

The identifier of the application id the documents are attached to.

', 'ListGroupsRequest$applicationId' => '

The identifier of the application for getting a list of groups mapped to users.

', 'ListIndicesRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the index.

', 'ListMessagesRequest$applicationId' => '

The identifier for the Amazon Q Business application.

', 'ListPluginsRequest$applicationId' => '

The identifier of the application the plugin is attached to.

', 'ListRetrieversRequest$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'ListWebExperiencesRequest$applicationId' => '

The identifier of the Amazon Q Business application linked to the listed web experiences.

', 'PutFeedbackRequest$applicationId' => '

The identifier of the application associated with the feedback.

', 'PutGroupRequest$applicationId' => '

The identifier of the application in which the user and group mapping belongs.

', 'Retriever$applicationId' => '

The identifier of the Amazon Q Business application using the retriever.

', 'StartDataSourceSyncJobRequest$applicationId' => '

The identifier of Amazon Q Business application the data source is connected to.

', 'StopDataSourceSyncJobRequest$applicationId' => '

The identifier of the Amazon Q Business application that the data source is connected to.

', 'UpdateApplicationRequest$applicationId' => '

The identifier of the Amazon Q Business application.

', 'UpdateChatControlsConfigurationRequest$applicationId' => '

The identifier of the application for which the chat controls are configured.

', 'UpdateDataSourceRequest$applicationId' => '

The identifier of the Amazon Q Business application the data source is attached to.

', 'UpdateIndexRequest$applicationId' => '

The identifier of the Amazon Q Business application connected to the index.

', 'UpdatePluginRequest$applicationId' => '

The identifier of the application the plugin is attached to.

', 'UpdateRetrieverRequest$applicationId' => '

The identifier of your Amazon Q Business application.

', 'UpdateUserRequest$applicationId' => '

The identifier of the application the user is attached to.

', 'UpdateWebExperienceRequest$applicationId' => '

The identifier of the Amazon Q Business application attached to the web experience.

', ], ], 'ApplicationName' => [ 'base' => NULL, 'refs' => [ 'Application$displayName' => '

The name of the Amazon Q Business application.

', 'CreateApplicationRequest$displayName' => '

A name for the Amazon Q Business application.

', 'GetApplicationResponse$displayName' => '

The name of the Amazon Q Business application.

', 'UpdateApplicationRequest$displayName' => '

A name for the Amazon Q Business application.

', 'UpdateIndexRequest$displayName' => '

The name of the Amazon Q Business index.

', ], ], 'ApplicationStatus' => [ 'base' => NULL, 'refs' => [ 'Application$status' => '

The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.

', 'GetApplicationResponse$status' => '

The status of the Amazon Q Business application.

', ], ], 'Applications' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsResponse$applications' => '

An array of summary information on the configuration of one or more Amazon Q Business applications.

', ], ], 'AppliedAttachmentsConfiguration' => [ 'base' => '

Configuration information about the file upload during chat feature for your application.

', 'refs' => [ 'GetApplicationResponse$attachmentsConfiguration' => '

Settings for whether end users can upload files directly during chat.

', ], ], 'AppliedCreatorModeConfiguration' => [ 'base' => '

The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.

For more information, see Admin controls and guardrails and Conversation settings.

', 'refs' => [ 'GetChatControlsConfigurationResponse$creatorModeConfiguration' => '

The configuration details for CREATOR_MODE.

', ], ], 'AttachmentInput' => [ 'base' => '

A file directly uploaded into a web experience chat.

', 'refs' => [ 'AttachmentInputEvent$attachment' => NULL, 'AttachmentsInput$member' => NULL, ], ], 'AttachmentInputEvent' => [ 'base' => '

A file input event activated by a end user request to upload files into their web experience chat.

', 'refs' => [ 'ChatInputStream$attachmentEvent' => '

A request by an end user to upload a file during chat.

', ], ], 'AttachmentName' => [ 'base' => NULL, 'refs' => [ 'AttachmentInput$name' => '

The name of the file.

', 'AttachmentOutput$name' => '

The name of a file uploaded during chat.

', ], ], 'AttachmentOutput' => [ 'base' => '

The details of a file uploaded during chat.

', 'refs' => [ 'AttachmentsOutput$member' => NULL, 'FailedAttachmentEvent$attachment' => NULL, ], ], 'AttachmentStatus' => [ 'base' => NULL, 'refs' => [ 'AttachmentOutput$status' => '

The status of a file uploaded during chat.

', ], ], 'AttachmentsConfiguration' => [ 'base' => '

Configuration information for the file upload during chat feature.

', 'refs' => [ 'CreateApplicationRequest$attachmentsConfiguration' => '

An option to allow end users to upload files directly during chat.

', 'UpdateApplicationRequest$attachmentsConfiguration' => '

An option to allow end users to upload files directly during chat.

', ], ], 'AttachmentsControlMode' => [ 'base' => NULL, 'refs' => [ 'AppliedAttachmentsConfiguration$attachmentsControlMode' => '

Information about whether file upload during chat functionality is activated for your application.

', 'AttachmentsConfiguration$attachmentsControlMode' => '

Status information about whether file upload functionality is activated or deactivated for your end user.

', ], ], 'AttachmentsInput' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$attachments' => '

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

', ], ], 'AttachmentsOutput' => [ 'base' => NULL, 'refs' => [ 'ChatSyncOutput$failedAttachments' => '

A list of files which failed to upload during chat.

', 'Message$attachments' => '

A file directly uploaded into an Amazon Q Business web experience chat.

', ], ], 'AttributeFilter' => [ 'base' => '

Enables filtering of responses based on document attributes or metadata fields.

', 'refs' => [ 'AttributeFilter$notFilter' => '

Performs a logical NOT operation on all supplied filters.

', 'AttributeFilters$member' => NULL, 'ChatSyncInput$attributeFilter' => '

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

', 'ConfigurationEvent$attributeFilter' => NULL, ], ], 'AttributeFilters' => [ 'base' => NULL, 'refs' => [ 'AttributeFilter$andAllFilters' => '

Performs a logical AND operation on all supplied filters.

', 'AttributeFilter$orAllFilters' => '

Performs a logical OR operation on all supplied filters.

', ], ], 'AttributeType' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeConfiguration$type' => '

The type of document attribute.

', ], ], 'AttributeValueOperator' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeTarget$attributeValueOperator' => '

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

', ], ], 'AuthChallengeRequest' => [ 'base' => '

A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.

', 'refs' => [ 'ChatSyncOutput$authChallengeRequest' => '

An authentication verification event activated by an end user request to use a custom plugin.

', ], ], 'AuthChallengeRequestEvent' => [ 'base' => '

An authentication verification event activated by an end user request to use a custom plugin.

', 'refs' => [ 'ChatOutputStream$authChallengeRequestEvent' => '

An authentication verification event activated by an end user request to use a custom plugin.

', ], ], 'AuthChallengeResponse' => [ 'base' => '

Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.

', 'refs' => [ 'ChatSyncInput$authChallengeResponse' => '

An authentication verification event response by a third party authentication server to Amazon Q Business.

', ], ], 'AuthChallengeResponseEvent' => [ 'base' => '

An authentication verification event response by a third party authentication server to Amazon Q Business.

', 'refs' => [ 'ChatInputStream$authChallengeResponseEvent' => '

An authentication verification event response by a third party authentication server to Amazon Q Business.

', ], ], 'AuthResponseKey' => [ 'base' => NULL, 'refs' => [ 'AuthorizationResponseMap$key' => NULL, ], ], 'AuthResponseValue' => [ 'base' => NULL, 'refs' => [ 'AuthorizationResponseMap$value' => NULL, ], ], 'AuthorizationResponseMap' => [ 'base' => NULL, 'refs' => [ 'AuthChallengeResponse$responseMap' => '

The mapping of key-value pairs in an authentication challenge response.

', 'AuthChallengeResponseEvent$responseMap' => '

The mapping of key-value pairs in an authentication challenge response.

', ], ], 'BasicAuthConfiguration' => [ 'base' => '

Information about the basic authentication credentials used to configure a plugin.

', 'refs' => [ 'PluginAuthConfiguration$basicAuthConfiguration' => '

Information about the basic authentication credentials used to configure a plugin.

', ], ], 'BatchDeleteDocumentRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteDocumentResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutDocumentRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutDocumentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'AttachmentInput$data' => '

The data contained within the uploaded file.

', 'DocumentContent$blob' => '

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you\'re using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

', ], ], 'BlockedPhrase' => [ 'base' => NULL, 'refs' => [ 'BlockedPhrases$member' => NULL, ], ], 'BlockedPhrases' => [ 'base' => NULL, 'refs' => [ 'BlockedPhrasesConfiguration$blockedPhrases' => '

A list of phrases blocked from a Amazon Q Business web experience chat.

', 'BlockedPhrasesConfigurationUpdate$blockedPhrasesToCreateOrUpdate' => '

Creates or updates a blocked phrases configuration in your Amazon Q Business application.

', 'BlockedPhrasesConfigurationUpdate$blockedPhrasesToDelete' => '

Deletes a blocked phrases configuration in your Amazon Q Business application.

', ], ], 'BlockedPhrasesConfiguration' => [ 'base' => '

Provides information about the phrases blocked from chat by your chat control configuration.

', 'refs' => [ 'GetChatControlsConfigurationResponse$blockedPhrases' => '

The phrases blocked from chat by your chat control configuration.

', ], ], 'BlockedPhrasesConfigurationUpdate' => [ 'base' => '

Updates a blocked phrases configuration in your Amazon Q Business application.

', 'refs' => [ 'UpdateChatControlsConfigurationRequest$blockedPhrasesConfigurationUpdate' => '

The phrases blocked from chat by your chat control configuration.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$required' => '

Information about whether the field is required.

', ], ], 'BoostingDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'DateAttributeBoostingConfiguration$boostingDurationInSeconds' => '

Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

', ], ], 'ChatInput' => [ 'base' => NULL, 'refs' => [], ], 'ChatInputStream' => [ 'base' => '

The streaming input for the Chat API.

', 'refs' => [ 'ChatInput$inputStream' => '

The streaming input for the Chat API.

', ], ], 'ChatMode' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$chatMode' => '

The chat modes available to an Amazon Q Business end user.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

', 'ConfigurationEvent$chatMode' => '

The chat modes available to an Amazon Q Business end user.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

', ], ], 'ChatModeConfiguration' => [ 'base' => '

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

', 'refs' => [ 'ChatSyncInput$chatModeConfiguration' => '

The chat mode configuration for an Amazon Q Business application.

', 'ConfigurationEvent$chatModeConfiguration' => NULL, ], ], 'ChatOutput' => [ 'base' => NULL, 'refs' => [], ], 'ChatOutputStream' => [ 'base' => '

The streaming output for the Chat API.

', 'refs' => [ 'ChatOutput$outputStream' => '

The streaming output for the Chat API.

', ], ], 'ChatSyncInput' => [ 'base' => NULL, 'refs' => [], ], 'ChatSyncOutput' => [ 'base' => NULL, 'refs' => [], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'ChatInput$clientToken' => '

A token that you provide to identify the chat input.

', 'ChatSyncInput$clientToken' => '

A token that you provide to identify a chat request.

', 'CreateApplicationRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business application.

', 'CreateDataSourceRequest$clientToken' => '

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

', 'CreateIndexRequest$clientToken' => '

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

', 'CreatePluginRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business plugin.

', 'CreateRetrieverRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business application retriever.

', 'CreateUserRequest$clientToken' => '

A token that you provide to identify the request to create your Amazon Q Business user mapping.

', 'CreateWebExperienceRequest$clientToken' => '

A token you provide to identify a request to create an Amazon Q Business web experience.

', 'UpdateChatControlsConfigurationRequest$clientToken' => '

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

', ], ], 'ConfigurationEvent' => [ 'base' => '

A configuration event activated by an end user request to select a specific chat mode.

', 'refs' => [ 'ChatInputStream$configurationEvent' => '

A configuration event activated by an end user request to select a specific chat mode.

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

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

', 'refs' => [], ], 'ContentBlockerRule' => [ 'base' => '

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

', 'refs' => [ 'RuleConfiguration$contentBlockerRule' => '

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

', ], ], 'ContentRetrievalRule' => [ 'base' => '

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

', 'refs' => [ 'RuleConfiguration$contentRetrievalRule' => NULL, ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'Document$contentType' => '

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

', ], ], 'Conversation' => [ 'base' => '

A conversation in an Amazon Q Business application.

', 'refs' => [ 'Conversations$member' => NULL, ], ], 'ConversationId' => [ 'base' => NULL, 'refs' => [ 'ActionReviewEvent$conversationId' => '

The identifier of the conversation with which the action review event is associated.

', 'ChatInput$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'ChatSyncInput$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'ChatSyncOutput$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'Conversation$conversationId' => '

The identifier of the Amazon Q Business conversation.

', 'DeleteConversationRequest$conversationId' => '

The identifier of the Amazon Q Business web experience conversation being deleted.

', 'FailedAttachmentEvent$conversationId' => '

The identifier of the conversation associated with the failed file upload.

', 'ListMessagesRequest$conversationId' => '

The identifier of the Amazon Q Business web experience conversation.

', 'MetadataEvent$conversationId' => '

The identifier of the conversation with which the generated metadata is associated.

', 'PutFeedbackRequest$conversationId' => '

The identifier of the conversation the feedback is attached to.

', 'TextOutputEvent$conversationId' => '

The identifier of the conversation with which the text output event is associated.

', ], ], 'ConversationTitle' => [ 'base' => NULL, 'refs' => [ 'Conversation$title' => '

The title of the conversation.

', ], ], 'Conversations' => [ 'base' => NULL, 'refs' => [ 'ListConversationsResponse$conversations' => '

An array of summary information on the configuration of one or more Amazon Q Business web experiences.

', ], ], 'CreateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequestUserAliasesList' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$userAliases' => '

The list of user aliases in the mapping.

', ], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatorModeConfiguration' => [ 'base' => '

Configuration information required to invoke chat in CREATOR_MODE.

For more information, see Admin controls and guardrails and Conversation settings.

', 'refs' => [ 'UpdateChatControlsConfigurationRequest$creatorModeConfiguration' => '

The configuration details for CREATOR_MODE.

', ], ], 'CreatorModeControl' => [ 'base' => NULL, 'refs' => [ 'AppliedCreatorModeConfiguration$creatorModeControl' => '

Information about whether creator mode is enabled or disabled for an Amazon Q Business application.

', 'CreatorModeConfiguration$creatorModeControl' => '

Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.

', ], ], 'CustomPluginConfiguration' => [ 'base' => '

Configuration information required to create a custom plugin.

', 'refs' => [ 'CreatePluginRequest$customPluginConfiguration' => '

Contains configuration for a custom plugin.

', 'GetPluginResponse$customPluginConfiguration' => '

Configuration information required to create a custom plugin.

', 'UpdatePluginRequest$customPluginConfiguration' => '

The configuration for a custom plugin.

', ], ], 'DataSource' => [ 'base' => '

A data source in an Amazon Q Business application.

', 'refs' => [ 'DataSources$member' => NULL, ], ], 'DataSourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceResponse$dataSourceArn' => '

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

', 'GetDataSourceResponse$dataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', ], ], 'DataSourceConfiguration' => [ 'base' => '

Provides the configuration information for an Amazon Q Business data source.

', 'refs' => [ 'CreateDataSourceRequest$configuration' => '

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

', 'GetDataSourceResponse$configuration' => '

The details of how the data source connector is configured.

', 'UpdateDataSourceRequest$configuration' => NULL, ], ], 'DataSourceId' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceResponse$dataSourceId' => '

The identifier of the data source connector.

', 'DataSource$dataSourceId' => '

The identifier of the Amazon Q Business data source.

', 'DataSourceIds$member' => NULL, 'DeleteDataSourceRequest$dataSourceId' => '

The identifier of the data source connector that you want to delete.

', 'DeleteGroupRequest$dataSourceId' => '

The identifier of the data source linked to the group

A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company\'s documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

', 'EligibleDataSource$dataSourceId' => '

The identifier of the data source.

', 'FailedDocument$dataSourceId' => '

The identifier of the Amazon Q Business data source connector that contains the failed document.

', 'GetDataSourceRequest$dataSourceId' => '

The identifier of the data source connector.

', 'GetDataSourceResponse$dataSourceId' => '

The identifier of the data source connector.

', 'GetGroupRequest$dataSourceId' => '

The identifier of the data source the group is attached to.

', 'ListDataSourceSyncJobsRequest$dataSourceId' => '

The identifier of the data source connector.

', 'ListGroupsRequest$dataSourceId' => '

The identifier of the data source for getting a list of groups mapped to users.

', 'PutGroupRequest$dataSourceId' => '

The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company\'s documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

', 'StartDataSourceSyncJobRequest$dataSourceId' => '

The identifier of the data source connector.

', 'StopDataSourceSyncJobRequest$dataSourceId' => '

The identifier of the data source connector.

', 'UpdateDataSourceRequest$dataSourceId' => '

The identifier of the data source connector.

', 'UserAlias$dataSourceId' => '

The identifier of the data source that the user aliases are associated with.

', ], ], 'DataSourceIds' => [ 'base' => NULL, 'refs' => [ 'ListDocumentsRequest$dataSourceIds' => '

The identifier of the data sources the documents are attached to.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceRequest$displayName' => '

A name for the data source connector.

', 'DataSource$displayName' => '

The name of the Amazon Q Business data source.

', 'GetDataSourceResponse$displayName' => '

The name for the data source connector.

', 'UpdateDataSourceRequest$displayName' => '

A name of the data source connector.

', ], ], 'DataSourceStatus' => [ 'base' => NULL, 'refs' => [ 'DataSource$status' => '

The status of the Amazon Q Business data source.

', 'GetDataSourceResponse$status' => '

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', ], ], 'DataSourceSyncJob' => [ 'base' => '

Provides information about an Amazon Q Business data source connector synchronization job.

', 'refs' => [ 'DataSourceSyncJobs$member' => NULL, ], ], 'DataSourceSyncJobMetrics' => [ 'base' => '

Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.

', 'refs' => [ 'DataSourceSyncJob$metrics' => '

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

', ], ], 'DataSourceSyncJobStatus' => [ 'base' => NULL, 'refs' => [ 'DataSourceSyncJob$status' => '

The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

', 'ListDataSourceSyncJobsRequest$statusFilter' => '

Only returns synchronization jobs with the Status field equal to the specified status.

', ], ], 'DataSourceSyncJobs' => [ 'base' => NULL, 'refs' => [ 'ListDataSourceSyncJobsResponse$history' => '

A history of synchronization jobs for the data source connector.

', ], ], 'DataSourceUserId' => [ 'base' => NULL, 'refs' => [ 'MemberUser$userId' => '

The identifier of the user you want to map to a group.

', ], ], 'DataSourceVpcConfiguration' => [ 'base' => '

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

', 'refs' => [ 'CreateDataSourceRequest$vpcConfiguration' => '

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.

', 'GetDataSourceResponse$vpcConfiguration' => '

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

', 'UpdateDataSourceRequest$vpcConfiguration' => NULL, ], ], 'DataSources' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$dataSources' => '

An array of summary information for one or more data source connector.

', ], ], 'DateAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting DATE type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$dateConfiguration' => '

Provides information on boosting DATE type document attributes.

', ], ], 'DeleteApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChatControlsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChatControlsConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConversationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConversationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDocument' => [ 'base' => '

A document deleted from an Amazon Q Business data source connector.

', 'refs' => [ 'DeleteDocuments$member' => NULL, ], ], 'DeleteDocuments' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentRequest$documents' => '

Documents deleted from the Amazon Q Business index.

', ], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$description' => '

A description for the Amazon Q Business application.

', 'CreateDataSourceRequest$description' => '

A description for the data source connector.

', 'CreateIndexRequest$description' => '

A description for the Amazon Q Business index.

', 'GetApplicationResponse$description' => '

A description for the Amazon Q Business application.

', 'GetDataSourceResponse$description' => '

The description for the data source connector.

', 'GetIndexResponse$description' => '

The description for the Amazon Q Business index.

', 'UpdateApplicationRequest$description' => '

A description for the Amazon Q Business application.

', 'UpdateDataSourceRequest$description' => '

The description of the data source connector.

', 'UpdateIndexRequest$description' => '

The description of the Amazon Q Business index.

', ], ], 'Document' => [ 'base' => '

A document in an Amazon Q Business application.

', 'refs' => [ 'Documents$member' => NULL, ], ], 'DocumentAttribute' => [ 'base' => '

A document attribute or metadata field.

', 'refs' => [ 'AttributeFilter$equalsTo' => '

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

', 'AttributeFilter$containsAll' => '

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

', 'AttributeFilter$containsAny' => '

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

', 'AttributeFilter$greaterThan' => '

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

', 'AttributeFilter$greaterThanOrEquals' => '

Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

', 'AttributeFilter$lessThan' => '

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

', 'AttributeFilter$lessThanOrEquals' => '

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

', 'DocumentAttributes$member' => NULL, ], ], 'DocumentAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven\'t enabled searching on these attributes, you can\'t boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingOverrideMap$value' => NULL, ], ], 'DocumentAttributeBoostingLevel' => [ 'base' => NULL, 'refs' => [ 'DateAttributeBoostingConfiguration$boostingLevel' => '

Specifies how much a document attribute is boosted.

', 'NumberAttributeBoostingConfiguration$boostingLevel' => '

Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

', 'StringAttributeBoostingConfiguration$boostingLevel' => '

Specifies how much a document attribute is boosted.

', 'StringListAttributeBoostingConfiguration$boostingLevel' => '

Specifies how much a document attribute is boosted.

', ], ], 'DocumentAttributeBoostingOverrideMap' => [ 'base' => NULL, 'refs' => [ 'NativeIndexConfiguration$boostingOverride' => '

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

', ], ], 'DocumentAttributeCondition' => [ 'base' => '

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the \'Department\' target field and have it prefill department names associated with the documents based on information in the \'Source_URI\' field. Set the condition that if the \'Source_URI\' field contains \'financial\' in its URI value, then prefill the target field \'Department\' with the target value \'Finance\' for the document.

Amazon Q Business can\'t create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

', 'refs' => [ 'HookConfiguration$invocationCondition' => '

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

', 'InlineDocumentEnrichmentConfiguration$condition' => NULL, ], ], 'DocumentAttributeConfiguration' => [ 'base' => '

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

', 'refs' => [ 'DocumentAttributeConfigurations$member' => NULL, ], ], 'DocumentAttributeConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetIndexResponse$documentAttributeConfigurations' => '

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

', 'UpdateIndexRequest$documentAttributeConfigurations' => '

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

', ], ], 'DocumentAttributeKey' => [ 'base' => NULL, 'refs' => [ 'DocumentAttribute$name' => '

The identifier for the attribute.

', 'DocumentAttributeBoostingOverrideMap$key' => NULL, 'DocumentAttributeCondition$key' => '

The identifier of the document attribute used for the condition.

For example, \'Source_URI\' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn\'t support _document_body as an attribute key used for the condition.

', 'DocumentAttributeTarget$key' => '

The identifier of the target document attribute or metadata field. For example, \'Department\' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

', ], ], 'DocumentAttributeStringListValue' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeValue$stringListValue' => '

A list of strings.

', ], ], 'DocumentAttributeTarget' => [ 'base' => '

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called \'Customer_ID\' by setting the target key as \'Customer_ID\' and the deletion flag to TRUE. This removes all customer ID values in the field \'Customer_ID\'. This would scrub personally identifiable information from each document\'s metadata.

Amazon Q Business can\'t create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

', 'refs' => [ 'InlineDocumentEnrichmentConfiguration$target' => NULL, ], ], 'DocumentAttributeValue' => [ 'base' => '

The value of a document attribute. You can only provide one value for a document attribute.

', 'refs' => [ 'DocumentAttribute$value' => '

The value of the attribute.

', 'DocumentAttributeCondition$value' => NULL, 'DocumentAttributeTarget$value' => NULL, ], ], 'DocumentAttributeValueStringValueString' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeValue$stringValue' => '

A string.

', ], ], 'DocumentAttributes' => [ 'base' => NULL, 'refs' => [ 'Document$attributes' => '

Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

', ], ], 'DocumentContent' => [ 'base' => '

The contents of a document.

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

The contents of the document.

', ], ], 'DocumentContentOperator' => [ 'base' => NULL, 'refs' => [ 'InlineDocumentEnrichmentConfiguration$documentContentOperator' => '

TRUE to delete content if the condition used for the target attribute is met.

', ], ], 'DocumentDetailList' => [ 'base' => NULL, 'refs' => [ 'ListDocumentsResponse$documentDetailList' => '

A list of document details.

', ], ], 'DocumentDetails' => [ 'base' => '

The details of a document within an Amazon Q Business index.

', 'refs' => [ 'DocumentDetailList$member' => NULL, ], ], 'DocumentEnrichmentConditionOperator' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeCondition$operator' => '

The identifier of the document attribute used for the condition.

For example, \'Source_URI\' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

', ], ], 'DocumentEnrichmentConfiguration' => [ 'base' => '

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

', 'refs' => [ 'CreateDataSourceRequest$documentEnrichmentConfiguration' => NULL, 'Document$documentEnrichmentConfiguration' => '

The configuration information for altering document metadata and content during the document ingestion process.

', 'GetDataSourceResponse$documentEnrichmentConfiguration' => NULL, 'UpdateDataSourceRequest$documentEnrichmentConfiguration' => NULL, ], ], 'DocumentId' => [ 'base' => NULL, 'refs' => [ 'DeleteDocument$documentId' => '

The identifier of the deleted document.

', 'Document$id' => '

The identifier of the document.

', 'DocumentDetails$documentId' => '

The identifier of the document.

', 'FailedDocument$id' => '

The identifier of the document that couldn\'t be removed from the Amazon Q Business index.

', ], ], 'DocumentMetadataConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeConfiguration$name' => '

The name of the document attribute.

', ], ], 'DocumentStatus' => [ 'base' => NULL, 'refs' => [ 'DocumentDetails$status' => '

The current status of the document.

', ], ], 'Documents' => [ 'base' => NULL, 'refs' => [ 'BatchPutDocumentRequest$documents' => '

One or more documents to add to the index.

', ], ], 'EligibleDataSource' => [ 'base' => '

The identifier of the data source Amazon Q Business will generate responses from.

', 'refs' => [ 'EligibleDataSources$member' => NULL, ], ], 'EligibleDataSources' => [ 'base' => NULL, 'refs' => [ 'ContentRetrievalRule$eligibleDataSources' => '

Specifies data sources in a Amazon Q Business application to use for content generation.

', ], ], 'EncryptionConfiguration' => [ 'base' => '

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn\'t support asymmetric keys.

', 'refs' => [ 'CreateApplicationRequest$encryptionConfiguration' => '

The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn\'t support asymmetric keys.

', 'GetApplicationResponse$encryptionConfiguration' => '

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn\'t support asymmetric keys.

', ], ], 'EndOfInputEvent' => [ 'base' => '

The end of the streaming input for the Chat API.

', 'refs' => [ 'ChatInputStream$endOfInputEvent' => '

The end of the streaming input for the Chat API.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'ErrorDetail$errorCode' => '

The code associated with the data source sync error.

', ], ], 'ErrorDetail' => [ 'base' => '

Provides information about a data source sync error.

', 'refs' => [ 'AttachmentOutput$error' => '

An error associated with a file uploaded during chat.

', 'DataSourceSyncJob$error' => '

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

', 'DocumentDetails$error' => '

An error message associated with the document.

', 'FailedDocument$error' => '

An explanation for why the document couldn\'t be removed from the index.

', 'GetApplicationResponse$error' => '

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

', 'GetDataSourceResponse$error' => '

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', 'GetIndexResponse$error' => '

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

', 'GetWebExperienceResponse$error' => '

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', 'GroupStatusDetail$errorDetail' => '

The details of an error associated a group status.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => '

The message describing a ConflictException.

', 'ErrorDetail$errorMessage' => '

The message explaining the data source sync error.

', 'InternalServerException$message' => NULL, 'LicenseNotFoundException$message' => NULL, 'ResourceNotFoundException$message' => '

The message describing a ResourceNotFoundException.

', 'ServiceQuotaExceededException$message' => '

The message describing a ServiceQuotaExceededException.

', 'ThrottlingException$message' => NULL, 'ValidationException$message' => '

The message describing the ValidationException.

', ], ], 'ExampleChatMessage' => [ 'base' => NULL, 'refs' => [ 'ExampleChatMessages$member' => NULL, ], ], 'ExampleChatMessages' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$exampleChatMessages' => '

A list of example phrases that you expect the end user to use in relation to the topic.

', ], ], 'ExecutionId' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentRequest$dataSourceSyncId' => '

The identifier of the data source sync during which the documents were deleted.

', 'BatchPutDocumentRequest$dataSourceSyncId' => '

The identifier of the data source sync during which the documents were added.

', 'DataSourceSyncJob$executionId' => '

The identifier of a data source synchronization job.

', 'StartDataSourceSyncJobResponse$executionId' => '

The identifier for a particular synchronization job.

', ], ], 'FailedAttachmentEvent' => [ 'base' => '

A failed file upload during web experience chat.

', 'refs' => [ 'ChatOutputStream$failedAttachmentEvent' => '

A failed file upload event during a web experience chat.

', ], ], 'FailedDocument' => [ 'base' => '

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn\'t be removed from the index.

', 'refs' => [ 'FailedDocuments$member' => NULL, ], ], 'FailedDocuments' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentResponse$failedDocuments' => '

A list of documents that couldn\'t be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn\'t be removed from the index.

', 'BatchPutDocumentResponse$failedDocuments' => '

A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn\'t be added to the index.

', ], ], 'GetApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetChatControlsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetChatControlsConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GroupMembers' => [ 'base' => '

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

', 'refs' => [ 'PutGroupRequest$groupMembers' => NULL, ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'DeleteGroupRequest$groupName' => '

The name of the group you want to delete.

', 'GetGroupRequest$groupName' => '

The name of the group.

', 'GroupSummary$groupName' => '

The name of the group the summary information is for.

', 'MemberGroup$groupName' => '

The name of the sub group.

', 'PrincipalGroup$name' => '

The name of the group.

', 'PutGroupRequest$groupName' => '

The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

', ], ], 'GroupStatus' => [ 'base' => NULL, 'refs' => [ 'GroupStatusDetail$status' => '

The status of a group.

', ], ], 'GroupStatusDetail' => [ 'base' => '

Provides the details of a group\'s status.

', 'refs' => [ 'GetGroupResponse$status' => '

The current status of the group.

', 'GroupStatusDetails$member' => NULL, ], ], 'GroupStatusDetails' => [ 'base' => NULL, 'refs' => [ 'GetGroupResponse$statusHistory' => '

The status history of the group.

', ], ], 'GroupSummary' => [ 'base' => '

Summary information for groups.

', 'refs' => [ 'GroupSummaryList$member' => NULL, ], ], 'GroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$items' => '

Summary information for list of groups that are mapped to users.

', ], ], 'HookConfiguration' => [ 'base' => '

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

', 'refs' => [ 'DocumentEnrichmentConfiguration$preExtractionHookConfiguration' => NULL, 'DocumentEnrichmentConfiguration$postExtractionHookConfiguration' => NULL, ], ], 'IdcApplicationArn' => [ 'base' => NULL, 'refs' => [ 'GetApplicationResponse$identityCenterApplicationArn' => '

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

', ], ], 'Index' => [ 'base' => '

Summary information for your Amazon Q Business index.

', 'refs' => [ 'Indices$member' => NULL, ], ], 'IndexArn' => [ 'base' => NULL, 'refs' => [ 'CreateIndexResponse$indexArn' => '

The Amazon Resource Name (ARN) of an Amazon Q Business index.

', 'GetIndexResponse$indexArn' => '

The Amazon Resource Name (ARN) of the Amazon Q Business index.

', ], ], 'IndexCapacityConfiguration' => [ 'base' => '

Provides information about index capacity configuration.

', 'refs' => [ 'CreateIndexRequest$capacityConfiguration' => '

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

', 'GetIndexResponse$capacityConfiguration' => '

The storage capacity units chosen for your Amazon Q Business index.

', 'UpdateIndexRequest$capacityConfiguration' => '

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

', ], ], 'IndexCapacityInteger' => [ 'base' => NULL, 'refs' => [ 'IndexCapacityConfiguration$units' => '

The number of storage units configured for an Amazon Q Business index.

', ], ], 'IndexId' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteDocumentRequest$indexId' => '

The identifier of the Amazon Q Business index that contains the documents to delete.

', 'BatchPutDocumentRequest$indexId' => '

The identifier of the Amazon Q Business index to add the documents to.

', 'CreateDataSourceRequest$indexId' => '

The identifier of the index that you want to use with the data source connector.

', 'CreateIndexResponse$indexId' => '

The identifier for the Amazon Q Business index.

', 'DeleteDataSourceRequest$indexId' => '

The identifier of the index used with the data source connector.

', 'DeleteGroupRequest$indexId' => '

The identifier of the index you want to delete the group from.

', 'DeleteIndexRequest$indexId' => '

The identifier of the Amazon Q Business index.

', 'EligibleDataSource$indexId' => '

The identifier of the index the data source is attached to.

', 'GetDataSourceRequest$indexId' => '

The identfier of the index used with the data source connector.

', 'GetDataSourceResponse$indexId' => '

The identifier of the index linked to the data source connector.

', 'GetGroupRequest$indexId' => '

The identifier of the index the group is attached to.

', 'GetIndexRequest$indexId' => '

The identifier of the Amazon Q Business index you want information on.

', 'GetIndexResponse$indexId' => '

The identifier of the Amazon Q Business index.

', 'Index$indexId' => '

The identifier for the index.

', 'ListDataSourceSyncJobsRequest$indexId' => '

The identifier of the index used with the Amazon Q Business data source connector.

', 'ListDataSourcesRequest$indexId' => '

The identifier of the index used with one or more data source connectors.

', 'ListDocumentsRequest$indexId' => '

The identifier of the index the documents are attached to.

', 'ListGroupsRequest$indexId' => '

The identifier of the index for getting a list of groups mapped to users.

', 'NativeIndexConfiguration$indexId' => '

The identifier for the Amazon Q Business index.

', 'PutGroupRequest$indexId' => '

The identifier of the index in which you want to map users to their groups.

', 'StartDataSourceSyncJobRequest$indexId' => '

The identifier of the index used with the data source connector.

', 'StopDataSourceSyncJobRequest$indexId' => '

The identifier of the index used with the Amazon Q Business data source connector.

', 'UpdateDataSourceRequest$indexId' => '

The identifier of the index attached to the data source connector.

', 'UpdateIndexRequest$indexId' => '

The identifier of the Amazon Q Business index.

', 'UserAlias$indexId' => '

The identifier of the index that the user aliases are associated with.

', ], ], 'IndexName' => [ 'base' => NULL, 'refs' => [ 'CreateIndexRequest$displayName' => '

A name for the Amazon Q Business index.

', 'GetIndexResponse$displayName' => '

The name of the Amazon Q Business index.

', 'Index$displayName' => '

The name of the index.

', ], ], 'IndexStatistics' => [ 'base' => '

Provides information about the number of documents in an index.

', 'refs' => [ 'GetIndexResponse$indexStatistics' => '

Provides information about the number of documents indexed.

', ], ], 'IndexStatus' => [ 'base' => NULL, 'refs' => [ 'GetIndexResponse$status' => '

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

', 'Index$status' => '

The current status of the index. When the status is ACTIVE, the index is ready.

', ], ], 'IndexType' => [ 'base' => NULL, 'refs' => [ 'CreateIndexRequest$type' => '

The index type that\'s suitable for your needs. For more information on what\'s included in each type of index or index tier, see Amazon Q Business tiers.

', 'GetIndexResponse$type' => '

The type of index attached to your Amazon Q Business application.

', ], ], 'IndexedTextBytes' => [ 'base' => NULL, 'refs' => [ 'TextDocumentStatistics$indexedTextBytes' => '

The total size, in bytes, of the indexed documents.

', ], ], 'IndexedTextDocument' => [ 'base' => NULL, 'refs' => [ 'TextDocumentStatistics$indexedTextDocumentCount' => '

The number of text documents indexed.

', ], ], 'Indices' => [ 'base' => NULL, 'refs' => [ 'ListIndicesResponse$indices' => '

An array of information on the items in one or more indexes.

', ], ], 'InlineDocumentEnrichmentConfiguration' => [ 'base' => '

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Custom document enrichment.

', 'refs' => [ 'InlineDocumentEnrichmentConfigurations$member' => NULL, ], ], 'InlineDocumentEnrichmentConfigurations' => [ 'base' => NULL, 'refs' => [ 'DocumentEnrichmentConfiguration$inlineConfigurations' => '

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

', ], ], 'InstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$identityCenterInstanceArn' => '

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

', 'UpdateApplicationRequest$identityCenterInstanceArn' => '

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$displayOrder' => '

The display order of fields in a payload.

', 'SourceAttribution$citationNumber' => '

The number attached to a citation in an Amazon Q Business generated response.

', 'TextSegment$beginOffset' => '

The zero-based location in the response string where the source attribution starts.

', 'TextSegment$endOffset' => '

The zero-based location in the response string where the source attribution ends.

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

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

', 'refs' => [], ], 'KendraIndexConfiguration' => [ 'base' => '

Stores an Amazon Kendra index as a retriever.

', 'refs' => [ 'RetrieverConfiguration$kendraIndexConfiguration' => '

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

', ], ], 'KendraIndexId' => [ 'base' => NULL, 'refs' => [ 'KendraIndexConfiguration$indexId' => '

The identifier of the Amazon Kendra index.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsKeyId' => '

The identifier of the KMS key. Amazon Q Business doesn\'t support asymmetric keys.

', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'HookConfiguration$lambdaArn' => '

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

', ], ], 'LicenseNotFoundException' => [ 'base' => '

You don\'t have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

', 'refs' => [], ], 'ListApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConversationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConversationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourceSyncJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourceSyncJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDocumentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDocumentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIndicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIndicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMessagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMessagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPluginsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPluginsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRetrieversRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRetrieversResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWebExperiencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWebExperiencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeValue$longValue' => '

A long integer value.

', ], ], 'MaxResultsIntegerForGetTopicConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetChatControlsConfigurationRequest$maxResults' => '

The maximum number of configured chat controls to return.

', ], ], 'MaxResultsIntegerForListApplications' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsRequest$maxResults' => '

The maximum number of Amazon Q Business applications to return.

', ], ], 'MaxResultsIntegerForListConversations' => [ 'base' => NULL, 'refs' => [ 'ListConversationsRequest$maxResults' => '

The maximum number of Amazon Q Business conversations to return.

', ], ], 'MaxResultsIntegerForListDataSources' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesRequest$maxResults' => '

The maximum number of data source connectors to return.

', ], ], 'MaxResultsIntegerForListDataSourcesSyncJobs' => [ 'base' => NULL, 'refs' => [ 'ListDataSourceSyncJobsRequest$maxResults' => '

The maximum number of synchronization jobs to return in the response.

', ], ], 'MaxResultsIntegerForListDocuments' => [ 'base' => NULL, 'refs' => [ 'ListDocumentsRequest$maxResults' => '

The maximum number of documents to return.

', ], ], 'MaxResultsIntegerForListGroupsRequest' => [ 'base' => NULL, 'refs' => [ 'ListGroupsRequest$maxResults' => '

The maximum number of returned groups that are mapped to users.

', ], ], 'MaxResultsIntegerForListIndices' => [ 'base' => NULL, 'refs' => [ 'ListIndicesRequest$maxResults' => '

The maximum number of indices to return.

', ], ], 'MaxResultsIntegerForListMessages' => [ 'base' => NULL, 'refs' => [ 'ListMessagesRequest$maxResults' => '

The maximum number of messages to return.

', ], ], 'MaxResultsIntegerForListPlugins' => [ 'base' => NULL, 'refs' => [ 'ListPluginsRequest$maxResults' => '

The maximum number of documents to return.

', ], ], 'MaxResultsIntegerForListRetrieversRequest' => [ 'base' => NULL, 'refs' => [ 'ListRetrieversRequest$maxResults' => '

The maximum number of retrievers returned.

', ], ], 'MaxResultsIntegerForListWebExperiencesRequest' => [ 'base' => NULL, 'refs' => [ 'ListWebExperiencesRequest$maxResults' => '

The maximum number of Amazon Q Business Web Experiences to return.

', ], ], 'MemberGroup' => [ 'base' => '

The sub groups that belong to a group.

', 'refs' => [ 'MemberGroups$member' => NULL, ], ], 'MemberGroups' => [ 'base' => NULL, 'refs' => [ 'GroupMembers$memberGroups' => '

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

', ], ], 'MemberRelation' => [ 'base' => NULL, 'refs' => [ 'AccessConfiguration$memberRelation' => '

Describes the member relation within the AccessControlList object.

', 'AccessControl$memberRelation' => '

Describes the member relation within a principal list.

', ], ], 'MemberUser' => [ 'base' => '

The users that belong to a group.

', 'refs' => [ 'MemberUsers$member' => NULL, ], ], 'MemberUsers' => [ 'base' => NULL, 'refs' => [ 'GroupMembers$memberUsers' => '

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

', ], ], 'MembershipType' => [ 'base' => NULL, 'refs' => [ 'MemberGroup$type' => '

The type of the sub group.

', 'MemberUser$type' => '

The type of the user.

', 'PrincipalGroup$membershipType' => '

The type of group.

', 'PrincipalUser$membershipType' => '

The type of group.

', 'PutGroupRequest$type' => '

The type of the group.

', ], ], 'Message' => [ 'base' => '

A message in an Amazon Q Business web experience.

', 'refs' => [ 'Messages$member' => NULL, ], ], 'MessageBody' => [ 'base' => NULL, 'refs' => [ 'Message$body' => '

The content of the Amazon Q Business web experience message.

', ], ], 'MessageId' => [ 'base' => NULL, 'refs' => [ 'ActionReviewEvent$userMessageId' => '

The identifier of the conversation with which the plugin action is associated.

', 'ActionReviewEvent$systemMessageId' => '

The identifier of an Amazon Q Business AI generated associated with the action review event.

', 'ChatInput$parentMessageId' => '

The identifier used to associate a user message with a AI generated response.

', 'ChatSyncInput$parentMessageId' => '

The identifier of the previous end user text input message in a conversation.

', 'ChatSyncOutput$systemMessageId' => '

The identifier of an Amazon Q Business AI generated message within the conversation.

', 'ChatSyncOutput$userMessageId' => '

The identifier of an Amazon Q Business end user text input message within the conversation.

', 'FailedAttachmentEvent$userMessageId' => '

The identifier of the end user chat message associated with the file upload.

', 'FailedAttachmentEvent$systemMessageId' => '

The identifier of the AI-generated message associated with the file upload.

', 'MetadataEvent$userMessageId' => '

The identifier of an Amazon Q Business end user text input message within the conversation.

', 'MetadataEvent$systemMessageId' => '

The identifier of an Amazon Q Business AI generated message within the conversation.

', 'TextOutputEvent$userMessageId' => '

The identifier of an end user message in a TextOutputEvent.

', 'TextOutputEvent$systemMessageId' => '

The identifier of an AI-generated message in a TextOutputEvent.

', ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'Message$type' => '

The type of Amazon Q Business message, whether HUMAN or AI generated.

', ], ], 'MessageUsefulness' => [ 'base' => NULL, 'refs' => [ 'MessageUsefulnessFeedback$usefulness' => '

The usefulness value assigned by an end user to a message.

', ], ], 'MessageUsefulnessComment' => [ 'base' => NULL, 'refs' => [ 'MessageUsefulnessFeedback$comment' => '

A comment given by an end user on the usefulness of an AI-generated chat message.

', ], ], 'MessageUsefulnessFeedback' => [ 'base' => '

End user feedback on an AI-generated web experience chat message usefulness.

', 'refs' => [ 'PutFeedbackRequest$messageUsefulness' => '

The feedback usefulness value given by the user to the chat message.

', ], ], 'MessageUsefulnessReason' => [ 'base' => NULL, 'refs' => [ 'MessageUsefulnessFeedback$reason' => '

The reason for a usefulness rating.

', ], ], 'Messages' => [ 'base' => NULL, 'refs' => [ 'ListMessagesResponse$messages' => '

An array of information on one or more messages.

', ], ], 'MetadataEvent' => [ 'base' => '

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

', 'refs' => [ 'ChatOutputStream$metadataEvent' => '

A metadata event for a AI-generated text output message in a Amazon Q Business conversation.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'DataSourceSyncJobMetrics$documentsAdded' => '

The current count of documents added from the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsModified' => '

The current count of documents modified in the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsDeleted' => '

The current count of documents deleted from the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsFailed' => '

The current count of documents that failed to sync from the data source during the data source sync.

', 'DataSourceSyncJobMetrics$documentsScanned' => '

The current count of documents crawled by the ongoing sync job in the data source.

', ], ], 'NativeIndexConfiguration' => [ 'base' => '

Configuration information for an Amazon Q Business index.

', 'refs' => [ 'RetrieverConfiguration$nativeIndexConfiguration' => '

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

', 'GetChatControlsConfigurationResponse$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

', 'ListApplicationsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

', 'ListApplicationsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.

', 'ListConversationsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

', 'ListConversationsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

', 'ListDataSourceSyncJobsRequest$nextToken' => '

If the maxResults response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.

', 'ListDataSourceSyncJobsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.

', 'ListDataSourcesRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.

', 'ListDataSourcesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.

', 'ListDocumentsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

', 'ListDocumentsResponse$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

', 'ListGroupsRequest$nextToken' => '

If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

', 'ListGroupsResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.

', 'ListIndicesRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.

', 'ListIndicesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.

', 'ListMessagesRequest$nextToken' => '

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

', 'ListMessagesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

', 'ListPluginsRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

', 'ListPluginsResponse$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

', 'ListRetrieversRequest$nextToken' => '

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

', 'ListRetrieversResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.

', 'ListWebExperiencesRequest$nextToken' => '

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

', 'ListWebExperiencesResponse$nextToken' => '

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

', ], ], 'NoAuthConfiguration' => [ 'base' => '

Information about invoking a custom plugin without any authentication or authorization requirement.

', 'refs' => [ 'PluginAuthConfiguration$noAuthConfiguration' => '

Information about invoking a custom plugin without any authentication.

', ], ], 'NumberAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting NUMBER type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$numberConfiguration' => '

Provides information on boosting NUMBER type document attributes.

', ], ], 'NumberAttributeBoostingType' => [ 'base' => NULL, 'refs' => [ 'NumberAttributeBoostingConfiguration$boostingType' => '

Specifies how much a document attribute is boosted.

', ], ], 'OAuth2ClientCredentialConfiguration' => [ 'base' => '

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

', 'refs' => [ 'PluginAuthConfiguration$oAuth2ClientCredentialConfiguration' => '

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

', ], ], 'Payload' => [ 'base' => NULL, 'refs' => [ 'APISchema$payload' => '

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

', ], ], 'Plugin' => [ 'base' => '

Information about an Amazon Q Business plugin and its configuration.

', 'refs' => [ 'Plugins$member' => NULL, ], ], 'PluginArn' => [ 'base' => NULL, 'refs' => [ 'CreatePluginResponse$pluginArn' => '

The Amazon Resource Name (ARN) of a plugin.

', 'GetPluginResponse$pluginArn' => '

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

', ], ], 'PluginAuthConfiguration' => [ 'base' => '

Authentication configuration information for an Amazon Q Business plugin.

', 'refs' => [ 'CreatePluginRequest$authConfiguration' => NULL, 'GetPluginResponse$authConfiguration' => NULL, 'UpdatePluginRequest$authConfiguration' => '

The authentication configuration the plugin is using.

', ], ], 'PluginBuildStatus' => [ 'base' => NULL, 'refs' => [ 'CreatePluginResponse$buildStatus' => '

The current status of a plugin. A plugin is modified asynchronously.

', 'GetPluginResponse$buildStatus' => '

The current status of a plugin. A plugin is modified asynchronously.

', 'Plugin$buildStatus' => '

The status of the plugin.

', ], ], 'PluginConfiguration' => [ 'base' => '

Configuration information required to invoke chat in PLUGIN_MODE.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

', 'refs' => [ 'ChatModeConfiguration$pluginConfiguration' => '

Configuration information required to invoke chat in PLUGIN_MODE.

', ], ], 'PluginDescription' => [ 'base' => NULL, 'refs' => [ 'CustomPluginConfiguration$description' => '

A description for your custom plugin configuration.

', ], ], 'PluginId' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$pluginId' => '

The identifier of the plugin the action is attached to.

', 'ActionExecutionEvent$pluginId' => '

The identifier of the plugin for which the action is being requested.

', 'ActionReview$pluginId' => '

The identifier of the plugin associated with the action review.

', 'ActionReviewEvent$pluginId' => '

The identifier of the plugin associated with the action review event.

', 'CreatePluginResponse$pluginId' => '

The identifier of the plugin created.

', 'DeletePluginRequest$pluginId' => '

The identifier of the plugin being deleted.

', 'GetPluginRequest$pluginId' => '

The identifier of the plugin.

', 'GetPluginResponse$pluginId' => '

The identifier of the plugin.

', 'Plugin$pluginId' => '

The identifier of the plugin.

', 'PluginConfiguration$pluginId' => '

The identifier of the plugin you want to use.

', 'UpdatePluginRequest$pluginId' => '

The identifier of the plugin.

', ], ], 'PluginName' => [ 'base' => NULL, 'refs' => [ 'CreatePluginRequest$displayName' => '

A the name for your plugin.

', 'GetPluginResponse$displayName' => '

The name of the plugin.

', 'Plugin$displayName' => '

The name of the plugin.

', 'UpdatePluginRequest$displayName' => '

The name of the plugin.

', ], ], 'PluginState' => [ 'base' => NULL, 'refs' => [ 'GetPluginResponse$state' => '

The current state of the plugin.

', 'Plugin$state' => '

The current status of the plugin.

', 'UpdatePluginRequest$state' => '

The status of the plugin.

', ], ], 'PluginType' => [ 'base' => NULL, 'refs' => [ 'ActionReview$pluginType' => '

The type of plugin.

', 'ActionReviewEvent$pluginType' => '

The type of plugin.

', 'CreatePluginRequest$type' => '

The type of plugin you want to create.

', 'GetPluginResponse$type' => '

The type of the plugin.

', 'Plugin$type' => '

The type of the plugin.

', ], ], 'Plugins' => [ 'base' => NULL, 'refs' => [ 'ListPluginsResponse$plugins' => '

Information about a configured plugin.

', ], ], 'Principal' => [ 'base' => '

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

', 'refs' => [ 'Principals$member' => NULL, ], ], 'PrincipalGroup' => [ 'base' => '

Provides information about a group associated with the principal.

', 'refs' => [ 'Principal$group' => '

The group associated with the principal.

', ], ], 'PrincipalUser' => [ 'base' => '

Provides information about a user associated with a principal.

', 'refs' => [ 'Principal$user' => '

The user associated with the principal.

', ], ], 'Principals' => [ 'base' => NULL, 'refs' => [ 'AccessControl$principals' => '

Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

', ], ], 'PutFeedbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReadAccessType' => [ 'base' => NULL, 'refs' => [ 'PrincipalGroup$access' => '

Provides information about whether to allow or deny access to the principal.

', 'PrincipalUser$access' => '

Provides information about whether to allow or deny access to the principal.

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

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

', 'refs' => [], ], 'ResponseScope' => [ 'base' => NULL, 'refs' => [ 'GetChatControlsConfigurationResponse$responseScope' => '

The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

', 'UpdateChatControlsConfigurationRequest$responseScope' => '

The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

', ], ], 'Retriever' => [ 'base' => '

Summary information for the retriever used for your Amazon Q Business application.

', 'refs' => [ 'Retrievers$member' => NULL, ], ], 'RetrieverArn' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverResponse$retrieverArn' => '

The Amazon Resource Name (ARN) of an IAM role associated with a retriever.

', 'GetRetrieverResponse$retrieverArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

', ], ], 'RetrieverConfiguration' => [ 'base' => '

Provides information on how the retriever used for your Amazon Q Business application is configured.

', 'refs' => [ 'CreateRetrieverRequest$configuration' => NULL, 'GetRetrieverResponse$configuration' => NULL, 'UpdateRetrieverRequest$configuration' => NULL, ], ], 'RetrieverId' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverResponse$retrieverId' => '

The identifier of the retriever you are using.

', 'DeleteRetrieverRequest$retrieverId' => '

The identifier of the retriever being deleted.

', 'GetRetrieverRequest$retrieverId' => '

The identifier of the retriever.

', 'GetRetrieverResponse$retrieverId' => '

The identifier of the retriever.

', 'Retriever$retrieverId' => '

The identifier of the retriever used by your Amazon Q Business application.

', 'UpdateRetrieverRequest$retrieverId' => '

The identifier of your retriever.

', ], ], 'RetrieverName' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverRequest$displayName' => '

The name of your retriever.

', 'GetRetrieverResponse$displayName' => '

The name of the retriever.

', 'Retriever$displayName' => '

The name of your retriever.

', 'UpdateRetrieverRequest$displayName' => '

The name of your retriever.

', ], ], 'RetrieverStatus' => [ 'base' => NULL, 'refs' => [ 'GetRetrieverResponse$status' => '

The status of the retriever.

', 'Retriever$status' => '

The status of your retriever.

', ], ], 'RetrieverType' => [ 'base' => NULL, 'refs' => [ 'CreateRetrieverRequest$type' => '

The type of retriever you are using.

', 'GetRetrieverResponse$type' => '

The type of the retriever.

', 'Retriever$type' => '

The type of your retriever.

', ], ], 'Retrievers' => [ 'base' => NULL, 'refs' => [ 'ListRetrieversResponse$retrievers' => '

An array of summary information for one or more retrievers.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'BasicAuthConfiguration$roleArn' => '

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

', 'BatchPutDocumentRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

', 'CreateApplicationRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

', 'CreateDataSourceRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

', 'CreateRetrieverRequest$roleArn' => '

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

', 'CreateWebExperienceRequest$roleArn' => '

The Amazon Resource Name (ARN) of the service role attached to your web experience.

', 'GetApplicationResponse$roleArn' => '

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

', 'GetDataSourceResponse$roleArn' => '

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

', 'GetRetrieverResponse$roleArn' => '

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

', 'GetWebExperienceResponse$roleArn' => '

The Amazon Resource Name (ARN) of the service role attached to your web experience.

', 'HookConfiguration$roleArn' => '

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

', 'OAuth2ClientCredentialConfiguration$roleArn' => '

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

', 'SamlConfiguration$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

', 'UpdateApplicationRequest$roleArn' => '

An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.

', 'UpdateDataSourceRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

', 'UpdateRetrieverRequest$roleArn' => '

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

', 'UpdateWebExperienceRequest$roleArn' => '

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

', ], ], 'Rule' => [ 'base' => '

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

', 'refs' => [ 'Rules$member' => NULL, ], ], 'RuleConfiguration' => [ 'base' => '

Provides configuration information about a rule.

', 'refs' => [ 'Rule$ruleConfiguration' => '

The configuration information for a rule.

', ], ], 'RuleType' => [ 'base' => NULL, 'refs' => [ 'Rule$ruleType' => '

The type of rule.

', ], ], 'Rules' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$rules' => '

Rules defined for a topic configuration.

', ], ], 'S3' => [ 'base' => '

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

', 'refs' => [ 'APISchema$s3' => '

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

', 'DocumentContent$s3' => '

The path to the document in an Amazon S3 bucket.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'HookConfiguration$s3BucketName' => '

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

', 'S3$bucket' => '

The name of the S3 bucket that contains the file.

', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'S3$key' => '

The name of the file.

', ], ], 'SamlAttribute' => [ 'base' => NULL, 'refs' => [ 'SamlConfiguration$userIdAttribute' => '

The user attribute name in your IdP that maps to the user email.

', 'SamlConfiguration$userGroupAttribute' => '

The group attribute name in your IdP that maps to user groups.

', ], ], 'SamlConfiguration' => [ 'base' => '

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

', 'refs' => [ 'WebExperienceAuthConfiguration$samlConfiguration' => NULL, ], ], 'SamlMetadataXML' => [ 'base' => NULL, 'refs' => [ 'SamlConfiguration$metadataXML' => '

The metadata XML that your IdP generated.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'BasicAuthConfiguration$secretArn' => '

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

', 'OAuth2ClientCredentialConfiguration$secretArn' => '

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DataSourceVpcConfiguration$securityGroupIds' => '

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.

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

You have exceeded the set limits for your Amazon Q Business service.

', 'refs' => [], ], 'SnippetExcerpt' => [ 'base' => '

Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

', 'refs' => [ 'TextSegment$snippetExcerpt' => '

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

', ], ], 'SnippetExcerptText' => [ 'base' => NULL, 'refs' => [ 'SnippetExcerpt$text' => '

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.

', ], ], 'SourceAttribution' => [ 'base' => '

The documents used to generate an Amazon Q Business web experience response.

', 'refs' => [ 'SourceAttributions$member' => NULL, ], ], 'SourceAttributions' => [ 'base' => NULL, 'refs' => [ 'ChatSyncOutput$sourceAttributions' => '

The source documents used to generate the conversation response.

', 'Message$sourceAttribution' => '

The source documents used to generate Amazon Q Business web experience message.

', 'MetadataEvent$sourceAttributions' => '

The source documents used to generate the conversation response.

', ], ], 'StartDataSourceSyncJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataSourceSyncJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'DocumentAttributeConfiguration$search' => '

Information about whether the document attribute can be used by an end user to search for information on their web experience.

', ], ], 'StopDataSourceSyncJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopDataSourceSyncJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ActionReviewPayloadField$displayName' => '

The name of the field.

', 'ActionReviewPayloadField$displayDescription' => '

The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.

', 'ActionReviewPayloadField$allowedFormat' => '

The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.

', 'ChatSyncOutput$systemMessage' => '

An AI-generated message in a conversation.

', 'ConflictException$resourceId' => '

The identifier of the resource affected.

', 'ConflictException$resourceType' => '

The type of the resource affected.

', 'CreateUserRequest$userId' => '

The user emails attached to a user mapping.

', 'DataSource$type' => '

The type of the Amazon Q Business data source.

', 'DataSourceSyncJob$dataSourceErrorCode' => '

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

', 'DeleteUserRequest$userId' => '

The user email being deleted.

', 'DocumentAttributeStringListValue$member' => NULL, 'GetDataSourceResponse$type' => '

The type of the data source connector. For example, S3.

', 'GetUserRequest$userId' => '

The user email address attached to the user.

', 'Message$messageId' => '

The identifier of the Amazon Q Business web experience message.

', 'MetadataEvent$finalTextMessage' => '

The final text output message generated by the system.

', 'ResourceNotFoundException$resourceId' => '

The identifier of the resource affected.

', 'ResourceNotFoundException$resourceType' => '

The type of the resource affected.

', 'ServiceQuotaExceededException$resourceId' => '

The identifier of the resource affected.

', 'ServiceQuotaExceededException$resourceType' => '

The type of the resource affected.

', 'SourceAttribution$title' => '

The title of the document which is the source for the Amazon Q Business generated response.

', 'SourceAttribution$snippet' => '

The content extract from the document on which the generated response is based.

', 'SourceAttribution$url' => '

The URL of the document which is the source for the Amazon Q Business generated response.

', 'StringAttributeValueBoosting$key' => NULL, 'TextOutputEvent$systemMessage' => '

An AI-generated message in a TextOutputEvent.

', 'UpdateUserRequest$userId' => '

The email id attached to the user.

', 'UserAlias$userId' => '

The identifier of the user id associated with the user aliases.

', 'UserGroups$member' => NULL, 'UserIds$member' => NULL, 'ValidationExceptionField$name' => '

The field name where the invalid entry was detected.

', 'ValidationExceptionField$message' => '

A message about the validation exception.

', ], ], 'StringAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting STRING type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven\'t enabled searching on these attributes, you can\'t boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$stringConfiguration' => '

Provides information on boosting STRING type document attributes.

', ], ], 'StringAttributeValueBoosting' => [ 'base' => NULL, 'refs' => [ 'StringAttributeBoostingConfiguration$attributeValueBoosting' => '

Specifies specific values of a STRING type document attribute being boosted.

', ], ], 'StringAttributeValueBoostingLevel' => [ 'base' => NULL, 'refs' => [ 'StringAttributeValueBoosting$value' => NULL, ], ], 'StringListAttributeBoostingConfiguration' => [ 'base' => '

Provides information on boosting STRING_LIST type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven\'t enabled searching on these attributes, you can\'t boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

', 'refs' => [ 'DocumentAttributeBoostingConfiguration$stringListConfiguration' => '

Provides information on boosting STRING_LIST type document attributes.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'DataSourceVpcConfiguration$subnetIds' => '

A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

', ], ], 'SyncSchedule' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceRequest$syncSchedule' => '

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don\'t set a schedule, Amazon Q Business won\'t periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can\'t specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

', 'GetDataSourceResponse$syncSchedule' => '

The schedule for Amazon Q Business to update the index.

', 'UpdateDataSourceRequest$syncSchedule' => '

The chosen update frequency for your data source.

', ], ], 'SystemMessageId' => [ 'base' => NULL, 'refs' => [ 'PutFeedbackRequest$messageId' => '

The identifier of the chat message that the feedback was given for.

', ], ], 'SystemMessageOverride' => [ 'base' => NULL, 'refs' => [ 'BlockedPhrasesConfiguration$systemMessageOverride' => '

The configured custom message displayed to an end user informing them that they\'ve used a blocked phrase during chat.

', 'BlockedPhrasesConfigurationUpdate$systemMessageOverride' => '

The configured custom message displayed to your end user when they use blocked phrase during chat.

', 'ContentBlockerRule$systemMessageOverride' => '

The configured custom message displayed to an end user informing them that they\'ve used a blocked phrase during chat.

', ], ], 'Tag' => [ 'base' => '

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The value associated with the tag. The value may be an empty string but it can\'t be null.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$tags' => '

A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateDataSourceRequest$tags' => '

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateIndexRequest$tags' => '

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreatePluginRequest$tags' => '

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateRetrieverRequest$tags' => '

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'CreateWebExperienceRequest$tags' => '

A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

', 'ListTagsForResourceResponse$tags' => '

A list of tags associated with the Amazon Q Business application or data source.

', 'TagResourceRequest$tags' => '

A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.

', ], ], 'TextDocumentStatistics' => [ 'base' => '

Provides information about text documents in an index.

', 'refs' => [ 'IndexStatistics$textDocumentStatistics' => '

The number of documents indexed.

', ], ], 'TextInputEvent' => [ 'base' => '

An input event for a end user message in an Amazon Q Business web experience.

', 'refs' => [ 'ChatInputStream$textEvent' => '

Information about the payload of the ChatInputStream event containing the end user message input.

', ], ], 'TextOutputEvent' => [ 'base' => '

An output event for an AI-generated response in an Amazon Q Business web experience.

', 'refs' => [ 'ChatOutputStream$textEvent' => '

Information about the payload of the ChatOutputStream event containing the AI-generated message output.

', ], ], 'TextSegment' => [ 'base' => '

Provides information about a text extract in a chat response that can be attributed to a source document.

', 'refs' => [ 'TextSegmentList$member' => NULL, ], ], 'TextSegmentList' => [ 'base' => NULL, 'refs' => [ 'SourceAttribution$textMessageSegments' => '

A text extract from a source document that is used for source attribution.

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

The request was denied due to throttling. Reduce the number of requests and try again.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Application$createdAt' => '

The Unix timestamp when the Amazon Q Business application was created.

', 'Application$updatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'Conversation$startTime' => '

The start time of the conversation.

', 'DataSource$createdAt' => '

The Unix timestamp when the Amazon Q Business data source was created.

', 'DataSource$updatedAt' => '

The Unix timestamp when the Amazon Q Business data source was last updated.

', 'DataSourceSyncJob$startTime' => '

The Unix time stamp when the data source synchronization job started.

', 'DataSourceSyncJob$endTime' => '

The Unix timestamp when the synchronization job completed.

', 'DocumentAttributeValue$dateValue' => '

A date expressed as an ISO 8601 string.

It\'s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

', 'DocumentDetails$createdAt' => '

The timestamp for when the document was created.

', 'DocumentDetails$updatedAt' => '

The timestamp for when the document was last updated.

', 'GetApplicationResponse$createdAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'GetApplicationResponse$updatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'GetDataSourceResponse$createdAt' => '

The Unix timestamp when the data source connector was created.

', 'GetDataSourceResponse$updatedAt' => '

The Unix timestamp when the data source connector was last updated.

', 'GetIndexResponse$createdAt' => '

The Unix timestamp when the Amazon Q Business index was created.

', 'GetIndexResponse$updatedAt' => '

The Unix timestamp when the Amazon Q Business index was last updated.

', 'GetPluginResponse$createdAt' => '

The timestamp for when the plugin was created.

', 'GetPluginResponse$updatedAt' => '

The timestamp for when the plugin was last updated.

', 'GetRetrieverResponse$createdAt' => '

The Unix timestamp when the retriever was created.

', 'GetRetrieverResponse$updatedAt' => '

The Unix timestamp when the retriever was last updated.

', 'GetWebExperienceResponse$createdAt' => '

The Unix timestamp when the Amazon Q Business web experience was last created.

', 'GetWebExperienceResponse$updatedAt' => '

The Unix timestamp when the Amazon Q Business web experience was last updated.

', 'GroupStatusDetail$lastUpdatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'Index$createdAt' => '

The Unix timestamp when the index was created.

', 'Index$updatedAt' => '

The Unix timestamp when the index was last updated.

', 'ListDataSourceSyncJobsRequest$startTime' => '

The start time of the data source connector sync.

', 'ListDataSourceSyncJobsRequest$endTime' => '

The end time of the data source connector sync.

', 'ListGroupsRequest$updatedEarlierThan' => '

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

', 'Message$time' => '

The timestamp of the first Amazon Q Business web experience message.

', 'MessageUsefulnessFeedback$submittedAt' => '

The timestamp for when the feedback was submitted.

', 'Plugin$createdAt' => '

The timestamp for when the plugin was created.

', 'Plugin$updatedAt' => '

The timestamp for when the plugin was last updated.

', 'PutFeedbackRequest$messageCopiedAt' => '

The timestamp for when the feedback was recorded.

', 'SourceAttribution$updatedAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'WebExperience$createdAt' => '

The Unix timestamp when the Amazon Q Business application was last updated.

', 'WebExperience$updatedAt' => '

The Unix timestamp when your Amazon Q Business web experience was updated.

', ], ], 'Title' => [ 'base' => NULL, 'refs' => [ 'Document$title' => '

The title of the document.

', ], ], 'TopicConfiguration' => [ 'base' => '

The topic specific controls configured for an Amazon Q Business application.

', 'refs' => [ 'TopicConfigurations$member' => NULL, ], ], 'TopicConfigurationName' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$name' => '

A name for your topic control configuration.

', ], ], 'TopicConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetChatControlsConfigurationResponse$topicConfigurations' => '

The topic specific controls configured for a Amazon Q Business application.

', 'UpdateChatControlsConfigurationRequest$topicConfigurationsToCreateOrUpdate' => '

The configured topic specific chat controls you want to update.

', 'UpdateChatControlsConfigurationRequest$topicConfigurationsToDelete' => '

The configured topic specific chat controls you want to delete.

', ], ], 'TopicDescription' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$description' => '

A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChatControlsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChatControlsConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePluginRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePluginResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRetrieverRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRetrieverResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebExperienceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebExperienceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AuthChallengeRequest$authorizationUrl' => '

The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.

', 'AuthChallengeRequestEvent$authorizationUrl' => '

The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.

', 'CreatePluginRequest$serverUrl' => '

The source URL used for plugin configuration.

', 'GetPluginResponse$serverUrl' => '

The source URL used for plugin configuration.

', 'GetWebExperienceResponse$defaultEndpoint' => '

The endpoint of your Amazon Q Business web experience.

', 'Plugin$serverUrl' => '

The plugin server URL used for configuration.

', 'UpdatePluginRequest$serverUrl' => '

The source URL used for plugin configuration.

', 'WebExperience$defaultEndpoint' => '

The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.

', ], ], 'UserAlias' => [ 'base' => '

Aliases attached to a user id within an Amazon Q Business application.

', 'refs' => [ 'CreateUserRequestUserAliasesList$member' => NULL, 'UserAliases$member' => NULL, ], ], 'UserAliases' => [ 'base' => NULL, 'refs' => [ 'GetUserResponse$userAliases' => '

A list of user aliases attached to a user.

', 'UpdateUserRequest$userAliasesToUpdate' => '

The user aliases attached to the user id that are to be updated.

', 'UpdateUserRequest$userAliasesToDelete' => '

The user aliases attached to the user id that are to be deleted.

', 'UpdateUserResponse$userAliasesAdded' => '

The user aliases that have been to be added to a user id.

', 'UpdateUserResponse$userAliasesUpdated' => '

The user aliases attached to a user id that have been updated.

', 'UpdateUserResponse$userAliasesDeleted' => '

The user aliases that have been deleted from a user id.

', ], ], 'UserGroups' => [ 'base' => NULL, 'refs' => [ 'ChatInput$userGroups' => '

The groups that a user associated with the chat input belongs to.

', 'ChatSyncInput$userGroups' => '

The groups that a user associated with the chat input belongs to.

', 'UsersAndGroups$userGroups' => '

The user groups associated with a topic control rule.

', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'ChatInput$userId' => '

The identifier of the user attached to the chat input.

', 'ChatSyncInput$userId' => '

The identifier of the user attached to the chat input.

', 'DeleteConversationRequest$userId' => '

The identifier of the user who is deleting the conversation.

', 'ListConversationsRequest$userId' => '

The identifier of the user involved in the Amazon Q Business web experience conversation.

', 'ListMessagesRequest$userId' => '

The identifier of the user involved in the Amazon Q Business web experience conversation.

', 'PrincipalUser$id' => '

The identifier of the user.

', 'PutFeedbackRequest$userId' => '

The identifier of the user giving the feedback.

', ], ], 'UserIds' => [ 'base' => NULL, 'refs' => [ 'UsersAndGroups$userIds' => '

The user ids associated with a topic control rule.

', ], ], 'UserMessage' => [ 'base' => NULL, 'refs' => [ 'ChatSyncInput$userMessage' => '

A end user message in a conversation.

', 'TextInputEvent$userMessage' => '

A user message in a text message input event.

', ], ], 'UsersAndGroups' => [ 'base' => '

Provides information about users and groups associated with a topic control rule.

', 'refs' => [ 'Rule$includedUsersAndGroups' => '

Users and groups to be included in a rule.

', 'Rule$excludedUsersAndGroups' => '

Users and groups to be excluded from a rule.

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

The input doesn\'t meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '

The input failed to meet the constraints specified by Amazon Q Business in a specified field.

', 'refs' => [ 'ValidationExceptionFields$member' => NULL, ], ], 'ValidationExceptionFields' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fields' => '

The input field(s) that failed validation.

', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '

The reason for the ValidationException.

', ], ], 'WebExperience' => [ 'base' => '

Provides information for an Amazon Q Business web experience.

', 'refs' => [ 'WebExperiences$member' => NULL, ], ], 'WebExperienceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceResponse$webExperienceArn' => '

The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

', 'GetWebExperienceResponse$webExperienceArn' => '

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

', ], ], 'WebExperienceAuthConfiguration' => [ 'base' => '

Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

', 'refs' => [ 'GetWebExperienceResponse$authenticationConfiguration' => '

The authentication configuration information for your Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$authenticationConfiguration' => '

The authentication configuration of the Amazon Q Business web experience.

', ], ], 'WebExperienceId' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceResponse$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'DeleteWebExperienceRequest$webExperienceId' => '

The identifier of the Amazon Q Business web experience being deleted.

', 'GetWebExperienceRequest$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'GetWebExperienceResponse$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$webExperienceId' => '

The identifier of the Amazon Q Business web experience.

', 'WebExperience$webExperienceId' => '

The identifier of your Amazon Q Business web experience.

', ], ], 'WebExperienceSamplePromptsControlMode' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$samplePromptsControlMode' => '

Determines whether sample prompts are enabled in the web experience for an end user.

', 'GetWebExperienceResponse$samplePromptsControlMode' => '

Determines whether sample prompts are enabled in the web experience for an end user.

', 'UpdateWebExperienceRequest$samplePromptsControlMode' => '

Determines whether sample prompts are enabled in the web experience for an end user.

', ], ], 'WebExperienceStatus' => [ 'base' => NULL, 'refs' => [ 'GetWebExperienceResponse$status' => '

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

', 'WebExperience$status' => '

The status of your Amazon Q Business web experience.

', ], ], 'WebExperienceSubtitle' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$subtitle' => '

A subtitle to personalize your Amazon Q Business web experience.

', 'GetWebExperienceResponse$subtitle' => '

The subtitle for your Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$subtitle' => '

The subtitle of the Amazon Q Business web experience.

', ], ], 'WebExperienceTitle' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$title' => '

The title for your Amazon Q Business web experience.

', 'GetWebExperienceResponse$title' => '

The title for your Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$title' => '

The title of the Amazon Q Business web experience.

', ], ], 'WebExperienceWelcomeMessage' => [ 'base' => NULL, 'refs' => [ 'CreateWebExperienceRequest$welcomeMessage' => '

The customized welcome message for end users of an Amazon Q Business web experience.

', 'GetWebExperienceResponse$welcomeMessage' => '

The customized welcome message for end users of an Amazon Q Business web experience.

', 'UpdateWebExperienceRequest$welcomeMessage' => '

A customized welcome message for an end user in an Amazon Q Business web experience.

', ], ], 'WebExperiences' => [ 'base' => NULL, 'refs' => [ 'ListWebExperiencesResponse$webExperiences' => '

An array of summary information for one or more Amazon Q Business experiences.

', ], ], ],]; diff --git a/src/data/qbusiness/2023-11-27/smoke.json b/src/data/qbusiness/2023-11-27/smoke.json new file mode 100644 index 0000000000..a9756813e4 --- /dev/null +++ b/src/data/qbusiness/2023-11-27/smoke.json @@ -0,0 +1,6 @@ +{ + "version": 1, + "defaultRegion": "us-west-2", + "testCases": [ + ] +} diff --git a/src/data/qbusiness/2023-11-27/smoke.json.php b/src/data/qbusiness/2023-11-27/smoke.json.php new file mode 100644 index 0000000000..a69adfe119 --- /dev/null +++ b/src/data/qbusiness/2023-11-27/smoke.json.php @@ -0,0 +1,3 @@ + 1, 'defaultRegion' => 'us-west-2', 'testCases' => [],]; diff --git a/src/data/qbusiness/2023-11-27/waiters-2.json b/src/data/qbusiness/2023-11-27/waiters-2.json new file mode 100644 index 0000000000..13f60ee66b --- /dev/null +++ b/src/data/qbusiness/2023-11-27/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/src/data/qbusiness/2023-11-27/waiters-2.json.php b/src/data/qbusiness/2023-11-27/waiters-2.json.php new file mode 100644 index 0000000000..7278daf835 --- /dev/null +++ b/src/data/qbusiness/2023-11-27/waiters-2.json.php @@ -0,0 +1,3 @@ + 2, 'waiters' => [],]; diff --git a/src/data/quicksight/2018-04-01/api-2.json b/src/data/quicksight/2018-04-01/api-2.json index e02f56f60c..2565fe90d8 100644 --- a/src/data/quicksight/2018-04-01/api-2.json +++ b/src/data/quicksight/2018-04-01/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"quicksight", "jsonVersion":"1.0", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon QuickSight", "serviceId":"QuickSight", "signatureVersion":"v4", @@ -2844,6 +2845,22 @@ {"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":{ @@ -3336,7 +3353,15 @@ "members":{ "Dashboard":{"shape":"AnonymousUserDashboardEmbeddingConfiguration"}, "DashboardVisual":{"shape":"AnonymousUserDashboardVisualEmbeddingConfiguration"}, - "QSearchBar":{"shape":"AnonymousUserQSearchBarEmbeddingConfiguration"} + "QSearchBar":{"shape":"AnonymousUserQSearchBarEmbeddingConfiguration"}, + "GenerativeQnA":{"shape":"AnonymousUserGenerativeQnAEmbeddingConfiguration"} + } + }, + "AnonymousUserGenerativeQnAEmbeddingConfiguration":{ + "type":"structure", + "required":["InitialTopicId"], + "members":{ + "InitialTopicId":{"shape":"RestrictiveResourceId"} } }, "AnonymousUserQSearchBarEmbeddingConfiguration":{ @@ -5479,7 +5504,6 @@ "CreateAccountSubscriptionRequest":{ "type":"structure", "required":[ - "Edition", "AuthenticationMethod", "AwsAccountId", "AccountName", @@ -5501,6 +5525,9 @@ "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"}, @@ -11164,6 +11191,13 @@ "ForegroundColor":{"shape":"ConditionalFormattingColor"} } }, + "GaugeChartColorConfiguration":{ + "type":"structure", + "members":{ + "ForegroundColor":{"shape":"HexColor"}, + "BackgroundColor":{"shape":"HexColor"} + } + }, "GaugeChartConditionalFormatting":{ "type":"structure", "members":{ @@ -11190,6 +11224,7 @@ "DataLabels":{"shape":"DataLabelOptions"}, "TooltipOptions":{"shape":"TooltipOptions"}, "VisualPalette":{"shape":"VisualPalette"}, + "ColorConfiguration":{"shape":"GaugeChartColorConfiguration"}, "Interactions":{"shape":"VisualInteractionOptions"} } }, @@ -15053,7 +15088,7 @@ "PivotTableConditionalFormattingOptionList":{ "type":"list", "member":{"shape":"PivotTableConditionalFormattingOption"}, - "max":100 + "max":500 }, "PivotTableConditionalFormattingScope":{ "type":"structure", @@ -15421,6 +15456,13 @@ "MEASURE" ] }, + "PurchaseMode":{ + "type":"string", + "enum":[ + "MANUAL", + "AUTO_PURCHASE" + ] + }, "PutDataSetRefreshPropertiesRequest":{ "type":"structure", "required":[ @@ -15872,7 +15914,14 @@ "Dashboard":{"shape":"RegisteredUserDashboardEmbeddingConfiguration"}, "QuickSightConsole":{"shape":"RegisteredUserQuickSightConsoleEmbeddingConfiguration"}, "QSearchBar":{"shape":"RegisteredUserQSearchBarEmbeddingConfiguration"}, - "DashboardVisual":{"shape":"RegisteredUserDashboardVisualEmbeddingConfiguration"} + "DashboardVisual":{"shape":"RegisteredUserDashboardVisualEmbeddingConfiguration"}, + "GenerativeQnA":{"shape":"RegisteredUserGenerativeQnAEmbeddingConfiguration"} + } + }, + "RegisteredUserGenerativeQnAEmbeddingConfiguration":{ + "type":"structure", + "members":{ + "InitialTopicId":{"shape":"RestrictiveResourceId"} } }, "RegisteredUserQSearchBarEmbeddingConfiguration":{ @@ -16096,7 +16145,10 @@ "enum":[ "ADMIN", "AUTHOR", - "READER" + "READER", + "ADMIN_PRO", + "AUTHOR_PRO", + "READER_PRO" ] }, "RoleArn":{ @@ -16803,7 +16855,7 @@ "SeriesItemList":{ "type":"list", "member":{"shape":"SeriesItem"}, - "max":10 + "max":2000 }, "ServiceNowParameters":{ "type":"structure", @@ -17832,7 +17884,7 @@ "TableConditionalFormattingOptionList":{ "type":"list", "member":{"shape":"TableConditionalFormattingOption"}, - "max":100 + "max":500 }, "TableConfiguration":{ "type":"structure", @@ -18934,7 +18986,8 @@ "members":{ "Arn":{"shape":"Arn"}, "TopicId":{"shape":"TopicId"}, - "Name":{"shape":"ResourceName"} + "Name":{"shape":"ResourceName"}, + "UserExperienceVersion":{"shape":"TopicUserExperienceVersion"} } }, "TopicTimeGranularity":{ @@ -19981,6 +20034,31 @@ "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":[ @@ -20444,7 +20522,10 @@ "AUTHOR", "READER", "RESTRICTED_AUTHOR", - "RESTRICTED_READER" + "RESTRICTED_READER", + "ADMIN_PRO", + "AUTHOR_PRO", + "READER_PRO" ] }, "VPCConnection":{ 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 e86c3309e2..33b2aa5b78 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', 'serviceFullName' => 'Amazon QuickSight', 'serviceId' => 'QuickSight', 'signatureVersion' => 'v4', 'uid' => 'quicksight-2018-04-01', ], 'operations' => [ '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' => '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', ], ], ], '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', ], ], ], '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' => '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', ], ], ], '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', ], ], ], '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, ], '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', ], ], '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', ], ], ], '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, ], 'AnchorDateConfiguration' => [ 'type' => 'structure', 'members' => [ 'AnchorOption' => [ 'shape' => 'AnchorOption', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], ], ], 'AnchorOption' => [ 'type' => 'string', 'enum' => [ 'NOW', ], ], 'AnonymousUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'AnonymousUserDashboardVisualEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardVisualId', ], 'members' => [ 'InitialDashboardVisualId' => [ 'shape' => 'DashboardVisualId', ], ], ], 'AnonymousUserEmbeddingExperienceConfiguration' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfiguration', ], 'DashboardVisual' => [ 'shape' => 'AnonymousUserDashboardVisualEmbeddingConfiguration', ], 'QSearchBar' => [ 'shape' => 'AnonymousUserQSearchBarEmbeddingConfiguration', ], ], ], 'AnonymousUserQSearchBarEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialTopicId', ], 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'AnonymousUserSnapshotJobResult' => [ 'type' => 'structure', 'members' => [ 'FileGroups' => [ 'shape' => 'SnapshotJobResultFileGroupList', ], ], ], 'AnonymousUserSnapshotJobResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserSnapshotJobResult', ], ], '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', ], ], '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', ], ], ], 'BodySectionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BodySectionConfiguration', ], 'max' => 28, ], 'BodySectionContent' => [ 'type' => 'structure', 'members' => [ 'Layout' => [ 'shape' => 'SectionLayoutConfiguration', ], ], ], '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, ], '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', ], ], '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', ], ], ], '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', ], ], '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', ], ], '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, ], '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' => [ 'Edition', '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', ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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, ], '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', ], ], ], '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', ], ], ], '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', ], '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', ], ], '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', ], ], '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, ], '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', ], ], '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', ], ], ], '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', ], ], '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', ], ], '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.*', ], '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, ], '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' => 100, ], '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', ], ], '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, ], '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', 'DatabaseUser', ], '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', ], ], ], 'RegisteredUserConsoleFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], ], ], 'RegisteredUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'FeatureConfigurations' => [ 'shape' => 'RegisteredUserDashboardFeatureConfigurations', ], ], ], 'RegisteredUserDashboardFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], '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', ], ], ], '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\\-]+', ], 'Role' => [ 'type' => 'string', 'enum' => [ 'ADMIN', 'AUTHOR', 'READER', ], ], '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' => 10, ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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' => 100, ], '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', ], ], ], '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', ], ], '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', ], ], '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', ], ], 'TopicScheduleType' => [ 'type' => 'string', 'enum' => [ 'HOURLY', 'DAILY', 'WEEKLY', 'MONTHLY', ], ], 'TopicSingularFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'SingularConstant' => [ 'shape' => 'LimitedString', ], ], 'sensitive' => true, ], 'TopicSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicSummary', ], ], 'TopicSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'TopicTimeGranularity' => [ 'type' => 'string', 'enum' => [ 'SECOND', 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', ], ], 'TopicUserExperienceVersion' => [ 'type' => 'string', 'enum' => [ 'LEGACY', 'NEW_READER_EXPERIENCE', ], ], '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', ], ], ], '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', ], ], ], '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', ], ], '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', ], ], ], 'VisualPalette' => [ 'type' => 'structure', 'members' => [ 'ChartColor' => [ 'shape' => 'HexColor', ], 'ColorMap' => [ 'shape' => 'DataPathColorList', ], ], ], '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', ], 'operations' => [ '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' => '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', ], ], ], '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', ], ], ], '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' => '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', ], ], ], '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, ], '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', ], ], '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', ], ], ], '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, ], 'AnchorDateConfiguration' => [ 'type' => 'structure', 'members' => [ 'AnchorOption' => [ 'shape' => 'AnchorOption', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], ], ], 'AnchorOption' => [ 'type' => 'string', 'enum' => [ 'NOW', ], ], 'AnonymousUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], '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', ], ], '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', ], ], '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', ], ], ], 'BodySectionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BodySectionConfiguration', ], 'max' => 28, ], 'BodySectionContent' => [ 'type' => 'structure', 'members' => [ 'Layout' => [ 'shape' => 'SectionLayoutConfiguration', ], ], ], '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, ], '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', ], ], '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', ], ], ], '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', ], ], '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', ], ], '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, ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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, ], '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', ], ], ], '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', ], ], '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', ], ], '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, ], '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', ], ], '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', ], ], ], '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', ], ], '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', ], ], '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.*', ], '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, ], '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, ], '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', 'DatabaseUser', ], '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', ], ], ], 'RegisteredUserConsoleFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], ], ], 'RegisteredUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'FeatureConfigurations' => [ 'shape' => 'RegisteredUserDashboardFeatureConfigurations', ], ], ], 'RegisteredUserDashboardFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], '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\\-]+', ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], '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', ], ], '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', ], ], 'TopicScheduleType' => [ 'type' => 'string', 'enum' => [ 'HOURLY', 'DAILY', 'WEEKLY', 'MONTHLY', ], ], 'TopicSingularFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'SingularConstant' => [ 'shape' => 'LimitedString', ], ], 'sensitive' => true, ], 'TopicSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicSummary', ], ], 'TopicSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'UserExperienceVersion' => [ 'shape' => 'TopicUserExperienceVersion', ], ], ], 'TopicTimeGranularity' => [ 'type' => 'string', 'enum' => [ 'SECOND', 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', ], ], 'TopicUserExperienceVersion' => [ 'type' => 'string', 'enum' => [ 'LEGACY', 'NEW_READER_EXPERIENCE', ], ], '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', ], ], ], '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', ], ], ], 'VisualPalette' => [ 'type' => 'structure', 'members' => [ 'ChartColor' => [ 'shape' => 'HexColor', ], 'ColorMap' => [ 'shape' => 'DataPathColorList', ], ], ], '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 5c6c584a65..ebca724e41 100644 --- a/src/data/quicksight/2018-04-01/docs-2.json +++ b/src/data/quicksight/2018-04-01/docs-2.json @@ -162,6 +162,7 @@ "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.

", @@ -433,6 +434,12 @@ "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": { @@ -1553,6 +1560,7 @@ "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.

", @@ -4819,7 +4827,7 @@ "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, or console.

", + "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.

" } @@ -5598,6 +5606,12 @@ "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": { @@ -5955,9 +5969,12 @@ "GroupsList": { "base": null, "refs": { - "CreateAccountSubscriptionRequest$AdminGroup": "

The admin group associated with your Active Directory or IAM Identity Center account. This 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$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

" } }, @@ -6050,6 +6067,8 @@ "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.

", @@ -6258,7 +6277,7 @@ "IdentityType": { "base": null, "refs": { - "RegisterUserRequest$IdentityType": "

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

", + "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.

" } }, @@ -8550,6 +8569,12 @@ "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": { @@ -8848,7 +8873,13 @@ "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 you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.

" + "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": { @@ -9095,7 +9126,8 @@ "RestrictiveResourceId": { "base": null, "refs": { - "AnonymousUserQSearchBarEmbeddingConfiguration$InitialTopicId": "

The QuickSight Q topic ID of the 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 topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "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.

", @@ -9114,7 +9146,8 @@ "FolderSummary$FolderId": "

The ID of the folder.

", "ListFolderMembersRequest$FolderId": "

The ID of the folder.

", "MemberIdArnPair$MemberId": "

The ID of the member.

", - "RegisteredUserQSearchBarEmbeddingConfiguration$InitialTopicId": "

The ID of the Q topic that you want to make the starting topic in the Q search bar. 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, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.

", + "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.

", @@ -9147,7 +9180,7 @@ "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).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

", + "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.

" @@ -10700,6 +10733,7 @@ "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.

", @@ -11084,6 +11118,7 @@ "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.

", @@ -12265,7 +12300,8 @@ "TopicUserExperienceVersion": { "base": null, "refs": { - "TopicDetails$UserExperienceVersion": "

The user experience version of a topic.

" + "TopicDetails$UserExperienceVersion": "

The user experience version of a topic.

", + "TopicSummary$UserExperienceVersion": "

The user experience version of the topic.

" } }, "TotalAggregationComputation": { @@ -12705,6 +12741,16 @@ "refs": { } }, + "UpdateSPICECapacityConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UpdateSPICECapacityConfigurationResponse": { + "base": null, + "refs": { + } + }, "UpdateTemplateAliasRequest": { "base": null, "refs": { @@ -12852,8 +12898,8 @@ "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:.

" + "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": { 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 6b285ec788..9e19c1be28 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' => [ '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.

', '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.

', '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.

', '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.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], '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:

', ], ], '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.

', ], ], '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.

', ], ], '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.

', ], ], '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, '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.

', '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.

', '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.

', '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' => [ '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.

', '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.

', '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.

', '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.

', '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.

', ], ], '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.

', ], ], '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.

', 'DisplayFormatOptions$UseBlankCellFormat' => '

A Boolean value that indicates whether to use blank cell format.

', 'DisplayFormatOptions$UseGrouping' => '

A Boolean value that indicates whether to use grouping.

', '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.

', '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.

', '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.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], '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.

', ], ], '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.

', '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.

', '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, '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' => [ '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:

', ], ], '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' => [ '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.

', '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.

', ], ], '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.

', ], ], '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' => [], ], '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.

', ], ], '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.

', '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' => [], ], '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.

', ], ], 'DisplayFormatOptions' => [ 'base' => '

A structure that represents additional options for display formatting.

', 'refs' => [ 'DefaultFormatting$DisplayFormatOptions' => '

The additional options for display formatting.

', ], ], '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, 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.

', ], ], '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, ], ], '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.

', ], ], '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.

', ], ], '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. This 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.

', '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.

', '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.

', ], ], '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' => '

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

', '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.

', ], ], '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' => [ '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.

', ], ], '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' => [], ], '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.

', ], ], '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' => [ 'AggregationFunctionParameters$key' => NULL, 'AggregationFunctionParameters$value' => NULL, 'CellValueSynonym$CellValue' => '

The cell value.

', '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.

', 'NamedEntityDefinition$FieldName' => '

The name of the entity.

', 'NamedEntityDefinition$PropertyName' => '

The property name to be used for the named entity.

', '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.

', '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.

', 'TopicSingularFilterConstant$SingularConstant' => '

The value of the singular filter constant.

', 'TypeParameters$key' => NULL, 'TypeParameters$value' => NULL, ], ], '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' => [], ], '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.

', ], ], '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.

', ], ], '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.

', 'Entity$Path' => '

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], 'PutDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Query' => [ 'base' => NULL, 'refs' => [ 'TwitterParameters$Query' => '

Twitter query string.

', ], ], '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' => [], ], '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 you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.

', ], ], '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' => [ 'AnonymousUserQSearchBarEmbeddingConfiguration$InitialTopicId' => '

The QuickSight Q topic ID of the 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 topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

', '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.

', 'RegisteredUserQSearchBarEmbeddingConfiguration$InitialTopicId' => '

The ID of the Q topic that you want to make the starting topic in the Q search bar. 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, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.

', '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.

', ], ], '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).

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' => [ '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.

', ], ], '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.

', '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.

', ], ], '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' => [ '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.

', '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.

', '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.

', '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

', '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.

', '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.

', '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.

', '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.

', '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.

', '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.

', '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.

', '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.

', '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.

', ], ], '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' => [ '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.

', ], ], '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.

', ], ], '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.

', ], ], 'TopicId' => [ 'base' => NULL, 'refs' => [ '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.

', '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.

', ], ], '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.

', ], ], 'TopicSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTopicsResponse$TopicsSummaries' => '

A list of topic summaries.

', ], ], 'TopicSummary' => [ 'base' => '

A topic summary.

', 'refs' => [ 'TopicSummaries$member' => NULL, ], ], 'TopicTimeGranularity' => [ 'base' => NULL, 'refs' => [ '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.

', '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.

', ], ], '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' => [], ], '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' => [], ], '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.

', '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.

', ], ], '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.

', ], ], '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' => [ '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.

', '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.

', '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.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], '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:

', ], ], '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.

', ], ], '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.

', ], ], '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, '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.

', '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.

', '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.

', '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' => [ '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.

', '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.

', '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.

', '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.

', ], ], '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.

', ], ], '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.

', 'DisplayFormatOptions$UseBlankCellFormat' => '

A Boolean value that indicates whether to use blank cell format.

', 'DisplayFormatOptions$UseGrouping' => '

A Boolean value that indicates whether to use grouping.

', '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.

', '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.

', '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.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], '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.

', ], ], '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.

', '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.

', '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, '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' => [ '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:

', ], ], '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' => [ '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.

', '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.

', ], ], '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.

', ], ], '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' => [], ], '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.

', ], ], '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.

', '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' => [], ], '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.

', ], ], 'DisplayFormatOptions' => [ 'base' => '

A structure that represents additional options for display formatting.

', 'refs' => [ 'DefaultFormatting$DisplayFormatOptions' => '

The additional options for display formatting.

', ], ], '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.

', ], ], '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, ], ], '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.

', ], ], '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.

', ], ], '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.

', ], ], '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' => [ '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.

', ], ], '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' => [], ], '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.

', ], ], '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' => [ 'AggregationFunctionParameters$key' => NULL, 'AggregationFunctionParameters$value' => NULL, 'CellValueSynonym$CellValue' => '

The cell value.

', '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.

', 'NamedEntityDefinition$FieldName' => '

The name of the entity.

', 'NamedEntityDefinition$PropertyName' => '

The property name to be used for the named entity.

', '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.

', '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.

', 'TopicSingularFilterConstant$SingularConstant' => '

The value of the singular filter constant.

', 'TypeParameters$key' => NULL, 'TypeParameters$value' => NULL, ], ], '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' => [], ], '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.

', ], ], '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.

', ], ], '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.

', 'Entity$Path' => '

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], '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' => [], ], '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.

', ], ], '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' => [ '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.

', ], ], '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.

', '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.

', ], ], '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' => [ '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.

', '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.

', '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.

', '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

', '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.

', '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.

', '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.

', '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.

', '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.

', '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.

', '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.

', ], ], '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' => [ '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.

', ], ], '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.

', ], ], '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.

', ], ], 'TopicId' => [ 'base' => NULL, 'refs' => [ '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.

', '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.

', ], ], '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.

', ], ], 'TopicSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTopicsResponse$TopicsSummaries' => '

A list of topic summaries.

', ], ], 'TopicSummary' => [ 'base' => '

A topic summary.

', 'refs' => [ 'TopicSummaries$member' => NULL, ], ], 'TopicTimeGranularity' => [ 'base' => NULL, 'refs' => [ '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.

', '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.

', ], ], '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' => [], ], '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.

', '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.

', ], ], '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.

', ], ], '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/route53resolver/2018-04-01/api-2.json b/src/data/route53resolver/2018-04-01/api-2.json index 98cad62dbe..eaa4b03c13 100644 --- a/src/data/route53resolver/2018-04-01/api-2.json +++ b/src/data/route53resolver/2018-04-01/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"route53resolver", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"Route53Resolver", "serviceFullName":"Amazon Route 53 Resolver", "serviceId":"Route53Resolver", @@ -1382,6 +1383,10 @@ "box":true }, "Name":{"shape":"Name"}, + "FirewallDomainRedirectionAction":{ + "shape":"FirewallDomainRedirectionAction", + "box":true + }, "Qtype":{ "shape":"Qtype", "box":true @@ -1795,6 +1800,13 @@ "max":255, "min":1 }, + "FirewallDomainRedirectionAction":{ + "type":"string", + "enum":[ + "INSPECT_REDIRECTION_DOMAIN", + "TRUST_REDIRECTION_DOMAIN" + ] + }, "FirewallDomainUpdateOperation":{ "type":"string", "enum":[ @@ -1830,6 +1842,7 @@ "CreatorRequestId":{"shape":"CreatorRequestId"}, "CreationTime":{"shape":"Rfc3339TimeString"}, "ModificationTime":{"shape":"Rfc3339TimeString"}, + "FirewallDomainRedirectionAction":{"shape":"FirewallDomainRedirectionAction"}, "Qtype":{"shape":"Qtype"} } }, @@ -3354,6 +3367,10 @@ "shape":"Name", "box":true }, + "FirewallDomainRedirectionAction":{ + "shape":"FirewallDomainRedirectionAction", + "box":true + }, "Qtype":{"shape":"Qtype"} } }, diff --git a/src/data/route53resolver/2018-04-01/api-2.json.php b/src/data/route53resolver/2018-04-01/api-2.json.php index fcbe7686cf..4b99e6c38b 100644 --- a/src/data/route53resolver/2018-04-01/api-2.json.php +++ b/src/data/route53resolver/2018-04-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-04-01', 'endpointPrefix' => 'route53resolver', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Route53Resolver', 'serviceFullName' => 'Amazon Route 53 Resolver', 'serviceId' => 'Route53Resolver', 'signatureVersion' => 'v4', 'targetPrefix' => 'Route53Resolver', 'uid' => 'route53resolver-2018-04-01', ], 'operations' => [ 'AssociateFirewallRuleGroup' => [ 'name' => 'AssociateFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'AssociateFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateResolverEndpointIpAddress' => [ 'name' => 'AssociateResolverEndpointIpAddress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateResolverEndpointIpAddressRequest', ], 'output' => [ 'shape' => 'AssociateResolverEndpointIpAddressResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateResolverQueryLogConfig' => [ 'name' => 'AssociateResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'AssociateResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'AssociateResolverRule' => [ 'name' => 'AssociateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateResolverRuleRequest', ], 'output' => [ 'shape' => 'AssociateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateFirewallDomainList' => [ 'name' => 'CreateFirewallDomainList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFirewallDomainListRequest', ], 'output' => [ 'shape' => 'CreateFirewallDomainListResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateFirewallRule' => [ 'name' => 'CreateFirewallRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFirewallRuleRequest', ], 'output' => [ 'shape' => 'CreateFirewallRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateFirewallRuleGroup' => [ 'name' => 'CreateFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'CreateFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateOutpostResolver' => [ 'name' => 'CreateOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOutpostResolverRequest', ], 'output' => [ 'shape' => 'CreateOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateResolverEndpoint' => [ 'name' => 'CreateResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResolverEndpointRequest', ], 'output' => [ 'shape' => 'CreateResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateResolverQueryLogConfig' => [ 'name' => 'CreateResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'CreateResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateResolverRule' => [ 'name' => 'CreateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResolverRuleRequest', ], 'output' => [ 'shape' => 'CreateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteFirewallDomainList' => [ 'name' => 'DeleteFirewallDomainList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallDomainListRequest', ], 'output' => [ 'shape' => 'DeleteFirewallDomainListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteFirewallRule' => [ 'name' => 'DeleteFirewallRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallRuleRequest', ], 'output' => [ 'shape' => 'DeleteFirewallRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteFirewallRuleGroup' => [ 'name' => 'DeleteFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'DeleteFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteOutpostResolver' => [ 'name' => 'DeleteOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOutpostResolverRequest', ], 'output' => [ 'shape' => 'DeleteOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteResolverEndpoint' => [ 'name' => 'DeleteResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResolverEndpointRequest', ], 'output' => [ 'shape' => 'DeleteResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteResolverQueryLogConfig' => [ 'name' => 'DeleteResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'DeleteResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteResolverRule' => [ 'name' => 'DeleteResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResolverRuleRequest', ], 'output' => [ 'shape' => 'DeleteResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateFirewallRuleGroup' => [ 'name' => 'DisassociateFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'DisassociateFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateResolverEndpointIpAddress' => [ 'name' => 'DisassociateResolverEndpointIpAddress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateResolverEndpointIpAddressRequest', ], 'output' => [ 'shape' => 'DisassociateResolverEndpointIpAddressResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateResolverQueryLogConfig' => [ 'name' => 'DisassociateResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'DisassociateResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DisassociateResolverRule' => [ 'name' => 'DisassociateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateResolverRuleRequest', ], 'output' => [ 'shape' => 'DisassociateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallConfig' => [ 'name' => 'GetFirewallConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallConfigRequest', ], 'output' => [ 'shape' => 'GetFirewallConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetFirewallDomainList' => [ 'name' => 'GetFirewallDomainList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallDomainListRequest', ], 'output' => [ 'shape' => 'GetFirewallDomainListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallRuleGroup' => [ 'name' => 'GetFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'GetFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallRuleGroupAssociation' => [ 'name' => 'GetFirewallRuleGroupAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallRuleGroupAssociationRequest', ], 'output' => [ 'shape' => 'GetFirewallRuleGroupAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallRuleGroupPolicy' => [ 'name' => 'GetFirewallRuleGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallRuleGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetFirewallRuleGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetOutpostResolver' => [ 'name' => 'GetOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOutpostResolverRequest', ], 'output' => [ 'shape' => 'GetOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetResolverConfig' => [ 'name' => 'GetResolverConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverConfigRequest', ], 'output' => [ 'shape' => 'GetResolverConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetResolverDnssecConfig' => [ 'name' => 'GetResolverDnssecConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverDnssecConfigRequest', ], 'output' => [ 'shape' => 'GetResolverDnssecConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverEndpoint' => [ 'name' => 'GetResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverEndpointRequest', ], 'output' => [ 'shape' => 'GetResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetResolverQueryLogConfig' => [ 'name' => 'GetResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'GetResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverQueryLogConfigAssociation' => [ 'name' => 'GetResolverQueryLogConfigAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverQueryLogConfigAssociationRequest', ], 'output' => [ 'shape' => 'GetResolverQueryLogConfigAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverQueryLogConfigPolicy' => [ 'name' => 'GetResolverQueryLogConfigPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverQueryLogConfigPolicyRequest', ], 'output' => [ 'shape' => 'GetResolverQueryLogConfigPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverRule' => [ 'name' => 'GetResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverRuleRequest', ], 'output' => [ 'shape' => 'GetResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetResolverRuleAssociation' => [ 'name' => 'GetResolverRuleAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverRuleAssociationRequest', ], 'output' => [ 'shape' => 'GetResolverRuleAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetResolverRulePolicy' => [ 'name' => 'GetResolverRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverRulePolicyRequest', ], 'output' => [ 'shape' => 'GetResolverRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ImportFirewallDomains' => [ 'name' => 'ImportFirewallDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportFirewallDomainsRequest', ], 'output' => [ 'shape' => 'ImportFirewallDomainsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallConfigs' => [ 'name' => 'ListFirewallConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallConfigsRequest', ], 'output' => [ 'shape' => 'ListFirewallConfigsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallDomainLists' => [ 'name' => 'ListFirewallDomainLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallDomainListsRequest', ], 'output' => [ 'shape' => 'ListFirewallDomainListsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallDomains' => [ 'name' => 'ListFirewallDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallDomainsRequest', ], 'output' => [ 'shape' => 'ListFirewallDomainsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallRuleGroupAssociations' => [ 'name' => 'ListFirewallRuleGroupAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallRuleGroupAssociationsRequest', ], 'output' => [ 'shape' => 'ListFirewallRuleGroupAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallRuleGroups' => [ 'name' => 'ListFirewallRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallRuleGroupsRequest', ], 'output' => [ 'shape' => 'ListFirewallRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallRules' => [ 'name' => 'ListFirewallRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallRulesRequest', ], 'output' => [ 'shape' => 'ListFirewallRulesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListOutpostResolvers' => [ 'name' => 'ListOutpostResolvers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOutpostResolversRequest', ], 'output' => [ 'shape' => 'ListOutpostResolversResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListResolverConfigs' => [ 'name' => 'ListResolverConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverConfigsRequest', ], 'output' => [ 'shape' => 'ListResolverConfigsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListResolverDnssecConfigs' => [ 'name' => 'ListResolverDnssecConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverDnssecConfigsRequest', ], 'output' => [ 'shape' => 'ListResolverDnssecConfigsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResolverEndpointIpAddresses' => [ 'name' => 'ListResolverEndpointIpAddresses', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverEndpointIpAddressesRequest', ], 'output' => [ 'shape' => 'ListResolverEndpointIpAddressesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListResolverEndpoints' => [ 'name' => 'ListResolverEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverEndpointsRequest', ], 'output' => [ 'shape' => 'ListResolverEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListResolverQueryLogConfigAssociations' => [ 'name' => 'ListResolverQueryLogConfigAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverQueryLogConfigAssociationsRequest', ], 'output' => [ 'shape' => 'ListResolverQueryLogConfigAssociationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResolverQueryLogConfigs' => [ 'name' => 'ListResolverQueryLogConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverQueryLogConfigsRequest', ], 'output' => [ 'shape' => 'ListResolverQueryLogConfigsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResolverRuleAssociations' => [ 'name' => 'ListResolverRuleAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverRuleAssociationsRequest', ], 'output' => [ 'shape' => 'ListResolverRuleAssociationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListResolverRules' => [ 'name' => 'ListResolverRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverRulesRequest', ], 'output' => [ 'shape' => 'ListResolverRulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'PutFirewallRuleGroupPolicy' => [ 'name' => 'PutFirewallRuleGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutFirewallRuleGroupPolicyRequest', ], 'output' => [ 'shape' => 'PutFirewallRuleGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'PutResolverQueryLogConfigPolicy' => [ 'name' => 'PutResolverQueryLogConfigPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResolverQueryLogConfigPolicyRequest', ], 'output' => [ 'shape' => 'PutResolverQueryLogConfigPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidPolicyDocument', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutResolverRulePolicy' => [ 'name' => 'PutResolverRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResolverRulePolicyRequest', ], 'output' => [ 'shape' => 'PutResolverRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidPolicyDocument', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidTagException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallConfig' => [ 'name' => 'UpdateFirewallConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallConfigRequest', ], 'output' => [ 'shape' => 'UpdateFirewallConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallDomains' => [ 'name' => 'UpdateFirewallDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallDomainsRequest', ], 'output' => [ 'shape' => 'UpdateFirewallDomainsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallRule' => [ 'name' => 'UpdateFirewallRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallRuleRequest', ], 'output' => [ 'shape' => 'UpdateFirewallRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallRuleGroupAssociation' => [ 'name' => 'UpdateFirewallRuleGroupAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallRuleGroupAssociationRequest', ], 'output' => [ 'shape' => 'UpdateFirewallRuleGroupAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateOutpostResolver' => [ 'name' => 'UpdateOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateOutpostResolverRequest', ], 'output' => [ 'shape' => 'UpdateOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateResolverConfig' => [ 'name' => 'UpdateResolverConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverConfigRequest', ], 'output' => [ 'shape' => 'UpdateResolverConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateResolverDnssecConfig' => [ 'name' => 'UpdateResolverDnssecConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverDnssecConfigRequest', ], 'output' => [ 'shape' => 'UpdateResolverDnssecConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateResolverEndpoint' => [ 'name' => 'UpdateResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverEndpointRequest', ], 'output' => [ 'shape' => 'UpdateResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateResolverRule' => [ 'name' => 'UpdateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverRuleRequest', ], 'output' => [ 'shape' => 'UpdateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 32, 'min' => 12, ], 'Action' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', 'ALERT', ], ], 'Arn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'AssociateFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'FirewallRuleGroupId', 'VpcId', 'Priority', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', ], 'Name' => [ 'shape' => 'Name', ], 'MutationProtection' => [ 'shape' => 'MutationProtectionStatus', 'box' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'AssociateFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'AssociateResolverEndpointIpAddressRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', 'IpAddress', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'IpAddress' => [ 'shape' => 'IpAddressUpdate', ], ], ], 'AssociateResolverEndpointIpAddressResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'AssociateResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', 'ResourceId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'AssociateResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigAssociation' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], ], 'AssociateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', 'VPCId', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'VPCId' => [ 'shape' => 'ResourceId', ], ], ], 'AssociateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRuleAssociation' => [ 'shape' => 'ResolverRuleAssociation', ], ], ], 'AutodefinedReverseFlag' => [ 'type' => 'string', 'enum' => [ 'ENABLE', 'DISABLE', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'BlockOverrideDnsType' => [ 'type' => 'string', 'enum' => [ 'CNAME', ], ], 'BlockOverrideDomain' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'BlockOverrideTtl' => [ 'type' => 'integer', 'max' => 604800, 'min' => 0, ], 'BlockResponse' => [ 'type' => 'string', 'enum' => [ 'NODATA', 'NXDOMAIN', 'OVERRIDE', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'Count' => [ 'type' => 'integer', ], 'CreateFirewallDomainListRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'Name' => [ 'shape' => 'Name', ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateFirewallDomainListResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallDomainList' => [ 'shape' => 'FirewallDomainList', ], ], ], 'CreateFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'Name' => [ 'shape' => 'Name', ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroup' => [ 'shape' => 'FirewallRuleGroup', ], ], ], 'CreateFirewallRuleRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'FirewallRuleGroupId', 'FirewallDomainListId', 'Priority', 'Action', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', ], 'Action' => [ 'shape' => 'Action', ], 'BlockResponse' => [ 'shape' => 'BlockResponse', 'box' => true, ], 'BlockOverrideDomain' => [ 'shape' => 'BlockOverrideDomain', 'box' => true, ], 'BlockOverrideDnsType' => [ 'shape' => 'BlockOverrideDnsType', 'box' => true, ], 'BlockOverrideTtl' => [ 'shape' => 'BlockOverrideTtl', 'box' => true, ], 'Name' => [ 'shape' => 'Name', ], 'Qtype' => [ 'shape' => 'Qtype', 'box' => true, ], ], ], 'CreateFirewallRuleResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRule' => [ 'shape' => 'FirewallRule', ], ], ], 'CreateOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'Name', 'PreferredInstanceType', 'OutpostArn', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Name' => [ 'shape' => 'OutpostResolverName', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', 'box' => true, ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'CreateResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'SecurityGroupIds', 'Direction', 'IpAddresses', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Name' => [ 'shape' => 'Name', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', 'box' => true, ], 'Direction' => [ 'shape' => 'ResolverEndpointDirection', ], 'IpAddresses' => [ 'shape' => 'IpAddressesRequest', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', 'box' => true, ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', 'box' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], 'ResolverEndpointType' => [ 'shape' => 'ResolverEndpointType', 'box' => true, ], 'Protocols' => [ 'shape' => 'ProtocolList', 'box' => true, ], ], ], 'CreateResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'CreateResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'DestinationArn', 'CreatorRequestId', ], 'members' => [ 'Name' => [ 'shape' => 'ResolverQueryLogConfigName', ], 'DestinationArn' => [ 'shape' => 'DestinationArn', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfig' => [ 'shape' => 'ResolverQueryLogConfig', ], ], ], 'CreateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'RuleType', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Name' => [ 'shape' => 'Name', ], 'RuleType' => [ 'shape' => 'RuleTypeOption', ], 'DomainName' => [ 'shape' => 'DomainName', 'box' => true, ], 'TargetIps' => [ 'shape' => 'TargetList', 'box' => true, ], 'ResolverEndpointId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'CreatorRequestId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'DeleteFirewallDomainListRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteFirewallDomainListResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallDomainList' => [ 'shape' => 'FirewallDomainList', ], ], ], 'DeleteFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroup' => [ 'shape' => 'FirewallRuleGroup', ], ], ], 'DeleteFirewallRuleRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', 'FirewallDomainListId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Qtype' => [ 'shape' => 'Qtype', ], ], ], 'DeleteFirewallRuleResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRule' => [ 'shape' => 'FirewallRule', ], ], ], 'DeleteOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'DeleteResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'DeleteResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfig' => [ 'shape' => 'ResolverQueryLogConfig', ], ], ], 'DeleteResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'DestinationArn' => [ 'type' => 'string', 'max' => 600, 'min' => 1, ], 'DisassociateFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupAssociationId', ], 'members' => [ 'FirewallRuleGroupAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'DisassociateFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'DisassociateResolverEndpointIpAddressRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', 'IpAddress', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'IpAddress' => [ 'shape' => 'IpAddressUpdate', ], ], ], 'DisassociateResolverEndpointIpAddressResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'DisassociateResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', 'ResourceId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'DisassociateResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigAssociation' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], ], 'DisassociateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'VPCId', 'ResolverRuleId', ], 'members' => [ 'VPCId' => [ 'shape' => 'ResourceId', ], 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], ], ], 'DisassociateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRuleAssociation' => [ 'shape' => 'ResolverRuleAssociation', ], ], ], 'DomainListFileUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'DomainName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ExceptionMessage' => [ 'type' => 'string', ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FilterName', ], 'Values' => [ 'shape' => 'FilterValues', ], ], ], 'FilterName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 600, 'min' => 1, ], 'FilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'FirewallConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'FirewallFailOpen' => [ 'shape' => 'FirewallFailOpenStatus', ], ], ], 'FirewallConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallConfig', ], ], 'FirewallDomainImportOperation' => [ 'type' => 'string', 'enum' => [ 'REPLACE', ], ], 'FirewallDomainList' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'DomainCount' => [ 'shape' => 'Unsigned', ], 'Status' => [ 'shape' => 'FirewallDomainListStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'ManagedOwnerName' => [ 'shape' => 'ServicePrinciple', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'FirewallDomainListMetadata' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'ManagedOwnerName' => [ 'shape' => 'ServicePrinciple', ], ], ], 'FirewallDomainListMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallDomainListMetadata', ], ], 'FirewallDomainListStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'COMPLETE_IMPORT_FAILED', 'IMPORTING', 'DELETING', 'UPDATING', ], ], 'FirewallDomainName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'FirewallDomainUpdateOperation' => [ 'type' => 'string', 'enum' => [ 'ADD', 'REMOVE', 'REPLACE', ], ], 'FirewallDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallDomainName', ], ], 'FirewallFailOpenStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'FirewallRule' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Priority' => [ 'shape' => 'Priority', ], 'Action' => [ 'shape' => 'Action', ], 'BlockResponse' => [ 'shape' => 'BlockResponse', ], 'BlockOverrideDomain' => [ 'shape' => 'BlockOverrideDomain', ], 'BlockOverrideDnsType' => [ 'shape' => 'BlockOverrideDnsType', ], 'BlockOverrideTtl' => [ 'shape' => 'Unsigned', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'Qtype' => [ 'shape' => 'Qtype', ], ], ], 'FirewallRuleGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'RuleCount' => [ 'shape' => 'Unsigned', ], 'Status' => [ 'shape' => 'FirewallRuleGroupStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'FirewallRuleGroupAssociation' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Priority' => [ 'shape' => 'Priority', ], 'MutationProtection' => [ 'shape' => 'MutationProtectionStatus', ], 'ManagedOwnerName' => [ 'shape' => 'ServicePrinciple', ], 'Status' => [ 'shape' => 'FirewallRuleGroupAssociationStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'FirewallRuleGroupAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'DELETING', 'UPDATING', ], ], 'FirewallRuleGroupAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], 'FirewallRuleGroupMetadata' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], ], ], 'FirewallRuleGroupMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallRuleGroupMetadata', ], ], 'FirewallRuleGroupPolicy' => [ 'type' => 'string', 'max' => 30000, ], 'FirewallRuleGroupStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'DELETING', 'UPDATING', ], ], 'FirewallRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallRule', ], ], 'GetFirewallConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallConfigResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallConfig' => [ 'shape' => 'FirewallConfig', ], ], ], 'GetFirewallDomainListRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallDomainListResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallDomainList' => [ 'shape' => 'FirewallDomainList', ], ], ], 'GetFirewallRuleGroupAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupAssociationId', ], 'members' => [ 'FirewallRuleGroupAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallRuleGroupAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'GetFirewallRuleGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'GetFirewallRuleGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupPolicy' => [ 'shape' => 'FirewallRuleGroupPolicy', ], ], ], 'GetFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroup' => [ 'shape' => 'FirewallRuleGroup', ], ], ], 'GetOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], ], ], 'GetOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'GetResolverConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverConfig' => [ 'shape' => 'ResolverConfig', ], ], ], 'GetResolverDnssecConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverDnssecConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverDNSSECConfig' => [ 'shape' => 'ResolverDnssecConfig', ], ], ], 'GetResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'GetResolverQueryLogConfigAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigAssociationId', ], 'members' => [ 'ResolverQueryLogConfigAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverQueryLogConfigAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigAssociation' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], ], 'GetResolverQueryLogConfigPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'GetResolverQueryLogConfigPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigPolicy' => [ 'shape' => 'ResolverQueryLogConfigPolicy', ], ], ], 'GetResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfig' => [ 'shape' => 'ResolverQueryLogConfig', ], ], ], 'GetResolverRuleAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleAssociationId', ], 'members' => [ 'ResolverRuleAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverRuleAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRuleAssociation' => [ 'shape' => 'ResolverRuleAssociation', ], ], ], 'GetResolverRulePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'GetResolverRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRulePolicy' => [ 'shape' => 'ResolverRulePolicy', ], ], ], 'GetResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'ImportFirewallDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', 'Operation', 'DomainFileUrl', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Operation' => [ 'shape' => 'FirewallDomainImportOperation', ], 'DomainFileUrl' => [ 'shape' => 'DomainListFileUrl', ], ], ], 'ImportFirewallDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Status' => [ 'shape' => 'FirewallDomainListStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'InstanceCount' => [ 'type' => 'integer', ], 'InternalServiceErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], 'FieldName' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidPolicyDocument' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'InvalidTagException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'Ip' => [ 'type' => 'string', 'max' => 36, 'min' => 7, ], 'IpAddressCount' => [ 'type' => 'integer', ], 'IpAddressRequest' => [ 'type' => 'structure', 'required' => [ 'SubnetId', ], 'members' => [ 'SubnetId' => [ 'shape' => 'SubnetId', ], 'Ip' => [ 'shape' => 'Ip', 'box' => true, ], 'Ipv6' => [ 'shape' => 'Ipv6', 'box' => true, ], ], ], 'IpAddressResponse' => [ 'type' => 'structure', 'members' => [ 'IpId' => [ 'shape' => 'ResourceId', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'Ip' => [ 'shape' => 'Ip', ], 'Ipv6' => [ 'shape' => 'Ipv6', ], 'Status' => [ 'shape' => 'IpAddressStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'IpAddressStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'FAILED_CREATION', 'ATTACHING', 'ATTACHED', 'REMAP_DETACHING', 'REMAP_ATTACHING', 'DETACHING', 'FAILED_RESOURCE_GONE', 'DELETING', 'DELETE_FAILED_FAS_EXPIRED', 'UPDATING', 'UPDATE_FAILED', ], ], 'IpAddressUpdate' => [ 'type' => 'structure', 'members' => [ 'IpId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'SubnetId' => [ 'shape' => 'SubnetId', 'box' => true, ], 'Ip' => [ 'shape' => 'Ip', 'box' => true, ], 'Ipv6' => [ 'shape' => 'Ipv6', 'box' => true, ], ], ], 'IpAddressesRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpAddressRequest', ], 'max' => 20, 'min' => 2, ], 'IpAddressesResponse' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpAddressResponse', ], ], 'Ipv6' => [ 'type' => 'string', 'max' => 39, 'min' => 7, ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ListDomainMaxResults' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'ListFirewallConfigsMaxResult' => [ 'type' => 'integer', 'max' => 10, 'min' => 5, ], 'ListFirewallConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'ListFirewallConfigsMaxResult', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallConfigs' => [ 'shape' => 'FirewallConfigList', ], ], ], 'ListFirewallDomainListsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallDomainListsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallDomainLists' => [ 'shape' => 'FirewallDomainListMetadataList', ], ], ], 'ListFirewallDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'MaxResults' => [ 'shape' => 'ListDomainMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'Domains' => [ 'shape' => 'FirewallDomains', ], ], ], 'ListFirewallRuleGroupAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'VpcId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Status' => [ 'shape' => 'FirewallRuleGroupAssociationStatus', 'box' => true, ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallRuleGroupAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallRuleGroupAssociations' => [ 'shape' => 'FirewallRuleGroupAssociations', ], ], ], 'ListFirewallRuleGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallRuleGroups' => [ 'shape' => 'FirewallRuleGroupMetadataList', ], ], ], 'ListFirewallRulesRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Action' => [ 'shape' => 'Action', 'box' => true, ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallRulesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallRules' => [ 'shape' => 'FirewallRules', ], ], ], 'ListOutpostResolversRequest' => [ 'type' => 'structure', 'members' => [ 'OutpostArn' => [ 'shape' => 'OutpostArn', 'box' => true, ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListOutpostResolversResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolvers' => [ 'shape' => 'OutpostResolverList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResolverConfigsMaxResult' => [ 'type' => 'integer', 'max' => 100, 'min' => 5, ], 'ListResolverConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'ListResolverConfigsMaxResult', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListResolverConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ResolverConfigs' => [ 'shape' => 'ResolverConfigList', ], ], ], 'ListResolverDnssecConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverDnssecConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ResolverDnssecConfigs' => [ 'shape' => 'ResolverDnssecConfigList', ], ], ], 'ListResolverEndpointIpAddressesRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListResolverEndpointIpAddressesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'IpAddresses' => [ 'shape' => 'IpAddressesResponse', ], ], ], 'ListResolverEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverEndpointsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResolverEndpoints' => [ 'shape' => 'ResolverEndpoints', ], ], ], 'ListResolverQueryLogConfigAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'Filters' => [ 'shape' => 'Filters', ], 'SortBy' => [ 'shape' => 'SortByKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListResolverQueryLogConfigAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TotalCount' => [ 'shape' => 'Count', ], 'TotalFilteredCount' => [ 'shape' => 'Count', ], 'ResolverQueryLogConfigAssociations' => [ 'shape' => 'ResolverQueryLogConfigAssociationList', ], ], ], 'ListResolverQueryLogConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], 'SortBy' => [ 'shape' => 'SortByKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListResolverQueryLogConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TotalCount' => [ 'shape' => 'Count', ], 'TotalFilteredCount' => [ 'shape' => 'Count', ], 'ResolverQueryLogConfigs' => [ 'shape' => 'ResolverQueryLogConfigList', ], ], ], 'ListResolverRuleAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverRuleAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResolverRuleAssociations' => [ 'shape' => 'ResolverRuleAssociations', ], ], ], 'ListResolverRulesRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverRulesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResolverRules' => [ 'shape' => 'ResolverRules', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MutationProtectionStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'Name' => [ 'type' => 'string', 'max' => 64, 'pattern' => '(?!^[0-9]+$)([a-zA-Z0-9\\-_\' \']+)', ], 'NextToken' => [ 'type' => 'string', ], 'OutpostArn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$', ], 'OutpostInstanceType' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'OutpostResolver' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Id' => [ 'shape' => 'ResourceId', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', ], 'Name' => [ 'shape' => 'OutpostResolverName', ], 'Status' => [ 'shape' => 'OutpostResolverStatus', ], 'StatusMessage' => [ 'shape' => 'OutpostResolverStatusMessage', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', ], ], ], 'OutpostResolverList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutpostResolver', ], ], 'OutpostResolverName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'OutpostResolverStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'OPERATIONAL', 'UPDATING', 'DELETING', 'ACTION_NEEDED', 'FAILED_CREATION', 'FAILED_DELETION', ], ], 'OutpostResolverStatusMessage' => [ 'type' => 'string', 'max' => 4096, ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'Priority' => [ 'type' => 'integer', ], 'Protocol' => [ 'type' => 'string', 'enum' => [ 'DoH', 'Do53', 'DoH-FIPS', ], ], 'ProtocolList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Protocol', ], 'max' => 2, 'min' => 1, ], 'PutFirewallRuleGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'FirewallRuleGroupPolicy', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'FirewallRuleGroupPolicy' => [ 'shape' => 'FirewallRuleGroupPolicy', ], ], ], 'PutFirewallRuleGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ReturnValue' => [ 'shape' => 'Boolean', ], ], ], 'PutResolverQueryLogConfigPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'ResolverQueryLogConfigPolicy', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'ResolverQueryLogConfigPolicy' => [ 'shape' => 'ResolverQueryLogConfigPolicy', ], ], ], 'PutResolverQueryLogConfigPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ReturnValue' => [ 'shape' => 'Boolean', ], ], ], 'PutResolverRulePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'ResolverRulePolicy', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'ResolverRulePolicy' => [ 'shape' => 'ResolverRulePolicy', ], ], ], 'PutResolverRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ReturnValue' => [ 'shape' => 'Boolean', ], ], ], 'Qtype' => [ 'type' => 'string', 'max' => 16, 'min' => 1, ], 'ResolverAutodefinedReverseStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLING', 'ENABLED', 'DISABLING', 'DISABLED', 'UPDATING_TO_USE_LOCAL_RESOURCE_SETTING', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'ResolverConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'AutodefinedReverse' => [ 'shape' => 'ResolverAutodefinedReverseStatus', ], ], ], 'ResolverConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverConfig', ], ], 'ResolverDNSSECValidationStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLING', 'ENABLED', 'DISABLING', 'DISABLED', 'UPDATING_TO_USE_LOCAL_RESOURCE_SETTING', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'ResolverDnssecConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ValidationStatus' => [ 'shape' => 'ResolverDNSSECValidationStatus', ], ], ], 'ResolverDnssecConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverDnssecConfig', ], ], 'ResolverEndpoint' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'Direction' => [ 'shape' => 'ResolverEndpointDirection', ], 'IpAddressCount' => [ 'shape' => 'IpAddressCount', ], 'HostVPCId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'ResolverEndpointStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', ], 'ResolverEndpointType' => [ 'shape' => 'ResolverEndpointType', ], 'Protocols' => [ 'shape' => 'ProtocolList', ], ], ], 'ResolverEndpointDirection' => [ 'type' => 'string', 'enum' => [ 'INBOUND', 'OUTBOUND', ], ], 'ResolverEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'OPERATIONAL', 'UPDATING', 'AUTO_RECOVERING', 'ACTION_NEEDED', 'DELETING', ], ], 'ResolverEndpointType' => [ 'type' => 'string', 'enum' => [ 'IPV6', 'IPV4', 'DUALSTACK', ], ], 'ResolverEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverEndpoint', ], ], 'ResolverQueryLogConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'Status' => [ 'shape' => 'ResolverQueryLogConfigStatus', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], 'AssociationCount' => [ 'shape' => 'Count', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ResolverQueryLogConfigName', ], 'DestinationArn' => [ 'shape' => 'DestinationArn', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'ResolverQueryLogConfigAssociation' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'ResolverQueryLogConfigAssociationStatus', ], 'Error' => [ 'shape' => 'ResolverQueryLogConfigAssociationError', ], 'ErrorMessage' => [ 'shape' => 'ResolverQueryLogConfigAssociationErrorMessage', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'ResolverQueryLogConfigAssociationError' => [ 'type' => 'string', 'enum' => [ 'NONE', 'DESTINATION_NOT_FOUND', 'ACCESS_DENIED', 'INTERNAL_SERVICE_ERROR', ], ], 'ResolverQueryLogConfigAssociationErrorMessage' => [ 'type' => 'string', ], 'ResolverQueryLogConfigAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], 'ResolverQueryLogConfigAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'ACTION_NEEDED', 'DELETING', 'FAILED', ], ], 'ResolverQueryLogConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverQueryLogConfig', ], ], 'ResolverQueryLogConfigName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '(?!^[0-9]+$)([a-zA-Z0-9\\-_\' \']+)', ], 'ResolverQueryLogConfigPolicy' => [ 'type' => 'string', 'max' => 30000, ], 'ResolverQueryLogConfigStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'DELETING', 'FAILED', ], ], 'ResolverRule' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Arn' => [ 'shape' => 'Arn', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'ResolverRuleStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'RuleType' => [ 'shape' => 'RuleTypeOption', ], 'Name' => [ 'shape' => 'Name', ], 'TargetIps' => [ 'shape' => 'TargetList', ], 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'ResolverRuleAssociation' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'VPCId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'ResolverRuleAssociationStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'ResolverRuleAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'COMPLETE', 'DELETING', 'FAILED', 'OVERRIDDEN', ], ], 'ResolverRuleAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverRuleAssociation', ], ], 'ResolverRuleConfig' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'Name', ], 'TargetIps' => [ 'shape' => 'TargetList', ], 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'ResolverRulePolicy' => [ 'type' => 'string', 'max' => 30000, ], 'ResolverRuleStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'DELETING', 'UPDATING', 'FAILED', ], ], 'ResolverRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverRule', ], ], 'ResourceExistsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'Rfc3339TimeString' => [ 'type' => 'string', 'max' => 40, 'min' => 20, ], 'RuleTypeOption' => [ 'type' => 'string', 'enum' => [ 'FORWARD', 'SYSTEM', 'RECURSIVE', ], ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceId', ], ], 'ServicePrinciple' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'ShareStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_SHARED', 'SHARED_WITH_ME', 'SHARED_BY_ME', ], ], 'SortByKey' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'StatusMessage' => [ 'type' => 'string', 'max' => 255, ], 'String' => [ 'type' => 'string', ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TargetAddress' => [ 'type' => 'structure', 'members' => [ 'Ip' => [ 'shape' => 'Ip', 'box' => true, ], 'Port' => [ 'shape' => 'Port', 'box' => true, ], 'Ipv6' => [ 'shape' => 'Ipv6', 'box' => true, ], 'Protocol' => [ 'shape' => 'Protocol', 'box' => true, ], ], ], 'TargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetAddress', ], 'min' => 1, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'UnknownResourceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'Unsigned' => [ 'type' => 'integer', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateFirewallConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'FirewallFailOpen', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'FirewallFailOpen' => [ 'shape' => 'FirewallFailOpenStatus', ], ], ], 'UpdateFirewallConfigResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallConfig' => [ 'shape' => 'FirewallConfig', ], ], ], 'UpdateFirewallDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', 'Operation', 'Domains', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Operation' => [ 'shape' => 'FirewallDomainUpdateOperation', ], 'Domains' => [ 'shape' => 'FirewallDomains', ], ], ], 'UpdateFirewallDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Status' => [ 'shape' => 'FirewallDomainListStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'UpdateFirewallRuleGroupAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupAssociationId', ], 'members' => [ 'FirewallRuleGroupAssociationId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'MutationProtection' => [ 'shape' => 'MutationProtectionStatus', 'box' => true, ], 'Name' => [ 'shape' => 'Name', 'box' => true, ], ], ], 'UpdateFirewallRuleGroupAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'UpdateFirewallRuleRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', 'FirewallDomainListId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Action' => [ 'shape' => 'Action', 'box' => true, ], 'BlockResponse' => [ 'shape' => 'BlockResponse', 'box' => true, ], 'BlockOverrideDomain' => [ 'shape' => 'BlockOverrideDomain', 'box' => true, ], 'BlockOverrideDnsType' => [ 'shape' => 'BlockOverrideDnsType', 'box' => true, ], 'BlockOverrideTtl' => [ 'shape' => 'BlockOverrideTtl', 'box' => true, ], 'Name' => [ 'shape' => 'Name', 'box' => true, ], 'Qtype' => [ 'shape' => 'Qtype', ], ], ], 'UpdateFirewallRuleResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRule' => [ 'shape' => 'FirewallRule', ], ], ], 'UpdateIpAddress' => [ 'type' => 'structure', 'required' => [ 'IpId', 'Ipv6', ], 'members' => [ 'IpId' => [ 'shape' => 'ResourceId', ], 'Ipv6' => [ 'shape' => 'Ipv6', ], ], ], 'UpdateIpAddresses' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateIpAddress', ], 'max' => 50, 'min' => 0, ], 'UpdateOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'OutpostResolverName', 'box' => true, ], 'InstanceCount' => [ 'shape' => 'InstanceCount', 'box' => true, ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', 'box' => true, ], ], ], 'UpdateOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'UpdateResolverConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'AutodefinedReverseFlag', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'AutodefinedReverseFlag' => [ 'shape' => 'AutodefinedReverseFlag', ], ], ], 'UpdateResolverConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverConfig' => [ 'shape' => 'ResolverConfig', ], ], ], 'UpdateResolverDnssecConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'Validation', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Validation' => [ 'shape' => 'Validation', ], ], ], 'UpdateResolverDnssecConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverDNSSECConfig' => [ 'shape' => 'ResolverDnssecConfig', ], ], ], 'UpdateResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', 'box' => true, ], 'ResolverEndpointType' => [ 'shape' => 'ResolverEndpointType', 'box' => true, ], 'UpdateIpAddresses' => [ 'shape' => 'UpdateIpAddresses', 'box' => true, ], 'Protocols' => [ 'shape' => 'ProtocolList', 'box' => true, ], ], ], 'UpdateResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'UpdateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', 'Config', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], 'Config' => [ 'shape' => 'ResolverRuleConfig', ], ], ], 'UpdateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'Validation' => [ 'type' => 'string', 'enum' => [ 'ENABLE', 'DISABLE', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-04-01', 'endpointPrefix' => 'route53resolver', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'Route53Resolver', 'serviceFullName' => 'Amazon Route 53 Resolver', 'serviceId' => 'Route53Resolver', 'signatureVersion' => 'v4', 'targetPrefix' => 'Route53Resolver', 'uid' => 'route53resolver-2018-04-01', ], 'operations' => [ 'AssociateFirewallRuleGroup' => [ 'name' => 'AssociateFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'AssociateFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateResolverEndpointIpAddress' => [ 'name' => 'AssociateResolverEndpointIpAddress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateResolverEndpointIpAddressRequest', ], 'output' => [ 'shape' => 'AssociateResolverEndpointIpAddressResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateResolverQueryLogConfig' => [ 'name' => 'AssociateResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'AssociateResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'AssociateResolverRule' => [ 'name' => 'AssociateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateResolverRuleRequest', ], 'output' => [ 'shape' => 'AssociateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateFirewallDomainList' => [ 'name' => 'CreateFirewallDomainList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFirewallDomainListRequest', ], 'output' => [ 'shape' => 'CreateFirewallDomainListResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateFirewallRule' => [ 'name' => 'CreateFirewallRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFirewallRuleRequest', ], 'output' => [ 'shape' => 'CreateFirewallRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateFirewallRuleGroup' => [ 'name' => 'CreateFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'CreateFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateOutpostResolver' => [ 'name' => 'CreateOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOutpostResolverRequest', ], 'output' => [ 'shape' => 'CreateOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateResolverEndpoint' => [ 'name' => 'CreateResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResolverEndpointRequest', ], 'output' => [ 'shape' => 'CreateResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateResolverQueryLogConfig' => [ 'name' => 'CreateResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'CreateResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateResolverRule' => [ 'name' => 'CreateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResolverRuleRequest', ], 'output' => [ 'shape' => 'CreateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteFirewallDomainList' => [ 'name' => 'DeleteFirewallDomainList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallDomainListRequest', ], 'output' => [ 'shape' => 'DeleteFirewallDomainListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteFirewallRule' => [ 'name' => 'DeleteFirewallRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallRuleRequest', ], 'output' => [ 'shape' => 'DeleteFirewallRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteFirewallRuleGroup' => [ 'name' => 'DeleteFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'DeleteFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteOutpostResolver' => [ 'name' => 'DeleteOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOutpostResolverRequest', ], 'output' => [ 'shape' => 'DeleteOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteResolverEndpoint' => [ 'name' => 'DeleteResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResolverEndpointRequest', ], 'output' => [ 'shape' => 'DeleteResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteResolverQueryLogConfig' => [ 'name' => 'DeleteResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'DeleteResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteResolverRule' => [ 'name' => 'DeleteResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResolverRuleRequest', ], 'output' => [ 'shape' => 'DeleteResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateFirewallRuleGroup' => [ 'name' => 'DisassociateFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'DisassociateFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateResolverEndpointIpAddress' => [ 'name' => 'DisassociateResolverEndpointIpAddress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateResolverEndpointIpAddressRequest', ], 'output' => [ 'shape' => 'DisassociateResolverEndpointIpAddressResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateResolverQueryLogConfig' => [ 'name' => 'DisassociateResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'DisassociateResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DisassociateResolverRule' => [ 'name' => 'DisassociateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateResolverRuleRequest', ], 'output' => [ 'shape' => 'DisassociateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallConfig' => [ 'name' => 'GetFirewallConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallConfigRequest', ], 'output' => [ 'shape' => 'GetFirewallConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetFirewallDomainList' => [ 'name' => 'GetFirewallDomainList', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallDomainListRequest', ], 'output' => [ 'shape' => 'GetFirewallDomainListResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallRuleGroup' => [ 'name' => 'GetFirewallRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallRuleGroupRequest', ], 'output' => [ 'shape' => 'GetFirewallRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallRuleGroupAssociation' => [ 'name' => 'GetFirewallRuleGroupAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallRuleGroupAssociationRequest', ], 'output' => [ 'shape' => 'GetFirewallRuleGroupAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetFirewallRuleGroupPolicy' => [ 'name' => 'GetFirewallRuleGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetFirewallRuleGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetFirewallRuleGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetOutpostResolver' => [ 'name' => 'GetOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOutpostResolverRequest', ], 'output' => [ 'shape' => 'GetOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetResolverConfig' => [ 'name' => 'GetResolverConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverConfigRequest', ], 'output' => [ 'shape' => 'GetResolverConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetResolverDnssecConfig' => [ 'name' => 'GetResolverDnssecConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverDnssecConfigRequest', ], 'output' => [ 'shape' => 'GetResolverDnssecConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverEndpoint' => [ 'name' => 'GetResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverEndpointRequest', ], 'output' => [ 'shape' => 'GetResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetResolverQueryLogConfig' => [ 'name' => 'GetResolverQueryLogConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverQueryLogConfigRequest', ], 'output' => [ 'shape' => 'GetResolverQueryLogConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverQueryLogConfigAssociation' => [ 'name' => 'GetResolverQueryLogConfigAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverQueryLogConfigAssociationRequest', ], 'output' => [ 'shape' => 'GetResolverQueryLogConfigAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverQueryLogConfigPolicy' => [ 'name' => 'GetResolverQueryLogConfigPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverQueryLogConfigPolicyRequest', ], 'output' => [ 'shape' => 'GetResolverQueryLogConfigPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetResolverRule' => [ 'name' => 'GetResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverRuleRequest', ], 'output' => [ 'shape' => 'GetResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetResolverRuleAssociation' => [ 'name' => 'GetResolverRuleAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverRuleAssociationRequest', ], 'output' => [ 'shape' => 'GetResolverRuleAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetResolverRulePolicy' => [ 'name' => 'GetResolverRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResolverRulePolicyRequest', ], 'output' => [ 'shape' => 'GetResolverRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ImportFirewallDomains' => [ 'name' => 'ImportFirewallDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportFirewallDomainsRequest', ], 'output' => [ 'shape' => 'ImportFirewallDomainsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallConfigs' => [ 'name' => 'ListFirewallConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallConfigsRequest', ], 'output' => [ 'shape' => 'ListFirewallConfigsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallDomainLists' => [ 'name' => 'ListFirewallDomainLists', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallDomainListsRequest', ], 'output' => [ 'shape' => 'ListFirewallDomainListsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallDomains' => [ 'name' => 'ListFirewallDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallDomainsRequest', ], 'output' => [ 'shape' => 'ListFirewallDomainsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallRuleGroupAssociations' => [ 'name' => 'ListFirewallRuleGroupAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallRuleGroupAssociationsRequest', ], 'output' => [ 'shape' => 'ListFirewallRuleGroupAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallRuleGroups' => [ 'name' => 'ListFirewallRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallRuleGroupsRequest', ], 'output' => [ 'shape' => 'ListFirewallRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListFirewallRules' => [ 'name' => 'ListFirewallRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFirewallRulesRequest', ], 'output' => [ 'shape' => 'ListFirewallRulesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListOutpostResolvers' => [ 'name' => 'ListOutpostResolvers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOutpostResolversRequest', ], 'output' => [ 'shape' => 'ListOutpostResolversResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListResolverConfigs' => [ 'name' => 'ListResolverConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverConfigsRequest', ], 'output' => [ 'shape' => 'ListResolverConfigsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListResolverDnssecConfigs' => [ 'name' => 'ListResolverDnssecConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverDnssecConfigsRequest', ], 'output' => [ 'shape' => 'ListResolverDnssecConfigsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResolverEndpointIpAddresses' => [ 'name' => 'ListResolverEndpointIpAddresses', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverEndpointIpAddressesRequest', ], 'output' => [ 'shape' => 'ListResolverEndpointIpAddressesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListResolverEndpoints' => [ 'name' => 'ListResolverEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverEndpointsRequest', ], 'output' => [ 'shape' => 'ListResolverEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListResolverQueryLogConfigAssociations' => [ 'name' => 'ListResolverQueryLogConfigAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverQueryLogConfigAssociationsRequest', ], 'output' => [ 'shape' => 'ListResolverQueryLogConfigAssociationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResolverQueryLogConfigs' => [ 'name' => 'ListResolverQueryLogConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverQueryLogConfigsRequest', ], 'output' => [ 'shape' => 'ListResolverQueryLogConfigsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListResolverRuleAssociations' => [ 'name' => 'ListResolverRuleAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverRuleAssociationsRequest', ], 'output' => [ 'shape' => 'ListResolverRuleAssociationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListResolverRules' => [ 'name' => 'ListResolverRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResolverRulesRequest', ], 'output' => [ 'shape' => 'ListResolverRulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'PutFirewallRuleGroupPolicy' => [ 'name' => 'PutFirewallRuleGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutFirewallRuleGroupPolicyRequest', ], 'output' => [ 'shape' => 'PutFirewallRuleGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'PutResolverQueryLogConfigPolicy' => [ 'name' => 'PutResolverQueryLogConfigPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResolverQueryLogConfigPolicyRequest', ], 'output' => [ 'shape' => 'PutResolverQueryLogConfigPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidPolicyDocument', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'PutResolverRulePolicy' => [ 'name' => 'PutResolverRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResolverRulePolicyRequest', ], 'output' => [ 'shape' => 'PutResolverRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidPolicyDocument', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'UnknownResourceException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidTagException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallConfig' => [ 'name' => 'UpdateFirewallConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallConfigRequest', ], 'output' => [ 'shape' => 'UpdateFirewallConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallDomains' => [ 'name' => 'UpdateFirewallDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallDomainsRequest', ], 'output' => [ 'shape' => 'UpdateFirewallDomainsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallRule' => [ 'name' => 'UpdateFirewallRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallRuleRequest', ], 'output' => [ 'shape' => 'UpdateFirewallRuleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateFirewallRuleGroupAssociation' => [ 'name' => 'UpdateFirewallRuleGroupAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFirewallRuleGroupAssociationRequest', ], 'output' => [ 'shape' => 'UpdateFirewallRuleGroupAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateOutpostResolver' => [ 'name' => 'UpdateOutpostResolver', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateOutpostResolverRequest', ], 'output' => [ 'shape' => 'UpdateOutpostResolverResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateResolverConfig' => [ 'name' => 'UpdateResolverConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverConfigRequest', ], 'output' => [ 'shape' => 'UpdateResolverConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateResolverDnssecConfig' => [ 'name' => 'UpdateResolverDnssecConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverDnssecConfigRequest', ], 'output' => [ 'shape' => 'UpdateResolverDnssecConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateResolverEndpoint' => [ 'name' => 'UpdateResolverEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverEndpointRequest', ], 'output' => [ 'shape' => 'UpdateResolverEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateResolverRule' => [ 'name' => 'UpdateResolverRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResolverRuleRequest', ], 'output' => [ 'shape' => 'UpdateResolverRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceUnavailableException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 32, 'min' => 12, ], 'Action' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', 'ALERT', ], ], 'Arn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'AssociateFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'FirewallRuleGroupId', 'VpcId', 'Priority', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', ], 'Name' => [ 'shape' => 'Name', ], 'MutationProtection' => [ 'shape' => 'MutationProtectionStatus', 'box' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'AssociateFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'AssociateResolverEndpointIpAddressRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', 'IpAddress', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'IpAddress' => [ 'shape' => 'IpAddressUpdate', ], ], ], 'AssociateResolverEndpointIpAddressResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'AssociateResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', 'ResourceId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'AssociateResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigAssociation' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], ], 'AssociateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', 'VPCId', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'VPCId' => [ 'shape' => 'ResourceId', ], ], ], 'AssociateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRuleAssociation' => [ 'shape' => 'ResolverRuleAssociation', ], ], ], 'AutodefinedReverseFlag' => [ 'type' => 'string', 'enum' => [ 'ENABLE', 'DISABLE', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'BlockOverrideDnsType' => [ 'type' => 'string', 'enum' => [ 'CNAME', ], ], 'BlockOverrideDomain' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'BlockOverrideTtl' => [ 'type' => 'integer', 'max' => 604800, 'min' => 0, ], 'BlockResponse' => [ 'type' => 'string', 'enum' => [ 'NODATA', 'NXDOMAIN', 'OVERRIDE', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'Count' => [ 'type' => 'integer', ], 'CreateFirewallDomainListRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'Name' => [ 'shape' => 'Name', ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateFirewallDomainListResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallDomainList' => [ 'shape' => 'FirewallDomainList', ], ], ], 'CreateFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'Name' => [ 'shape' => 'Name', ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroup' => [ 'shape' => 'FirewallRuleGroup', ], ], ], 'CreateFirewallRuleRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'FirewallRuleGroupId', 'FirewallDomainListId', 'Priority', 'Action', 'Name', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', ], 'Action' => [ 'shape' => 'Action', ], 'BlockResponse' => [ 'shape' => 'BlockResponse', 'box' => true, ], 'BlockOverrideDomain' => [ 'shape' => 'BlockOverrideDomain', 'box' => true, ], 'BlockOverrideDnsType' => [ 'shape' => 'BlockOverrideDnsType', 'box' => true, ], 'BlockOverrideTtl' => [ 'shape' => 'BlockOverrideTtl', 'box' => true, ], 'Name' => [ 'shape' => 'Name', ], 'FirewallDomainRedirectionAction' => [ 'shape' => 'FirewallDomainRedirectionAction', 'box' => true, ], 'Qtype' => [ 'shape' => 'Qtype', 'box' => true, ], ], ], 'CreateFirewallRuleResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRule' => [ 'shape' => 'FirewallRule', ], ], ], 'CreateOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'Name', 'PreferredInstanceType', 'OutpostArn', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Name' => [ 'shape' => 'OutpostResolverName', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', 'box' => true, ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'CreateResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'SecurityGroupIds', 'Direction', 'IpAddresses', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Name' => [ 'shape' => 'Name', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', 'box' => true, ], 'Direction' => [ 'shape' => 'ResolverEndpointDirection', ], 'IpAddresses' => [ 'shape' => 'IpAddressesRequest', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', 'box' => true, ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', 'box' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], 'ResolverEndpointType' => [ 'shape' => 'ResolverEndpointType', 'box' => true, ], 'Protocols' => [ 'shape' => 'ProtocolList', 'box' => true, ], ], ], 'CreateResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'CreateResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'DestinationArn', 'CreatorRequestId', ], 'members' => [ 'Name' => [ 'shape' => 'ResolverQueryLogConfigName', ], 'DestinationArn' => [ 'shape' => 'DestinationArn', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', 'idempotencyToken' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfig' => [ 'shape' => 'ResolverQueryLogConfig', ], ], ], 'CreateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'CreatorRequestId', 'RuleType', ], 'members' => [ 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Name' => [ 'shape' => 'Name', ], 'RuleType' => [ 'shape' => 'RuleTypeOption', ], 'DomainName' => [ 'shape' => 'DomainName', 'box' => true, ], 'TargetIps' => [ 'shape' => 'TargetList', 'box' => true, ], 'ResolverEndpointId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'Tags' => [ 'shape' => 'TagList', 'box' => true, ], ], ], 'CreateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'CreatorRequestId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'DeleteFirewallDomainListRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteFirewallDomainListResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallDomainList' => [ 'shape' => 'FirewallDomainList', ], ], ], 'DeleteFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroup' => [ 'shape' => 'FirewallRuleGroup', ], ], ], 'DeleteFirewallRuleRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', 'FirewallDomainListId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Qtype' => [ 'shape' => 'Qtype', ], ], ], 'DeleteFirewallRuleResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRule' => [ 'shape' => 'FirewallRule', ], ], ], 'DeleteOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'DeleteResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'DeleteResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfig' => [ 'shape' => 'ResolverQueryLogConfig', ], ], ], 'DeleteResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'DestinationArn' => [ 'type' => 'string', 'max' => 600, 'min' => 1, ], 'DisassociateFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupAssociationId', ], 'members' => [ 'FirewallRuleGroupAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'DisassociateFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'DisassociateResolverEndpointIpAddressRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', 'IpAddress', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'IpAddress' => [ 'shape' => 'IpAddressUpdate', ], ], ], 'DisassociateResolverEndpointIpAddressResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'DisassociateResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', 'ResourceId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'DisassociateResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigAssociation' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], ], 'DisassociateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'VPCId', 'ResolverRuleId', ], 'members' => [ 'VPCId' => [ 'shape' => 'ResourceId', ], 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], ], ], 'DisassociateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRuleAssociation' => [ 'shape' => 'ResolverRuleAssociation', ], ], ], 'DomainListFileUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'DomainName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ExceptionMessage' => [ 'type' => 'string', ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FilterName', ], 'Values' => [ 'shape' => 'FilterValues', ], ], ], 'FilterName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 600, 'min' => 1, ], 'FilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'FirewallConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'FirewallFailOpen' => [ 'shape' => 'FirewallFailOpenStatus', ], ], ], 'FirewallConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallConfig', ], ], 'FirewallDomainImportOperation' => [ 'type' => 'string', 'enum' => [ 'REPLACE', ], ], 'FirewallDomainList' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'DomainCount' => [ 'shape' => 'Unsigned', ], 'Status' => [ 'shape' => 'FirewallDomainListStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'ManagedOwnerName' => [ 'shape' => 'ServicePrinciple', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'FirewallDomainListMetadata' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'ManagedOwnerName' => [ 'shape' => 'ServicePrinciple', ], ], ], 'FirewallDomainListMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallDomainListMetadata', ], ], 'FirewallDomainListStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'COMPLETE_IMPORT_FAILED', 'IMPORTING', 'DELETING', 'UPDATING', ], ], 'FirewallDomainName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'FirewallDomainRedirectionAction' => [ 'type' => 'string', 'enum' => [ 'INSPECT_REDIRECTION_DOMAIN', 'TRUST_REDIRECTION_DOMAIN', ], ], 'FirewallDomainUpdateOperation' => [ 'type' => 'string', 'enum' => [ 'ADD', 'REMOVE', 'REPLACE', ], ], 'FirewallDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallDomainName', ], ], 'FirewallFailOpenStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'FirewallRule' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Priority' => [ 'shape' => 'Priority', ], 'Action' => [ 'shape' => 'Action', ], 'BlockResponse' => [ 'shape' => 'BlockResponse', ], 'BlockOverrideDomain' => [ 'shape' => 'BlockOverrideDomain', ], 'BlockOverrideDnsType' => [ 'shape' => 'BlockOverrideDnsType', ], 'BlockOverrideTtl' => [ 'shape' => 'Unsigned', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'FirewallDomainRedirectionAction' => [ 'shape' => 'FirewallDomainRedirectionAction', ], 'Qtype' => [ 'shape' => 'Qtype', ], ], ], 'FirewallRuleGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'RuleCount' => [ 'shape' => 'Unsigned', ], 'Status' => [ 'shape' => 'FirewallRuleGroupStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'FirewallRuleGroupAssociation' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'VpcId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Priority' => [ 'shape' => 'Priority', ], 'MutationProtection' => [ 'shape' => 'MutationProtectionStatus', ], 'ManagedOwnerName' => [ 'shape' => 'ServicePrinciple', ], 'Status' => [ 'shape' => 'FirewallRuleGroupAssociationStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'FirewallRuleGroupAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'DELETING', 'UPDATING', ], ], 'FirewallRuleGroupAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], 'FirewallRuleGroupMetadata' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], ], ], 'FirewallRuleGroupMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallRuleGroupMetadata', ], ], 'FirewallRuleGroupPolicy' => [ 'type' => 'string', 'max' => 30000, ], 'FirewallRuleGroupStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'DELETING', 'UPDATING', ], ], 'FirewallRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallRule', ], ], 'GetFirewallConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallConfigResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallConfig' => [ 'shape' => 'FirewallConfig', ], ], ], 'GetFirewallDomainListRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallDomainListResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallDomainList' => [ 'shape' => 'FirewallDomainList', ], ], ], 'GetFirewallRuleGroupAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupAssociationId', ], 'members' => [ 'FirewallRuleGroupAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallRuleGroupAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'GetFirewallRuleGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'GetFirewallRuleGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupPolicy' => [ 'shape' => 'FirewallRuleGroupPolicy', ], ], ], 'GetFirewallRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], ], ], 'GetFirewallRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroup' => [ 'shape' => 'FirewallRuleGroup', ], ], ], 'GetOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], ], ], 'GetOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'GetResolverConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverConfig' => [ 'shape' => 'ResolverConfig', ], ], ], 'GetResolverDnssecConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverDnssecConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverDNSSECConfig' => [ 'shape' => 'ResolverDnssecConfig', ], ], ], 'GetResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'GetResolverQueryLogConfigAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigAssociationId', ], 'members' => [ 'ResolverQueryLogConfigAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverQueryLogConfigAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigAssociation' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], ], 'GetResolverQueryLogConfigPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'GetResolverQueryLogConfigPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfigPolicy' => [ 'shape' => 'ResolverQueryLogConfigPolicy', ], ], ], 'GetResolverQueryLogConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverQueryLogConfigId', ], 'members' => [ 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverQueryLogConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverQueryLogConfig' => [ 'shape' => 'ResolverQueryLogConfig', ], ], ], 'GetResolverRuleAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleAssociationId', ], 'members' => [ 'ResolverRuleAssociationId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverRuleAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRuleAssociation' => [ 'shape' => 'ResolverRuleAssociation', ], ], ], 'GetResolverRulePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'GetResolverRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRulePolicy' => [ 'shape' => 'ResolverRulePolicy', ], ], ], 'GetResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], ], ], 'GetResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'ImportFirewallDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', 'Operation', 'DomainFileUrl', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Operation' => [ 'shape' => 'FirewallDomainImportOperation', ], 'DomainFileUrl' => [ 'shape' => 'DomainListFileUrl', ], ], ], 'ImportFirewallDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Status' => [ 'shape' => 'FirewallDomainListStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'InstanceCount' => [ 'type' => 'integer', ], 'InternalServiceErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], 'FieldName' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidPolicyDocument' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'InvalidTagException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'Ip' => [ 'type' => 'string', 'max' => 36, 'min' => 7, ], 'IpAddressCount' => [ 'type' => 'integer', ], 'IpAddressRequest' => [ 'type' => 'structure', 'required' => [ 'SubnetId', ], 'members' => [ 'SubnetId' => [ 'shape' => 'SubnetId', ], 'Ip' => [ 'shape' => 'Ip', 'box' => true, ], 'Ipv6' => [ 'shape' => 'Ipv6', 'box' => true, ], ], ], 'IpAddressResponse' => [ 'type' => 'structure', 'members' => [ 'IpId' => [ 'shape' => 'ResourceId', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'Ip' => [ 'shape' => 'Ip', ], 'Ipv6' => [ 'shape' => 'Ipv6', ], 'Status' => [ 'shape' => 'IpAddressStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'IpAddressStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'FAILED_CREATION', 'ATTACHING', 'ATTACHED', 'REMAP_DETACHING', 'REMAP_ATTACHING', 'DETACHING', 'FAILED_RESOURCE_GONE', 'DELETING', 'DELETE_FAILED_FAS_EXPIRED', 'UPDATING', 'UPDATE_FAILED', ], ], 'IpAddressUpdate' => [ 'type' => 'structure', 'members' => [ 'IpId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'SubnetId' => [ 'shape' => 'SubnetId', 'box' => true, ], 'Ip' => [ 'shape' => 'Ip', 'box' => true, ], 'Ipv6' => [ 'shape' => 'Ipv6', 'box' => true, ], ], ], 'IpAddressesRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpAddressRequest', ], 'max' => 20, 'min' => 2, ], 'IpAddressesResponse' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpAddressResponse', ], ], 'Ipv6' => [ 'type' => 'string', 'max' => 39, 'min' => 7, ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ListDomainMaxResults' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'ListFirewallConfigsMaxResult' => [ 'type' => 'integer', 'max' => 10, 'min' => 5, ], 'ListFirewallConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'ListFirewallConfigsMaxResult', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallConfigs' => [ 'shape' => 'FirewallConfigList', ], ], ], 'ListFirewallDomainListsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallDomainListsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallDomainLists' => [ 'shape' => 'FirewallDomainListMetadataList', ], ], ], 'ListFirewallDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'MaxResults' => [ 'shape' => 'ListDomainMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'Domains' => [ 'shape' => 'FirewallDomains', ], ], ], 'ListFirewallRuleGroupAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'VpcId' => [ 'shape' => 'ResourceId', 'box' => true, ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Status' => [ 'shape' => 'FirewallRuleGroupAssociationStatus', 'box' => true, ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallRuleGroupAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallRuleGroupAssociations' => [ 'shape' => 'FirewallRuleGroupAssociations', ], ], ], 'ListFirewallRuleGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallRuleGroups' => [ 'shape' => 'FirewallRuleGroupMetadataList', ], ], ], 'ListFirewallRulesRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Action' => [ 'shape' => 'Action', 'box' => true, ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListFirewallRulesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'FirewallRules' => [ 'shape' => 'FirewallRules', ], ], ], 'ListOutpostResolversRequest' => [ 'type' => 'structure', 'members' => [ 'OutpostArn' => [ 'shape' => 'OutpostArn', 'box' => true, ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListOutpostResolversResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolvers' => [ 'shape' => 'OutpostResolverList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResolverConfigsMaxResult' => [ 'type' => 'integer', 'max' => 100, 'min' => 5, ], 'ListResolverConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'ListResolverConfigsMaxResult', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListResolverConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ResolverConfigs' => [ 'shape' => 'ResolverConfigList', ], ], ], 'ListResolverDnssecConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverDnssecConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ResolverDnssecConfigs' => [ 'shape' => 'ResolverDnssecConfigList', ], ], ], 'ListResolverEndpointIpAddressesRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListResolverEndpointIpAddressesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'IpAddresses' => [ 'shape' => 'IpAddressesResponse', ], ], ], 'ListResolverEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverEndpointsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResolverEndpoints' => [ 'shape' => 'ResolverEndpoints', ], ], ], 'ListResolverQueryLogConfigAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'Filters' => [ 'shape' => 'Filters', ], 'SortBy' => [ 'shape' => 'SortByKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListResolverQueryLogConfigAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TotalCount' => [ 'shape' => 'Count', ], 'TotalFilteredCount' => [ 'shape' => 'Count', ], 'ResolverQueryLogConfigAssociations' => [ 'shape' => 'ResolverQueryLogConfigAssociationList', ], ], ], 'ListResolverQueryLogConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], 'SortBy' => [ 'shape' => 'SortByKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListResolverQueryLogConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TotalCount' => [ 'shape' => 'Count', ], 'TotalFilteredCount' => [ 'shape' => 'Count', ], 'ResolverQueryLogConfigs' => [ 'shape' => 'ResolverQueryLogConfigList', ], ], ], 'ListResolverRuleAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverRuleAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResolverRuleAssociations' => [ 'shape' => 'ResolverRuleAssociations', ], ], ], 'ListResolverRulesRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], 'Filters' => [ 'shape' => 'Filters', 'box' => true, ], ], ], 'ListResolverRulesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResolverRules' => [ 'shape' => 'ResolverRules', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', 'box' => true, ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MutationProtectionStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'Name' => [ 'type' => 'string', 'max' => 64, 'pattern' => '(?!^[0-9]+$)([a-zA-Z0-9\\-_\' \']+)', ], 'NextToken' => [ 'type' => 'string', ], 'OutpostArn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$', ], 'OutpostInstanceType' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'OutpostResolver' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Id' => [ 'shape' => 'ResourceId', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', ], 'Name' => [ 'shape' => 'OutpostResolverName', ], 'Status' => [ 'shape' => 'OutpostResolverStatus', ], 'StatusMessage' => [ 'shape' => 'OutpostResolverStatusMessage', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', ], ], ], 'OutpostResolverList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutpostResolver', ], ], 'OutpostResolverName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'OutpostResolverStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'OPERATIONAL', 'UPDATING', 'DELETING', 'ACTION_NEEDED', 'FAILED_CREATION', 'FAILED_DELETION', ], ], 'OutpostResolverStatusMessage' => [ 'type' => 'string', 'max' => 4096, ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'Priority' => [ 'type' => 'integer', ], 'Protocol' => [ 'type' => 'string', 'enum' => [ 'DoH', 'Do53', 'DoH-FIPS', ], ], 'ProtocolList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Protocol', ], 'max' => 2, 'min' => 1, ], 'PutFirewallRuleGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'FirewallRuleGroupPolicy', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'FirewallRuleGroupPolicy' => [ 'shape' => 'FirewallRuleGroupPolicy', ], ], ], 'PutFirewallRuleGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ReturnValue' => [ 'shape' => 'Boolean', ], ], ], 'PutResolverQueryLogConfigPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'ResolverQueryLogConfigPolicy', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'ResolverQueryLogConfigPolicy' => [ 'shape' => 'ResolverQueryLogConfigPolicy', ], ], ], 'PutResolverQueryLogConfigPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ReturnValue' => [ 'shape' => 'Boolean', ], ], ], 'PutResolverRulePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'ResolverRulePolicy', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'ResolverRulePolicy' => [ 'shape' => 'ResolverRulePolicy', ], ], ], 'PutResolverRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ReturnValue' => [ 'shape' => 'Boolean', ], ], ], 'Qtype' => [ 'type' => 'string', 'max' => 16, 'min' => 1, ], 'ResolverAutodefinedReverseStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLING', 'ENABLED', 'DISABLING', 'DISABLED', 'UPDATING_TO_USE_LOCAL_RESOURCE_SETTING', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'ResolverConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'AutodefinedReverse' => [ 'shape' => 'ResolverAutodefinedReverseStatus', ], ], ], 'ResolverConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverConfig', ], ], 'ResolverDNSSECValidationStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLING', 'ENABLED', 'DISABLING', 'DISABLED', 'UPDATING_TO_USE_LOCAL_RESOURCE_SETTING', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'ResolverDnssecConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ValidationStatus' => [ 'shape' => 'ResolverDNSSECValidationStatus', ], ], ], 'ResolverDnssecConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverDnssecConfig', ], ], 'ResolverEndpoint' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Name', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'Direction' => [ 'shape' => 'ResolverEndpointDirection', ], 'IpAddressCount' => [ 'shape' => 'IpAddressCount', ], 'HostVPCId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'ResolverEndpointStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'OutpostArn' => [ 'shape' => 'OutpostArn', ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', ], 'ResolverEndpointType' => [ 'shape' => 'ResolverEndpointType', ], 'Protocols' => [ 'shape' => 'ProtocolList', ], ], ], 'ResolverEndpointDirection' => [ 'type' => 'string', 'enum' => [ 'INBOUND', 'OUTBOUND', ], ], 'ResolverEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'OPERATIONAL', 'UPDATING', 'AUTO_RECOVERING', 'ACTION_NEEDED', 'DELETING', ], ], 'ResolverEndpointType' => [ 'type' => 'string', 'enum' => [ 'IPV6', 'IPV4', 'DUALSTACK', ], ], 'ResolverEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverEndpoint', ], ], 'ResolverQueryLogConfig' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'Status' => [ 'shape' => 'ResolverQueryLogConfigStatus', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], 'AssociationCount' => [ 'shape' => 'Count', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ResolverQueryLogConfigName', ], 'DestinationArn' => [ 'shape' => 'DestinationArn', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'ResolverQueryLogConfigAssociation' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResolverQueryLogConfigId' => [ 'shape' => 'ResourceId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'ResolverQueryLogConfigAssociationStatus', ], 'Error' => [ 'shape' => 'ResolverQueryLogConfigAssociationError', ], 'ErrorMessage' => [ 'shape' => 'ResolverQueryLogConfigAssociationErrorMessage', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'ResolverQueryLogConfigAssociationError' => [ 'type' => 'string', 'enum' => [ 'NONE', 'DESTINATION_NOT_FOUND', 'ACCESS_DENIED', 'INTERNAL_SERVICE_ERROR', ], ], 'ResolverQueryLogConfigAssociationErrorMessage' => [ 'type' => 'string', ], 'ResolverQueryLogConfigAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverQueryLogConfigAssociation', ], ], 'ResolverQueryLogConfigAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'ACTION_NEEDED', 'DELETING', 'FAILED', ], ], 'ResolverQueryLogConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverQueryLogConfig', ], ], 'ResolverQueryLogConfigName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '(?!^[0-9]+$)([a-zA-Z0-9\\-_\' \']+)', ], 'ResolverQueryLogConfigPolicy' => [ 'type' => 'string', 'max' => 30000, ], 'ResolverQueryLogConfigStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'DELETING', 'FAILED', ], ], 'ResolverRule' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'CreatorRequestId' => [ 'shape' => 'CreatorRequestId', ], 'Arn' => [ 'shape' => 'Arn', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'ResolverRuleStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], 'RuleType' => [ 'shape' => 'RuleTypeOption', ], 'Name' => [ 'shape' => 'Name', ], 'TargetIps' => [ 'shape' => 'TargetList', ], 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'OwnerId' => [ 'shape' => 'AccountId', ], 'ShareStatus' => [ 'shape' => 'ShareStatus', ], 'CreationTime' => [ 'shape' => 'Rfc3339TimeString', ], 'ModificationTime' => [ 'shape' => 'Rfc3339TimeString', ], ], ], 'ResolverRuleAssociation' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'VPCId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'ResolverRuleAssociationStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'ResolverRuleAssociationStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'COMPLETE', 'DELETING', 'FAILED', 'OVERRIDDEN', ], ], 'ResolverRuleAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverRuleAssociation', ], ], 'ResolverRuleConfig' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'Name', ], 'TargetIps' => [ 'shape' => 'TargetList', ], 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], ], ], 'ResolverRulePolicy' => [ 'type' => 'string', 'max' => 30000, ], 'ResolverRuleStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'DELETING', 'UPDATING', 'FAILED', ], ], 'ResolverRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResolverRule', ], ], 'ResourceExistsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'Rfc3339TimeString' => [ 'type' => 'string', 'max' => 40, 'min' => 20, ], 'RuleTypeOption' => [ 'type' => 'string', 'enum' => [ 'FORWARD', 'SYSTEM', 'RECURSIVE', ], ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceId', ], ], 'ServicePrinciple' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'ShareStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_SHARED', 'SHARED_WITH_ME', 'SHARED_BY_ME', ], ], 'SortByKey' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'StatusMessage' => [ 'type' => 'string', 'max' => 255, ], 'String' => [ 'type' => 'string', ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TargetAddress' => [ 'type' => 'structure', 'members' => [ 'Ip' => [ 'shape' => 'Ip', 'box' => true, ], 'Port' => [ 'shape' => 'Port', 'box' => true, ], 'Ipv6' => [ 'shape' => 'Ipv6', 'box' => true, ], 'Protocol' => [ 'shape' => 'Protocol', 'box' => true, ], ], ], 'TargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetAddress', ], 'min' => 1, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'UnknownResourceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], 'Unsigned' => [ 'type' => 'integer', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateFirewallConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'FirewallFailOpen', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'FirewallFailOpen' => [ 'shape' => 'FirewallFailOpenStatus', ], ], ], 'UpdateFirewallConfigResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallConfig' => [ 'shape' => 'FirewallConfig', ], ], ], 'UpdateFirewallDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallDomainListId', 'Operation', 'Domains', ], 'members' => [ 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Operation' => [ 'shape' => 'FirewallDomainUpdateOperation', ], 'Domains' => [ 'shape' => 'FirewallDomains', ], ], ], 'UpdateFirewallDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', ], 'Status' => [ 'shape' => 'FirewallDomainListStatus', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'UpdateFirewallRuleGroupAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupAssociationId', ], 'members' => [ 'FirewallRuleGroupAssociationId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'MutationProtection' => [ 'shape' => 'MutationProtectionStatus', 'box' => true, ], 'Name' => [ 'shape' => 'Name', 'box' => true, ], ], ], 'UpdateFirewallRuleGroupAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRuleGroupAssociation' => [ 'shape' => 'FirewallRuleGroupAssociation', ], ], ], 'UpdateFirewallRuleRequest' => [ 'type' => 'structure', 'required' => [ 'FirewallRuleGroupId', 'FirewallDomainListId', ], 'members' => [ 'FirewallRuleGroupId' => [ 'shape' => 'ResourceId', ], 'FirewallDomainListId' => [ 'shape' => 'ResourceId', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Action' => [ 'shape' => 'Action', 'box' => true, ], 'BlockResponse' => [ 'shape' => 'BlockResponse', 'box' => true, ], 'BlockOverrideDomain' => [ 'shape' => 'BlockOverrideDomain', 'box' => true, ], 'BlockOverrideDnsType' => [ 'shape' => 'BlockOverrideDnsType', 'box' => true, ], 'BlockOverrideTtl' => [ 'shape' => 'BlockOverrideTtl', 'box' => true, ], 'Name' => [ 'shape' => 'Name', 'box' => true, ], 'FirewallDomainRedirectionAction' => [ 'shape' => 'FirewallDomainRedirectionAction', 'box' => true, ], 'Qtype' => [ 'shape' => 'Qtype', ], ], ], 'UpdateFirewallRuleResponse' => [ 'type' => 'structure', 'members' => [ 'FirewallRule' => [ 'shape' => 'FirewallRule', ], ], ], 'UpdateIpAddress' => [ 'type' => 'structure', 'required' => [ 'IpId', 'Ipv6', ], 'members' => [ 'IpId' => [ 'shape' => 'ResourceId', ], 'Ipv6' => [ 'shape' => 'Ipv6', ], ], ], 'UpdateIpAddresses' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateIpAddress', ], 'max' => 50, 'min' => 0, ], 'UpdateOutpostResolverRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'OutpostResolverName', 'box' => true, ], 'InstanceCount' => [ 'shape' => 'InstanceCount', 'box' => true, ], 'PreferredInstanceType' => [ 'shape' => 'OutpostInstanceType', 'box' => true, ], ], ], 'UpdateOutpostResolverResponse' => [ 'type' => 'structure', 'members' => [ 'OutpostResolver' => [ 'shape' => 'OutpostResolver', ], ], ], 'UpdateResolverConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'AutodefinedReverseFlag', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'AutodefinedReverseFlag' => [ 'shape' => 'AutodefinedReverseFlag', ], ], ], 'UpdateResolverConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverConfig' => [ 'shape' => 'ResolverConfig', ], ], ], 'UpdateResolverDnssecConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'Validation', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Validation' => [ 'shape' => 'Validation', ], ], ], 'UpdateResolverDnssecConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverDNSSECConfig' => [ 'shape' => 'ResolverDnssecConfig', ], ], ], 'UpdateResolverEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverEndpointId', ], 'members' => [ 'ResolverEndpointId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'Name', 'box' => true, ], 'ResolverEndpointType' => [ 'shape' => 'ResolverEndpointType', 'box' => true, ], 'UpdateIpAddresses' => [ 'shape' => 'UpdateIpAddresses', 'box' => true, ], 'Protocols' => [ 'shape' => 'ProtocolList', 'box' => true, ], ], ], 'UpdateResolverEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverEndpoint' => [ 'shape' => 'ResolverEndpoint', ], ], ], 'UpdateResolverRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ResolverRuleId', 'Config', ], 'members' => [ 'ResolverRuleId' => [ 'shape' => 'ResourceId', ], 'Config' => [ 'shape' => 'ResolverRuleConfig', ], ], ], 'UpdateResolverRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ResolverRule' => [ 'shape' => 'ResolverRule', ], ], ], 'Validation' => [ 'type' => 'string', 'enum' => [ 'ENABLE', 'DISABLE', 'USE_LOCAL_RESOURCE_SETTING', ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ExceptionMessage', ], ], 'exception' => true, ], ],]; diff --git a/src/data/route53resolver/2018-04-01/docs-2.json b/src/data/route53resolver/2018-04-01/docs-2.json index c76802eac0..6d28d0364f 100644 --- a/src/data/route53resolver/2018-04-01/docs-2.json +++ b/src/data/route53resolver/2018-04-01/docs-2.json @@ -73,7 +73,7 @@ }, "shapes": { "AccessDeniedException": { - "base": "

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

", + "base": "

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

", "refs": { } }, @@ -549,6 +549,14 @@ "FirewallDomains$member": null } }, + "FirewallDomainRedirectionAction": { + "base": null, + "refs": { + "CreateFirewallRuleRequest$FirewallDomainRedirectionAction": "

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.

Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.

Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain alloww list.

", + "FirewallRule$FirewallDomainRedirectionAction": "

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.

Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.

Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain alloww list.

", + "UpdateFirewallRuleRequest$FirewallDomainRedirectionAction": "

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.

Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.

Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain alloww list.

" + } + }, "FirewallDomainUpdateOperation": { "base": null, "refs": { @@ -1300,10 +1308,10 @@ "Qtype": { "base": null, "refs": { - "CreateFirewallRuleRequest$Qtype": "

The DNS query type you want the rule to evaluate. Allowed values are;

", - "DeleteFirewallRuleRequest$Qtype": "

The DNS query type that the rule you are deleting evaluates. Allowed values are;

", - "FirewallRule$Qtype": "

The DNS query type you want the rule to evaluate. Allowed values are;

", - "UpdateFirewallRuleRequest$Qtype": "

The DNS query type you want the rule to evaluate. Allowed values are;

" + "CreateFirewallRuleRequest$Qtype": "

The DNS query type you want the rule to evaluate. Allowed values are;

", + "DeleteFirewallRuleRequest$Qtype": "

The DNS query type that the rule you are deleting evaluates. Allowed values are;

", + "FirewallRule$Qtype": "

The DNS query type you want the rule to evaluate. Allowed values are;

", + "UpdateFirewallRuleRequest$Qtype": "

The DNS query type you want the rule to evaluate. Allowed values are;

" } }, "ResolverAutodefinedReverseStatus": { @@ -1653,7 +1661,7 @@ "SecurityGroupIds": { "base": null, "refs": { - "CreateResolverEndpointRequest$SecurityGroupIds": "

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

", + "CreateResolverEndpointRequest$SecurityGroupIds": "

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

Some security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the maximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. To avoid connection tracking caused by security group, see Untracked connections.

", "ResolverEndpoint$SecurityGroupIds": "

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

" } }, diff --git a/src/data/route53resolver/2018-04-01/docs-2.json.php b/src/data/route53resolver/2018-04-01/docs-2.json.php index f4e8d0a2ec..4893822aac 100644 --- a/src/data/route53resolver/2018-04-01/docs-2.json.php +++ b/src/data/route53resolver/2018-04-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or Elastic Load Balancing load balancers. Resolver performs recursive lookups against public name servers for all other domain names.

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

Forward DNS queries from resolvers on your network to Route 53 Resolver

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

Conditionally forward queries from a VPC to resolvers on your network

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.

', 'operations' => [ 'AssociateFirewallRuleGroup' => '

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

', 'AssociateResolverEndpointIpAddress' => '

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

', 'AssociateResolverQueryLogConfig' => '

Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.

The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.

', 'AssociateResolverRule' => '

Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.

', 'CreateFirewallDomainList' => '

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

', 'CreateFirewallRule' => '

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

', 'CreateFirewallRuleGroup' => '

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.

', 'CreateOutpostResolver' => '

Creates a Route 53 Resolver on an Outpost.

', 'CreateResolverEndpoint' => '

Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:

', 'CreateResolverQueryLogConfig' => '

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig.

You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.

', 'CreateResolverRule' => '

For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

', 'DeleteFirewallDomainList' => '

Deletes the specified domain list.

', 'DeleteFirewallRule' => '

Deletes the specified firewall rule.

', 'DeleteFirewallRuleGroup' => '

Deletes the specified firewall rule group.

', 'DeleteOutpostResolver' => '

Deletes a Resolver on the Outpost.

', 'DeleteResolverEndpoint' => '

Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it\'s an inbound or an outbound Resolver endpoint:

', 'DeleteResolverQueryLogConfig' => '

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that\'s not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.

', 'DeleteResolverRule' => '

Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see DisassociateResolverRule.

', 'DisassociateFirewallRuleGroup' => '

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

', 'DisassociateResolverEndpointIpAddress' => '

Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

', 'DisassociateResolverQueryLogConfig' => '

Disassociates a VPC from a query logging configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:

', 'DisassociateResolverRule' => '

Removes the association between a specified Resolver rule and a specified VPC.

If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the Resolver rule.

', 'GetFirewallConfig' => '

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

', 'GetFirewallDomainList' => '

Retrieves the specified firewall domain list.

', 'GetFirewallRuleGroup' => '

Retrieves the specified firewall rule group.

', 'GetFirewallRuleGroupAssociation' => '

Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.

', 'GetFirewallRuleGroupPolicy' => '

Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

', 'GetOutpostResolver' => '

Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.

', 'GetResolverConfig' => '

Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

', 'GetResolverDnssecConfig' => '

Gets DNSSEC validation information for a specified resource.

', 'GetResolverEndpoint' => '

Gets information about a specified Resolver endpoint, such as whether it\'s an inbound or an outbound Resolver endpoint, and the current status of the endpoint.

', 'GetResolverQueryLogConfig' => '

Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.

', 'GetResolverQueryLogConfigAssociation' => '

Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.

', 'GetResolverQueryLogConfigPolicy' => '

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another Amazon Web Services account to be able to use.

', 'GetResolverRule' => '

Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with.

', 'GetResolverRuleAssociation' => '

Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule.

', 'GetResolverRulePolicy' => '

Gets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use.

', 'ImportFirewallDomains' => '

Imports domain names from a file into a domain list, for use in a DNS firewall rule group.

Each domain specification in your domain list must satisfy the following requirements:

', 'ListFirewallConfigs' => '

Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.

A single call might return only a partial list of the configurations. For information, see MaxResults.

', 'ListFirewallDomainLists' => '

Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains.

A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.

', 'ListFirewallDomains' => '

Retrieves the domains that you have defined for the specified firewall domain list.

A single call might return only a partial list of the domains. For information, see MaxResults.

', 'ListFirewallRuleGroupAssociations' => '

Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.

A single call might return only a partial list of the associations. For information, see MaxResults.

', 'ListFirewallRuleGroups' => '

Retrieves the minimal high-level information for the rule groups that you have defined.

A single call might return only a partial list of the rule groups. For information, see MaxResults.

', 'ListFirewallRules' => '

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

', 'ListOutpostResolvers' => '

Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.

', 'ListResolverConfigs' => '

Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.

', 'ListResolverDnssecConfigs' => '

Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.

', 'ListResolverEndpointIpAddresses' => '

Gets the IP addresses for a specified Resolver endpoint.

', 'ListResolverEndpoints' => '

Lists all the Resolver endpoints that were created using the current Amazon Web Services account.

', 'ListResolverQueryLogConfigAssociations' => '

Lists information about associations between Amazon VPCs and query logging configurations.

', 'ListResolverQueryLogConfigs' => '

Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.

', 'ListResolverRuleAssociations' => '

Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.

', 'ListResolverRules' => '

Lists the Resolver rules that were created using the current Amazon Web Services account.

', 'ListTagsForResource' => '

Lists the tags that you associated with the specified resource.

', 'PutFirewallRuleGroupPolicy' => '

Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

', 'PutResolverQueryLogConfigPolicy' => '

Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.

', 'PutResolverRulePolicy' => '

Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.

', 'TagResource' => '

Adds one or more tags to a specified resource.

', 'UntagResource' => '

Removes one or more tags from a specified resource.

', 'UpdateFirewallConfig' => '

Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

', 'UpdateFirewallDomains' => '

Updates the firewall domain list from an array of domain specifications.

', 'UpdateFirewallRule' => '

Updates the specified firewall rule.

', 'UpdateFirewallRuleGroupAssociation' => '

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

', 'UpdateOutpostResolver' => '

You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.

', 'UpdateResolverConfig' => '

Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

', 'UpdateResolverDnssecConfig' => '

Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.

', 'UpdateResolverEndpoint' => '

Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can\'t be updated to other type.

', 'UpdateResolverRule' => '

Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don\'t specify a parameter, it retains its current value.

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

The current account doesn\'t have the IAM permissions required to perform the specified Resolver operation.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'FirewallConfig$OwnerId' => '

The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.

', 'FirewallRuleGroup$OwnerId' => '

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

', 'FirewallRuleGroupMetadata$OwnerId' => '

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

', 'ResolverConfig$OwnerId' => '

The owner account ID of the Amazon Virtual Private Cloud VPC.

', 'ResolverDnssecConfig$OwnerId' => '

The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.

', 'ResolverQueryLogConfig$OwnerId' => '

The Amazon Web Services account ID for the account that created the query logging configuration.

', 'ResolverRule$OwnerId' => '

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$Action' => '

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', 'FirewallRule$Action' => '

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', 'ListFirewallRulesRequest$Action' => '

Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', 'UpdateFirewallRuleRequest$Action' => '

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$Arn' => '

The Amazon Resource Name (ARN) of the firewall domain list.

', 'FirewallDomainListMetadata$Arn' => '

The Amazon Resource Name (ARN) of the firewall domain list metadata.

', 'FirewallRuleGroup$Arn' => '

The ARN (Amazon Resource Name) of the rule group.

', 'FirewallRuleGroupAssociation$Arn' => '

The Amazon Resource Name (ARN) of the firewall rule group association.

', 'FirewallRuleGroupMetadata$Arn' => '

The ARN (Amazon Resource Name) of the rule group.

', 'GetFirewallRuleGroupPolicyRequest$Arn' => '

The ARN (Amazon Resource Name) for the rule group.

', 'GetResolverQueryLogConfigPolicyRequest$Arn' => '

The ARN of the query logging configuration that you want to get the query logging policy for.

', 'GetResolverRulePolicyRequest$Arn' => '

The ID of the Resolver rule that you want to get the Resolver rule policy for.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) for the resource that you want to list tags for.

', 'OutpostResolver$Arn' => '

The ARN (Amazon Resource Name) for the Resolver on an Outpost.

', 'PutFirewallRuleGroupPolicyRequest$Arn' => '

The ARN (Amazon Resource Name) for the rule group that you want to share.

', 'PutResolverQueryLogConfigPolicyRequest$Arn' => '

The Amazon Resource Name (ARN) of the account that you want to share rules with.

', 'PutResolverRulePolicyRequest$Arn' => '

The Amazon Resource Name (ARN) of the rule that you want to share with another account.

', 'ResolverEndpoint$Arn' => '

The ARN (Amazon Resource Name) for the Resolver endpoint.

', 'ResolverQueryLogConfig$Arn' => '

The ARN for the query logging configuration.

', 'ResolverRule$Arn' => '

The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:

', ], ], 'AssociateFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverEndpointIpAddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverEndpointIpAddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'AutodefinedReverseFlag' => [ 'base' => NULL, 'refs' => [ 'UpdateResolverConfigRequest$AutodefinedReverseFlag' => '

Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.

It can take some time for the status change to be completed.

', ], ], 'BlockOverrideDnsType' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockOverrideDnsType' => '

The DNS record\'s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

', 'FirewallRule$BlockOverrideDnsType' => '

The DNS record\'s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', 'UpdateFirewallRuleRequest$BlockOverrideDnsType' => '

The DNS record\'s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', ], ], 'BlockOverrideDomain' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockOverrideDomain' => '

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

', 'FirewallRule$BlockOverrideDomain' => '

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', 'UpdateFirewallRuleRequest$BlockOverrideDomain' => '

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', ], ], 'BlockOverrideTtl' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockOverrideTtl' => '

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

', 'UpdateFirewallRuleRequest$BlockOverrideTtl' => '

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', ], ], 'BlockResponse' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockResponse' => '

The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

This setting is required if the rule action setting is BLOCK.

', 'FirewallRule$BlockResponse' => '

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

', 'UpdateFirewallRuleRequest$BlockResponse' => '

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'PutFirewallRuleGroupPolicyResponse$ReturnValue' => '

', 'PutResolverQueryLogConfigPolicyResponse$ReturnValue' => '

Whether the PutResolverQueryLogConfigPolicy request was successful.

', 'PutResolverRulePolicyResponse$ReturnValue' => '

Whether the PutResolverRulePolicy request was successful.

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

The requested state transition isn\'t valid. For example, you can\'t delete a firewall domain list if it is in the process of being deleted, or you can\'t import domains into a domain list that is in the process of being deleted.

', 'refs' => [], ], 'Count' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsResponse$TotalCount' => '

The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.

', 'ListResolverQueryLogConfigAssociationsResponse$TotalFilteredCount' => '

The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.

', 'ListResolverQueryLogConfigsResponse$TotalCount' => '

The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.

', 'ListResolverQueryLogConfigsResponse$TotalFilteredCount' => '

The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see TotalCount.

', 'ResolverQueryLogConfig$AssociationCount' => '

The number of VPCs that are associated with the query logging configuration.

', ], ], 'CreateFirewallDomainListRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallDomainListResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatorRequestId' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateFirewallDomainListRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateFirewallRuleGroupRequest$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'CreateFirewallRuleRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateOutpostResolverRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.

CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateResolverEndpointRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateResolverQueryLogConfigRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateResolverRuleRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'FirewallDomainList$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallDomainListMetadata$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRule$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRuleGroup$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRuleGroupAssociation$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRuleGroupMetadata$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'OutpostResolver$CreatorRequestId' => '

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

', 'ResolverEndpoint$CreatorRequestId' => '

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

', 'ResolverQueryLogConfig$CreatorRequestId' => '

A unique string that identifies the request that created the query logging configuration. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

', 'ResolverRule$CreatorRequestId' => '

A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.

', ], ], 'DeleteFirewallDomainListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallDomainListResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationArn' => [ 'base' => NULL, 'refs' => [ 'CreateResolverQueryLogConfigRequest$DestinationArn' => '

The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

', 'ResolverQueryLogConfig$DestinationArn' => '

The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

', ], ], 'DisassociateFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverEndpointIpAddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverEndpointIpAddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DomainListFileUrl' => [ 'base' => NULL, 'refs' => [ 'ImportFirewallDomainsRequest$DomainFileUrl' => '

The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

The file must be in an S3 bucket that\'s in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateResolverRuleRequest$DomainName' => '

DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).

', 'ResolverRule$DomainName' => '

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'InternalServiceErrorException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidPolicyDocument$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'InvalidTagException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'UnknownResourceException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'Filter' => [ 'base' => '

For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.

To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

The name of the parameter that you want to use to filter objects.

The valid values for Name depend on the action that you\'re including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

ListResolverEndpoints

Valid values for Name include the following:

ListResolverRules

Valid values for Name include the following:

ListResolverRuleAssociations

Valid values for Name include the following:

ListResolverQueryLogConfigs

Valid values for Name include the following:

ListResolverQueryLogConfigAssociations

Valid values for Name include the following:

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValues$member' => NULL, ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

When you\'re using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

', ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'ListResolverDnssecConfigsRequest$Filters' => '

An optional specification to return a subset of objects.

', 'ListResolverEndpointsRequest$Filters' => '

An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverQueryLogConfigAssociationsRequest$Filters' => '

An optional specification to return a subset of query logging associations.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverQueryLogConfigsRequest$Filters' => '

An optional specification to return a subset of query logging configurations.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverRuleAssociationsRequest$Filters' => '

An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.

If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverRulesRequest$Filters' => '

An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.

If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', ], ], 'FirewallConfig' => [ 'base' => '

Configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

', 'refs' => [ 'FirewallConfigList$member' => NULL, 'GetFirewallConfigResponse$FirewallConfig' => '

Configuration of the firewall behavior provided by DNS Firewall for a single VPC from AmazonVPC.

', 'UpdateFirewallConfigResponse$FirewallConfig' => '

Configuration of the firewall behavior provided by DNS Firewall for a single VPC.

', ], ], 'FirewallConfigList' => [ 'base' => NULL, 'refs' => [ 'ListFirewallConfigsResponse$FirewallConfigs' => '

The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC).

', ], ], 'FirewallDomainImportOperation' => [ 'base' => NULL, 'refs' => [ 'ImportFirewallDomainsRequest$Operation' => '

What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list in the file.

', ], ], 'FirewallDomainList' => [ 'base' => '

High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList.

To retrieve the domains that are defined for this domain list, call ListFirewallDomains.

', 'refs' => [ 'CreateFirewallDomainListResponse$FirewallDomainList' => '

The domain list that you just created.

', 'DeleteFirewallDomainListResponse$FirewallDomainList' => '

The domain list that you just deleted.

', 'GetFirewallDomainListResponse$FirewallDomainList' => '

The domain list that you requested.

', ], ], 'FirewallDomainListMetadata' => [ 'base' => '

Minimal high-level information for a firewall domain list. The action ListFirewallDomainLists returns an array of these objects.

To retrieve full information for a firewall domain list, call GetFirewallDomainList and ListFirewallDomains.

', 'refs' => [ 'FirewallDomainListMetadataList$member' => NULL, ], ], 'FirewallDomainListMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainListsResponse$FirewallDomainLists' => '

A list of the domain lists that you have defined.

This might be a partial list of the domain lists that you\'ve defined. For information, see MaxResults.

', ], ], 'FirewallDomainListStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$Status' => '

The status of the domain list.

', 'ImportFirewallDomainsResponse$Status' => '

Status of the import request.

', 'UpdateFirewallDomainsResponse$Status' => '

Status of the UpdateFirewallDomains request.

', ], ], 'FirewallDomainName' => [ 'base' => NULL, 'refs' => [ 'FirewallDomains$member' => NULL, ], ], 'FirewallDomainUpdateOperation' => [ 'base' => NULL, 'refs' => [ 'UpdateFirewallDomainsRequest$Operation' => '

What you want DNS Firewall to do with the domains that you are providing:

', ], ], 'FirewallDomains' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainsResponse$Domains' => '

A list of the domains in the firewall domain list.

This might be a partial list of the domains that you\'ve defined in the domain list. For information, see MaxResults.

', 'UpdateFirewallDomainsRequest$Domains' => '

A list of domains to use in the update operation.

There is a limit of 1000 domains per request.

Each domain specification in your domain list must satisfy the following requirements:

', ], ], 'FirewallFailOpenStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallConfig$FirewallFailOpen' => '

Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

', 'UpdateFirewallConfigRequest$FirewallFailOpen' => '

Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

', ], ], 'FirewallRule' => [ 'base' => '

A single firewall rule in a rule group.

', 'refs' => [ 'CreateFirewallRuleResponse$FirewallRule' => '

The firewall rule that you just created.

', 'DeleteFirewallRuleResponse$FirewallRule' => '

The specification for the firewall rule that you just deleted.

', 'FirewallRules$member' => NULL, 'UpdateFirewallRuleResponse$FirewallRule' => '

The firewall rule that you just updated.

', ], ], 'FirewallRuleGroup' => [ 'base' => '

High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call ListFirewallRules.

', 'refs' => [ 'CreateFirewallRuleGroupResponse$FirewallRuleGroup' => '

A collection of rules used to filter DNS network traffic.

', 'DeleteFirewallRuleGroupResponse$FirewallRuleGroup' => '

A collection of rules used to filter DNS network traffic.

', 'GetFirewallRuleGroupResponse$FirewallRuleGroup' => '

A collection of rules used to filter DNS network traffic.

', ], ], 'FirewallRuleGroupAssociation' => [ 'base' => '

An association between a firewall rule group and a VPC, which enables DNS filtering for the VPC.

', 'refs' => [ 'AssociateFirewallRuleGroupResponse$FirewallRuleGroupAssociation' => '

The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.

', 'DisassociateFirewallRuleGroupResponse$FirewallRuleGroupAssociation' => '

The firewall rule group association that you just removed.

', 'FirewallRuleGroupAssociations$member' => NULL, 'GetFirewallRuleGroupAssociationResponse$FirewallRuleGroupAssociation' => '

The association that you requested.

', 'UpdateFirewallRuleGroupAssociationResponse$FirewallRuleGroupAssociation' => '

The association that you just updated.

', ], ], 'FirewallRuleGroupAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallRuleGroupAssociation$Status' => '

The current status of the association.

', 'ListFirewallRuleGroupAssociationsRequest$Status' => '

The association Status setting that you want DNS Firewall to filter on for the list. If you don\'t specify this, then DNS Firewall returns all associations, regardless of status.

', ], ], 'FirewallRuleGroupAssociations' => [ 'base' => NULL, 'refs' => [ 'ListFirewallRuleGroupAssociationsResponse$FirewallRuleGroupAssociations' => '

A list of your firewall rule group associations.

This might be a partial list of the associations that you have defined. For information, see MaxResults.

', ], ], 'FirewallRuleGroupMetadata' => [ 'base' => '

Minimal high-level information for a firewall rule group. The action ListFirewallRuleGroups returns an array of these objects.

To retrieve full information for a firewall rule group, call GetFirewallRuleGroup and ListFirewallRules.

', 'refs' => [ 'FirewallRuleGroupMetadataList$member' => NULL, ], ], 'FirewallRuleGroupMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListFirewallRuleGroupsResponse$FirewallRuleGroups' => '

A list of your firewall rule groups.

This might be a partial list of the rule groups that you have defined. For information, see MaxResults.

', ], ], 'FirewallRuleGroupPolicy' => [ 'base' => NULL, 'refs' => [ 'GetFirewallRuleGroupPolicyResponse$FirewallRuleGroupPolicy' => '

The Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

', 'PutFirewallRuleGroupPolicyRequest$FirewallRuleGroupPolicy' => '

The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.

', ], ], 'FirewallRuleGroupStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallRuleGroup$Status' => '

The status of the domain list.

', ], ], 'FirewallRules' => [ 'base' => NULL, 'refs' => [ 'ListFirewallRulesResponse$FirewallRules' => '

A list of the rules that you have defined.

This might be a partial list of the firewall rules that you\'ve defined. For information, see MaxResults.

', ], ], 'GetFirewallConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallDomainListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallDomainListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverDnssecConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverDnssecConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRulePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportFirewallDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportFirewallDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'InstanceCount' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$InstanceCount' => '

Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.

', 'OutpostResolver$InstanceCount' => '

Amazon EC2 instance count for the Resolver on the Outpost.

', 'UpdateOutpostResolverRequest$InstanceCount' => '

The Amazon EC2 instance count for a Resolver on the Outpost.

', ], ], 'InternalServiceErrorException' => [ 'base' => '

We encountered an unknown error. Try again in a few minutes.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The value that you specified for NextToken in a List request isn\'t valid.

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

One or more parameters in this request are not valid.

', 'refs' => [], ], 'InvalidPolicyDocument' => [ 'base' => '

The specified Resolver rule policy is invalid.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

The request is invalid.

', 'refs' => [], ], 'InvalidTagException' => [ 'base' => '

The specified tag is invalid.

', 'refs' => [], ], 'Ip' => [ 'base' => NULL, 'refs' => [ 'IpAddressRequest$Ip' => '

The IPv4 address that you want to use for DNS queries.

', 'IpAddressResponse$Ip' => '

One IPv4 address that the Resolver endpoint uses for DNS queries.

', 'IpAddressUpdate$Ip' => '

The new IPv4 address.

', 'TargetAddress$Ip' => '

One IPv4 address that you want to forward DNS queries to.

', ], ], 'IpAddressCount' => [ 'base' => NULL, 'refs' => [ 'ResolverEndpoint$IpAddressCount' => '

The number of IP addresses that the Resolver endpoint can use for DNS queries.

', ], ], 'IpAddressRequest' => [ 'base' => '

In a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). IpAddressRequest also includes the ID of the subnet that contains the IP address.

', 'refs' => [ 'IpAddressesRequest$member' => NULL, ], ], 'IpAddressResponse' => [ 'base' => '

In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.

', 'refs' => [ 'IpAddressesResponse$member' => NULL, ], ], 'IpAddressStatus' => [ 'base' => NULL, 'refs' => [ 'IpAddressResponse$Status' => '

A status code that gives the current status of the request.

', ], ], 'IpAddressUpdate' => [ 'base' => '

In an UpdateResolverEndpoint request, information about an IP address to update.

', 'refs' => [ 'AssociateResolverEndpointIpAddressRequest$IpAddress' => '

Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

', 'DisassociateResolverEndpointIpAddressRequest$IpAddress' => '

The IPv4 address that you want to remove from a Resolver endpoint.

', ], ], 'IpAddressesRequest' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$IpAddresses' => '

The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

Even though the minimum is 1, Route 53 requires that you create at least two.

', ], ], 'IpAddressesResponse' => [ 'base' => NULL, 'refs' => [ 'ListResolverEndpointIpAddressesResponse$IpAddresses' => '

Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

', ], ], 'Ipv6' => [ 'base' => NULL, 'refs' => [ 'IpAddressRequest$Ipv6' => '

The IPv6 address that you want to use for DNS queries.

', 'IpAddressResponse$Ipv6' => '

One IPv6 address that the Resolver endpoint uses for DNS queries.

', 'IpAddressUpdate$Ipv6' => '

The new IPv6 address.

', 'TargetAddress$Ipv6' => '

One IPv6 address that you want to forward DNS queries to.

', 'UpdateIpAddress$Ipv6' => '

The IPv6 address that you want to use for DNS queries.

', ], ], 'LimitExceededException' => [ 'base' => '

The request caused one or more limits to be exceeded.

', 'refs' => [], ], 'ListDomainMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', ], ], 'ListFirewallConfigsMaxResult' => [ 'base' => NULL, 'refs' => [ 'ListFirewallConfigsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', ], ], 'ListFirewallConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOutpostResolversRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOutpostResolversResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverConfigsMaxResult' => [ 'base' => NULL, 'refs' => [ 'ListResolverConfigsRequest$MaxResults' => '

The maximum number of Resolver configurations that you want to return in the response to a ListResolverConfigs request. If you don\'t specify a value for MaxResults, up to 100 Resolver configurations are returned.

', ], ], 'ListResolverConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverDnssecConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverDnssecConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointIpAddressesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointIpAddressesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRuleAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRuleAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainListsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListFirewallRuleGroupAssociationsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListFirewallRuleGroupsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListFirewallRulesRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListOutpostResolversRequest$MaxResults' => '

The maximum number of Resolvers on the Outpost that you want to return in the response to a ListOutpostResolver request. If you don\'t specify a value for MaxResults, the request returns up to 100 Resolvers.

', 'ListResolverDnssecConfigsRequest$MaxResults' => '

Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want Amazon Route 53 to return. If you don\'t specify a value for MaxResults, Route 53 returns up to 100 configuration per page.

', 'ListResolverEndpointIpAddressesRequest$MaxResults' => '

The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 IP addresses.

', 'ListResolverEndpointIpAddressesResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListResolverEndpointsRequest$MaxResults' => '

The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.

', 'ListResolverEndpointsResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListResolverQueryLogConfigAssociationsRequest$MaxResults' => '

The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 query logging associations.

', 'ListResolverQueryLogConfigsRequest$MaxResults' => '

The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

', 'ListResolverRuleAssociationsRequest$MaxResults' => '

The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 rule associations.

', 'ListResolverRuleAssociationsResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListResolverRulesRequest$MaxResults' => '

The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 Resolver rules.

', 'ListResolverRulesResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListTagsForResourceRequest$MaxResults' => '

The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 tags.

', ], ], 'MutationProtectionStatus' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$MutationProtection' => '

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. When you create the association, the default setting is DISABLED.

', 'FirewallRuleGroupAssociation$MutationProtection' => '

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

', 'UpdateFirewallRuleGroupAssociationRequest$MutationProtection' => '

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$Name' => '

A name that lets you identify the association, to manage and use it.

', 'AssociateResolverRuleRequest$Name' => '

A name for the association that you\'re creating between a Resolver rule and a VPC.

', 'CreateFirewallDomainListRequest$Name' => '

A name that lets you identify the domain list to manage and use it.

', 'CreateFirewallRuleGroupRequest$Name' => '

A name that lets you identify the rule group, to manage and use it.

', 'CreateFirewallRuleRequest$Name' => '

A name that lets you identify the rule in the rule group.

', 'CreateResolverEndpointRequest$Name' => '

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

', 'CreateResolverRuleRequest$Name' => '

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

', 'FirewallDomainList$Name' => '

The name of the domain list.

', 'FirewallDomainListMetadata$Name' => '

The name of the domain list.

', 'FirewallRule$Name' => '

The name of the rule.

', 'FirewallRuleGroup$Name' => '

The name of the rule group.

', 'FirewallRuleGroupAssociation$Name' => '

The name of the association.

', 'FirewallRuleGroupMetadata$Name' => '

The name of the rule group.

', 'ImportFirewallDomainsResponse$Name' => '

The name of the domain list.

', 'ResolverEndpoint$Name' => '

The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

', 'ResolverRule$Name' => '

The name for the Resolver rule, which you specified when you created the Resolver rule.

', 'ResolverRuleAssociation$Name' => '

The name of an association between a Resolver rule and a VPC.

', 'ResolverRuleConfig$Name' => '

The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

', 'UpdateFirewallDomainsResponse$Name' => '

The name of the domain list.

', 'UpdateFirewallRuleGroupAssociationRequest$Name' => '

The name of the rule group association.

', 'UpdateFirewallRuleRequest$Name' => '

The name of the rule.

', 'UpdateResolverEndpointRequest$Name' => '

The name of the Resolver endpoint that you want to update.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListFirewallConfigsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallConfigsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallDomainListsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallDomainListsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallDomainsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallDomainsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallRuleGroupAssociationsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallRuleGroupAssociationsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallRuleGroupsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallRuleGroupsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallRulesRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallRulesResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListOutpostResolversRequest$NextToken' => '

For the first ListOutpostResolver request, omit this value.

', 'ListOutpostResolversResponse$NextToken' => '

If more than MaxResults Resolvers match the specified criteria, you can submit another ListOutpostResolver request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverConfigsRequest$NextToken' => '

(Optional) If the current Amazon Web Services account has more than MaxResults Resolver configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

', 'ListResolverConfigsResponse$NextToken' => '

If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, NextToken doesn\'t appear in the response.

If a response doesn\'t include the last of the configurations, you can get more configurations by submitting another ListResolverConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

', 'ListResolverDnssecConfigsRequest$NextToken' => '

(Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverDnssecConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

', 'ListResolverDnssecConfigsResponse$NextToken' => '

If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, NextToken doesn\'t appear in the response.

If a response doesn\'t include the last of the configurations, you can get more configurations by submitting another ListResolverDnssecConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

', 'ListResolverEndpointIpAddressesRequest$NextToken' => '

For the first ListResolverEndpointIpAddresses request, omit this value.

If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverEndpointIpAddressesResponse$NextToken' => '

If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverEndpointsRequest$NextToken' => '

For the first ListResolverEndpoints request, omit this value.

If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverEndpointsResponse$NextToken' => '

If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigAssociationsRequest$NextToken' => '

For the first ListResolverQueryLogConfigAssociations request, omit this value.

If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigAssociationsResponse$NextToken' => '

If there are more than MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigsRequest$NextToken' => '

For the first ListResolverQueryLogConfigs request, omit this value.

If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigsResponse$NextToken' => '

If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRuleAssociationsRequest$NextToken' => '

For the first ListResolverRuleAssociation request, omit this value.

If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRuleAssociationsResponse$NextToken' => '

If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRulesRequest$NextToken' => '

For the first ListResolverRules request, omit this value.

If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRulesResponse$NextToken' => '

If more than MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListTagsForResourceRequest$NextToken' => '

For the first ListTagsForResource request, omit this value.

If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

', 'ListTagsForResourceResponse$NextToken' => '

If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', ], ], 'OutpostArn' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$OutpostArn' => '

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

', 'CreateResolverEndpointRequest$OutpostArn' => '

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

', 'ListOutpostResolversRequest$OutpostArn' => '

The Amazon Resource Name (ARN) of the Outpost.

', 'OutpostResolver$OutpostArn' => '

The ARN (Amazon Resource Name) for the Outpost.

', 'ResolverEndpoint$OutpostArn' => '

The ARN (Amazon Resource Name) for the Outpost.

', ], ], 'OutpostInstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$PreferredInstanceType' => '

The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.

', 'CreateResolverEndpointRequest$PreferredInstanceType' => '

The instance type. If you specify this, you must also specify a value for the OutpostArn.

', 'OutpostResolver$PreferredInstanceType' => '

The Amazon EC2 instance type.

', 'ResolverEndpoint$PreferredInstanceType' => '

The Amazon EC2 instance type.

', 'UpdateOutpostResolverRequest$PreferredInstanceType' => '

Amazon EC2 instance type.

', ], ], 'OutpostResolver' => [ 'base' => '

A complex type that contains settings for an existing Resolver on an Outpost.

', 'refs' => [ 'CreateOutpostResolverResponse$OutpostResolver' => '

Information about the CreateOutpostResolver request, including the status of the request.

', 'DeleteOutpostResolverResponse$OutpostResolver' => '

Information about the DeleteOutpostResolver request, including the status of the request.

', 'GetOutpostResolverResponse$OutpostResolver' => '

Information about the GetOutpostResolver request, including the status of the request.

', 'OutpostResolverList$member' => NULL, 'UpdateOutpostResolverResponse$OutpostResolver' => '

The response to an UpdateOutpostResolver request.

', ], ], 'OutpostResolverList' => [ 'base' => NULL, 'refs' => [ 'ListOutpostResolversResponse$OutpostResolvers' => '

The Resolvers on Outposts that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

', ], ], 'OutpostResolverName' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$Name' => '

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

', 'OutpostResolver$Name' => '

Name of the Resolver.

', 'UpdateOutpostResolverRequest$Name' => '

Name of the Resolver on the Outpost.

', ], ], 'OutpostResolverStatus' => [ 'base' => NULL, 'refs' => [ 'OutpostResolver$Status' => '

Status of the Resolver.

', ], ], 'OutpostResolverStatusMessage' => [ 'base' => NULL, 'refs' => [ 'OutpostResolver$StatusMessage' => '

A detailed description of the Resolver.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'TargetAddress$Port' => '

The port at Ip that you want to forward DNS queries to.

', ], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.

The allowed values for Priority are between 100 and 9900.

', 'CreateFirewallRuleRequest$Priority' => '

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

', 'FirewallRule$Priority' => '

The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

', 'FirewallRuleGroupAssociation$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.

', 'ListFirewallRuleGroupAssociationsRequest$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

', 'ListFirewallRulesRequest$Priority' => '

Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

', 'UpdateFirewallRuleGroupAssociationRequest$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.

', 'UpdateFirewallRuleRequest$Priority' => '

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'ProtocolList$member' => NULL, 'TargetAddress$Protocol' => '

The protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

', ], ], 'ProtocolList' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$Protocols' => '

The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

', 'ResolverEndpoint$Protocols' => '

Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

', 'UpdateResolverEndpointRequest$Protocols' => '

The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

You can\'t change the protocol of an inbound endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and then remove the Do53.

', ], ], 'PutFirewallRuleGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutFirewallRuleGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResolverQueryLogConfigPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResolverQueryLogConfigPolicyResponse' => [ 'base' => '

The response to a PutResolverQueryLogConfigPolicy request.

', 'refs' => [], ], 'PutResolverRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResolverRulePolicyResponse' => [ 'base' => '

The response to a PutResolverRulePolicy request.

', 'refs' => [], ], 'Qtype' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$Qtype' => '

The DNS query type you want the rule to evaluate. Allowed values are;

', 'DeleteFirewallRuleRequest$Qtype' => '

The DNS query type that the rule you are deleting evaluates. Allowed values are;

', 'FirewallRule$Qtype' => '

The DNS query type you want the rule to evaluate. Allowed values are;

', 'UpdateFirewallRuleRequest$Qtype' => '

The DNS query type you want the rule to evaluate. Allowed values are;

', ], ], 'ResolverAutodefinedReverseStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverConfig$AutodefinedReverse' => '

The status of whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. The status can be one of following:

', ], ], 'ResolverConfig' => [ 'base' => '

A complex type that contains information about a Resolver configuration for a VPC.

', 'refs' => [ 'GetResolverConfigResponse$ResolverConfig' => '

Information about the behavior configuration of Route 53 Resolver behavior for the VPC you specified in the GetResolverConfig request.

', 'ResolverConfigList$member' => NULL, 'UpdateResolverConfigResponse$ResolverConfig' => '

An array that contains settings for the specified Resolver configuration.

', ], ], 'ResolverConfigList' => [ 'base' => NULL, 'refs' => [ 'ListResolverConfigsResponse$ResolverConfigs' => '

An array that contains one ResolverConfigs element for each Resolver configuration that is associated with the current Amazon Web Services account.

', ], ], 'ResolverDNSSECValidationStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverDnssecConfig$ValidationStatus' => '

The validation status for a DNSSEC configuration. The status can be one of the following:

', ], ], 'ResolverDnssecConfig' => [ 'base' => '

A complex type that contains information about a configuration for DNSSEC validation.

', 'refs' => [ 'GetResolverDnssecConfigResponse$ResolverDNSSECConfig' => '

The information about a configuration for DNSSEC validation.

', 'ResolverDnssecConfigList$member' => NULL, 'UpdateResolverDnssecConfigResponse$ResolverDNSSECConfig' => '

A complex type that contains settings for the specified DNSSEC configuration.

', ], ], 'ResolverDnssecConfigList' => [ 'base' => NULL, 'refs' => [ 'ListResolverDnssecConfigsResponse$ResolverDnssecConfigs' => '

An array that contains one ResolverDnssecConfig element for each configuration for DNSSEC validation that is associated with the current Amazon Web Services account. It doesn\'t contain disabled DNSSEC configurations for the resource.

', ], ], 'ResolverEndpoint' => [ 'base' => '

In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.

', 'refs' => [ 'AssociateResolverEndpointIpAddressResponse$ResolverEndpoint' => '

The response to an AssociateResolverEndpointIpAddress request.

', 'CreateResolverEndpointResponse$ResolverEndpoint' => '

Information about the CreateResolverEndpoint request, including the status of the request.

', 'DeleteResolverEndpointResponse$ResolverEndpoint' => '

Information about the DeleteResolverEndpoint request, including the status of the request.

', 'DisassociateResolverEndpointIpAddressResponse$ResolverEndpoint' => '

The response to an DisassociateResolverEndpointIpAddress request.

', 'GetResolverEndpointResponse$ResolverEndpoint' => '

Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.

', 'ResolverEndpoints$member' => NULL, 'UpdateResolverEndpointResponse$ResolverEndpoint' => '

The response to an UpdateResolverEndpoint request.

', ], ], 'ResolverEndpointDirection' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$Direction' => '

Specify the applicable value:

', 'ResolverEndpoint$Direction' => '

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

', ], ], 'ResolverEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverEndpoint$Status' => '

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

', ], ], 'ResolverEndpointType' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$ResolverEndpointType' => '

For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

', 'ResolverEndpoint$ResolverEndpointType' => '

The Resolver endpoint IP address type.

', 'UpdateResolverEndpointRequest$ResolverEndpointType' => '

Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries.

Updating to IPV6 type isn\'t currently supported.

', ], ], 'ResolverEndpoints' => [ 'base' => NULL, 'refs' => [ 'ListResolverEndpointsResponse$ResolverEndpoints' => '

The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

', ], ], 'ResolverQueryLogConfig' => [ 'base' => '

In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains settings for one query logging configuration.

', 'refs' => [ 'CreateResolverQueryLogConfigResponse$ResolverQueryLogConfig' => '

Information about the CreateResolverQueryLogConfig request, including the status of the request.

', 'DeleteResolverQueryLogConfigResponse$ResolverQueryLogConfig' => '

Information about the query logging configuration that you deleted, including the status of the request.

', 'GetResolverQueryLogConfigResponse$ResolverQueryLogConfig' => '

Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig request.

', 'ResolverQueryLogConfigList$member' => NULL, ], ], 'ResolverQueryLogConfigAssociation' => [ 'base' => '

In the response to an AssociateResolverQueryLogConfig, DisassociateResolverQueryLogConfig, GetResolverQueryLogConfigAssociation, or ListResolverQueryLogConfigAssociations, request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

', 'refs' => [ 'AssociateResolverQueryLogConfigResponse$ResolverQueryLogConfigAssociation' => '

A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

', 'DisassociateResolverQueryLogConfigResponse$ResolverQueryLogConfigAssociation' => '

A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.

', 'GetResolverQueryLogConfigAssociationResponse$ResolverQueryLogConfigAssociation' => '

Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.

', 'ResolverQueryLogConfigAssociationList$member' => NULL, ], ], 'ResolverQueryLogConfigAssociationError' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfigAssociation$Error' => '

If the value of Status is FAILED, the value of Error indicates the cause:

If the value of Status is a value other than FAILED, Error is null.

', ], ], 'ResolverQueryLogConfigAssociationErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfigAssociation$ErrorMessage' => '

Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

', ], ], 'ResolverQueryLogConfigAssociationList' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsResponse$ResolverQueryLogConfigAssociations' => '

A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for Filter.

', ], ], 'ResolverQueryLogConfigAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfigAssociation$Status' => '

The status of the specified query logging association. Valid values include the following:

', ], ], 'ResolverQueryLogConfigList' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigsResponse$ResolverQueryLogConfigs' => '

A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.

', ], ], 'ResolverQueryLogConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateResolverQueryLogConfigRequest$Name' => '

The name that you want to give the query logging configuration.

', 'ResolverQueryLogConfig$Name' => '

The name of the query logging configuration.

', ], ], 'ResolverQueryLogConfigPolicy' => [ 'base' => NULL, 'refs' => [ 'GetResolverQueryLogConfigPolicyResponse$ResolverQueryLogConfigPolicy' => '

Information about the query logging policy for the query logging configuration that you specified in a GetResolverQueryLogConfigPolicy request.

', 'PutResolverQueryLogConfigPolicyRequest$ResolverQueryLogConfigPolicy' => '

An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.

', ], ], 'ResolverQueryLogConfigStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfig$Status' => '

The status of the specified query logging configuration. Valid values include the following:

', ], ], 'ResolverRule' => [ 'base' => '

For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.

', 'refs' => [ 'CreateResolverRuleResponse$ResolverRule' => '

Information about the CreateResolverRule request, including the status of the request.

', 'DeleteResolverRuleResponse$ResolverRule' => '

Information about the DeleteResolverRule request, including the status of the request.

', 'GetResolverRuleResponse$ResolverRule' => '

Information about the Resolver rule that you specified in a GetResolverRule request.

', 'ResolverRules$member' => NULL, 'UpdateResolverRuleResponse$ResolverRule' => '

The response to an UpdateResolverRule request.

', ], ], 'ResolverRuleAssociation' => [ 'base' => '

In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.

', 'refs' => [ 'AssociateResolverRuleResponse$ResolverRuleAssociation' => '

Information about the AssociateResolverRule request, including the status of the request.

', 'DisassociateResolverRuleResponse$ResolverRuleAssociation' => '

Information about the DisassociateResolverRule request, including the status of the request.

', 'GetResolverRuleAssociationResponse$ResolverRuleAssociation' => '

Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.

', 'ResolverRuleAssociations$member' => NULL, ], ], 'ResolverRuleAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverRuleAssociation$Status' => '

A code that specifies the current status of the association between a Resolver rule and a VPC.

', ], ], 'ResolverRuleAssociations' => [ 'base' => NULL, 'refs' => [ 'ListResolverRuleAssociationsResponse$ResolverRuleAssociations' => '

The associations that were created between Resolver rules and VPCs using the current Amazon Web Services account, and that match the specified filters, if any.

', ], ], 'ResolverRuleConfig' => [ 'base' => '

In an UpdateResolverRule request, information about the changes that you want to make.

', 'refs' => [ 'UpdateResolverRuleRequest$Config' => '

The new settings for the Resolver rule.

', ], ], 'ResolverRulePolicy' => [ 'base' => NULL, 'refs' => [ 'GetResolverRulePolicyResponse$ResolverRulePolicy' => '

The Resolver rule policy for the rule that you specified in a GetResolverRulePolicy request.

', 'PutResolverRulePolicyRequest$ResolverRulePolicy' => '

An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.

', ], ], 'ResolverRuleStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverRule$Status' => '

A code that specifies the current status of the Resolver rule.

', ], ], 'ResolverRules' => [ 'base' => NULL, 'refs' => [ 'ListResolverRulesResponse$ResolverRules' => '

The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.

', ], ], 'ResourceExistsException' => [ 'base' => '

The resource that you tried to create already exists.

', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group.

', 'AssociateFirewallRuleGroupRequest$VpcId' => '

The unique identifier of the VPC that you want to associate with the rule group.

', 'AssociateResolverEndpointIpAddressRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to associate IP addresses with.

', 'AssociateResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that you want to associate a VPC with.

', 'AssociateResolverQueryLogConfigRequest$ResourceId' => '

The ID of an Amazon VPC that you want this query logging configuration to log queries for.

The VPCs and the query logging configuration must be in the same Region.

', 'AssociateResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use ListResolverRules.

', 'AssociateResolverRuleRequest$VPCId' => '

The ID of the VPC that you want to associate the Resolver rule with.

', 'CreateFirewallRuleRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group where you want to create the rule.

', 'CreateFirewallRuleRequest$FirewallDomainListId' => '

The ID of the domain list that you want to use in the rule.

', 'CreateResolverRuleRequest$ResolverEndpointId' => '

The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

', 'DeleteFirewallDomainListRequest$FirewallDomainListId' => '

The ID of the domain list that you want to delete.

', 'DeleteFirewallRuleGroupRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to delete.

', 'DeleteFirewallRuleRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to delete the rule from.

', 'DeleteFirewallRuleRequest$FirewallDomainListId' => '

The ID of the domain list that\'s used in the rule.

', 'DeleteOutpostResolverRequest$Id' => '

A unique string that identifies the Resolver on the Outpost.

', 'DeleteResolverEndpointRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to delete.

', 'DeleteResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that you want to delete.

', 'DeleteResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to delete.

', 'DisassociateFirewallRuleGroupRequest$FirewallRuleGroupAssociationId' => '

The identifier of the FirewallRuleGroupAssociation.

', 'DisassociateResolverEndpointIpAddressRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to disassociate an IP address from.

', 'DisassociateResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that you want to disassociate a specified VPC from.

', 'DisassociateResolverQueryLogConfigRequest$ResourceId' => '

The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.

', 'DisassociateResolverRuleRequest$VPCId' => '

The ID of the VPC that you want to disassociate the Resolver rule from.

', 'DisassociateResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to disassociate from the specified VPC.

', 'FirewallConfig$Id' => '

The ID of the firewall configuration.

', 'FirewallConfig$ResourceId' => '

The ID of the VPC that this firewall configuration applies to.

', 'FirewallDomainList$Id' => '

The ID of the domain list.

', 'FirewallDomainListMetadata$Id' => '

The ID of the domain list.

', 'FirewallRule$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group of the rule.

', 'FirewallRule$FirewallDomainListId' => '

The ID of the domain list that\'s used in the rule.

', 'FirewallRuleGroup$Id' => '

The ID of the rule group.

', 'FirewallRuleGroupAssociation$Id' => '

The identifier for the association.

', 'FirewallRuleGroupAssociation$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group.

', 'FirewallRuleGroupAssociation$VpcId' => '

The unique identifier of the VPC that is associated with the rule group.

', 'FirewallRuleGroupMetadata$Id' => '

The ID of the rule group.

', 'GetFirewallConfigRequest$ResourceId' => '

The ID of the VPC from Amazon VPC that the configuration is for.

', 'GetFirewallDomainListRequest$FirewallDomainListId' => '

The ID of the domain list.

', 'GetFirewallRuleGroupAssociationRequest$FirewallRuleGroupAssociationId' => '

The identifier of the FirewallRuleGroupAssociation.

', 'GetFirewallRuleGroupRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group.

', 'GetOutpostResolverRequest$Id' => '

The ID of the Resolver on the Outpost.

', 'GetResolverConfigRequest$ResourceId' => '

Resource ID of the Amazon VPC that you want to get information about.

', 'GetResolverDnssecConfigRequest$ResourceId' => '

The ID of the virtual private cloud (VPC) for the DNSSEC validation status.

', 'GetResolverEndpointRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to get information about.

', 'GetResolverQueryLogConfigAssociationRequest$ResolverQueryLogConfigAssociationId' => '

The ID of the Resolver query logging configuration association that you want to get information about.

', 'GetResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the Resolver query logging configuration that you want to get information about.

', 'GetResolverRuleAssociationRequest$ResolverRuleAssociationId' => '

The ID of the Resolver rule association that you want to get information about.

', 'GetResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to get information about.

', 'ImportFirewallDomainsRequest$FirewallDomainListId' => '

The ID of the domain list that you want to modify with the import operation.

', 'ImportFirewallDomainsResponse$Id' => '

The Id of the firewall domain list that DNS Firewall just updated.

', 'IpAddressResponse$IpId' => '

The ID of one IP address.

', 'IpAddressUpdate$IpId' => '

Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

', 'ListFirewallDomainsRequest$FirewallDomainListId' => '

The ID of the domain list whose domains you want to retrieve.

', 'ListFirewallRuleGroupAssociationsRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group.

', 'ListFirewallRuleGroupAssociationsRequest$VpcId' => '

The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC.

', 'ListFirewallRulesRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to retrieve the rules for.

', 'ListResolverEndpointIpAddressesRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to get IP addresses for.

', 'OutpostResolver$Id' => '

The ID of the Resolver on Outpost.

', 'ResolverConfig$Id' => '

ID for the Resolver configuration.

', 'ResolverConfig$ResourceId' => '

The ID of the Amazon Virtual Private Cloud VPC that you\'re configuring Resolver for.

', 'ResolverDnssecConfig$Id' => '

The ID for a configuration for DNSSEC validation.

', 'ResolverDnssecConfig$ResourceId' => '

The ID of the virtual private cloud (VPC) that you\'re configuring the DNSSEC validation status for.

', 'ResolverEndpoint$Id' => '

The ID of the Resolver endpoint.

', 'ResolverEndpoint$HostVPCId' => '

The ID of the VPC that you want to create the Resolver endpoint in.

', 'ResolverQueryLogConfig$Id' => '

The ID for the query logging configuration.

', 'ResolverQueryLogConfigAssociation$Id' => '

The ID of the query logging association.

', 'ResolverQueryLogConfigAssociation$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that a VPC is associated with.

', 'ResolverQueryLogConfigAssociation$ResourceId' => '

The ID of the Amazon VPC that is associated with the query logging configuration.

', 'ResolverRule$Id' => '

The ID that Resolver assigned to the Resolver rule when you created it.

', 'ResolverRule$ResolverEndpointId' => '

The ID of the endpoint that the rule is associated with.

', 'ResolverRuleAssociation$Id' => '

The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

', 'ResolverRuleAssociation$ResolverRuleId' => '

The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.

', 'ResolverRuleAssociation$VPCId' => '

The ID of the VPC that you associated the Resolver rule with.

', 'ResolverRuleConfig$ResolverEndpointId' => '

The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

', 'SecurityGroupIds$member' => NULL, 'UpdateFirewallConfigRequest$ResourceId' => '

The ID of the VPC that the configuration is for.

', 'UpdateFirewallDomainsRequest$FirewallDomainListId' => '

The ID of the domain list whose domains you want to update.

', 'UpdateFirewallDomainsResponse$Id' => '

The ID of the firewall domain list that DNS Firewall just updated.

', 'UpdateFirewallRuleGroupAssociationRequest$FirewallRuleGroupAssociationId' => '

The identifier of the FirewallRuleGroupAssociation.

', 'UpdateFirewallRuleRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group for the rule.

', 'UpdateFirewallRuleRequest$FirewallDomainListId' => '

The ID of the domain list to use in the rule.

', 'UpdateIpAddress$IpId' => '

The ID of the IP address, specified by the ResolverEndpointId.

', 'UpdateOutpostResolverRequest$Id' => '

A unique string that identifies Resolver on an Outpost.

', 'UpdateResolverConfigRequest$ResourceId' => '

Resource ID of the Amazon VPC that you want to update the Resolver configuration for.

', 'UpdateResolverDnssecConfigRequest$ResourceId' => '

The ID of the virtual private cloud (VPC) that you\'re updating the DNSSEC validation status for.

', 'UpdateResolverEndpointRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to update.

', 'UpdateResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to update.

', ], ], 'ResourceInUseException' => [ 'base' => '

The resource that you tried to update or delete is currently in use.

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

The specified resource doesn\'t exist.

', 'refs' => [], ], 'ResourceUnavailableException' => [ 'base' => '

The specified resource isn\'t available.

', 'refs' => [], ], 'Rfc3339TimeString' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$CreationTime' => '

The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallDomainList$ModificationTime' => '

The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRule$CreationTime' => '

The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRule$ModificationTime' => '

The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroup$CreationTime' => '

The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroup$ModificationTime' => '

The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroupAssociation$CreationTime' => '

The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroupAssociation$ModificationTime' => '

The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'IpAddressResponse$CreationTime' => '

The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

', 'IpAddressResponse$ModificationTime' => '

The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'OutpostResolver$CreationTime' => '

The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).

', 'OutpostResolver$ModificationTime' => '

The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverEndpoint$CreationTime' => '

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverEndpoint$ModificationTime' => '

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverQueryLogConfig$CreationTime' => '

The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverQueryLogConfigAssociation$CreationTime' => '

The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverRule$CreationTime' => '

The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverRule$ModificationTime' => '

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

', ], ], 'RuleTypeOption' => [ 'base' => NULL, 'refs' => [ 'CreateResolverRuleRequest$RuleType' => '

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

', 'ResolverRule$RuleType' => '

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

', ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$SecurityGroupIds' => '

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you\'re using for DNS queries on your network.

', 'ResolverEndpoint$SecurityGroupIds' => '

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you\'re using for DNS queries on your network.

', ], ], 'ServicePrinciple' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$ManagedOwnerName' => '

The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

', 'FirewallDomainListMetadata$ManagedOwnerName' => '

The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

', 'FirewallRuleGroupAssociation$ManagedOwnerName' => '

The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

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

Fulfilling the request would cause one or more quotas to be exceeded.

', 'refs' => [], ], 'ShareStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallRuleGroup$ShareStatus' => '

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

', 'FirewallRuleGroupMetadata$ShareStatus' => '

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

', 'ResolverQueryLogConfig$ShareStatus' => '

An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

', 'ResolverRule$ShareStatus' => '

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

', ], ], 'SortByKey' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsRequest$SortBy' => '

The element that you want Resolver to sort query logging associations by.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

', 'ListResolverQueryLogConfigsRequest$SortBy' => '

The element that you want Resolver to sort query logging configurations by.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsRequest$SortOrder' => '

If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

', 'ListResolverQueryLogConfigsRequest$SortOrder' => '

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$StatusMessage' => '

Additional information about the status of the list, if available.

', 'FirewallRuleGroup$StatusMessage' => '

Additional information about the status of the rule group, if available.

', 'FirewallRuleGroupAssociation$StatusMessage' => '

Additional information about the status of the response, if available.

', 'ImportFirewallDomainsResponse$StatusMessage' => '

Additional information about the status of the list, if available.

', 'IpAddressResponse$StatusMessage' => '

A message that provides additional information about the status of the request.

', 'ResolverEndpoint$StatusMessage' => '

A detailed description of the status of the Resolver endpoint.

', 'ResolverRule$StatusMessage' => '

A detailed description of the status of a Resolver rule.

', 'ResolverRuleAssociation$StatusMessage' => '

A detailed description of the status of the association between a Resolver rule and a VPC.

', 'UpdateFirewallDomainsResponse$StatusMessage' => '

Additional information about the status of the list, if available.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$FieldName' => '

For an InvalidParameterException error, the name of the parameter that\'s invalid.

', 'LimitExceededException$Message' => NULL, 'LimitExceededException$ResourceType' => '

For a LimitExceededException error, the type of resource that exceeded the current limit.

', 'ResourceExistsException$Message' => NULL, 'ResourceExistsException$ResourceType' => '

For a ResourceExistsException error, the type of resource that the error applies to.

', 'ResourceInUseException$Message' => NULL, 'ResourceInUseException$ResourceType' => '

For a ResourceInUseException error, the type of resource that is currently in use.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$ResourceType' => '

For a ResourceNotFoundException error, the type of resource that doesn\'t exist.

', 'ResourceUnavailableException$Message' => NULL, 'ResourceUnavailableException$ResourceType' => '

For a ResourceUnavailableException error, the type of resource that isn\'t available.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'IpAddressRequest$SubnetId' => '

The ID of the subnet that contains the IP address.

', 'IpAddressResponse$SubnetId' => '

The ID of one subnet.

', 'IpAddressUpdate$SubnetId' => '

The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

', ], ], 'Tag' => [ 'base' => '

One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tags that you want to remove to the specified resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$Tags' => '

A list of the tag keys and values that you want to associate with the rule group association.

', 'CreateFirewallDomainListRequest$Tags' => '

A list of the tag keys and values that you want to associate with the domain list.

', 'CreateFirewallRuleGroupRequest$Tags' => '

A list of the tag keys and values that you want to associate with the rule group.

', 'CreateOutpostResolverRequest$Tags' => '

A string that helps identify the Route 53 Resolvers on Outpost.

', 'CreateResolverEndpointRequest$Tags' => '

A list of the tag keys and values that you want to associate with the endpoint.

', 'CreateResolverQueryLogConfigRequest$Tags' => '

A list of the tag keys and values that you want to associate with the query logging configuration.

', 'CreateResolverRuleRequest$Tags' => '

A list of the tag keys and values that you want to associate with the endpoint.

', 'ListTagsForResourceResponse$Tags' => '

The tags that are associated with the resource that you specified in the ListTagsForResource request.

', 'TagResourceRequest$Tags' => '

The tags that you want to add to the specified resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you\'re creating the resource for.

', ], ], 'TargetAddress' => [ 'base' => '

In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

', 'refs' => [ 'TargetList$member' => NULL, ], ], 'TargetList' => [ 'base' => NULL, 'refs' => [ 'CreateResolverRuleRequest$TargetIps' => '

The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

TargetIps is available only when the value of Rule type is FORWARD.

', 'ResolverRule$TargetIps' => '

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.

', 'ResolverRuleConfig$TargetIps' => '

For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

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

The request was throttled. Try again in a few minutes.

', 'refs' => [], ], 'UnknownResourceException' => [ 'base' => '

The specified resource doesn\'t exist.

', 'refs' => [], ], 'Unsigned' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$DomainCount' => '

The number of domain names that are specified in the domain list.

', 'FirewallRule$BlockOverrideTtl' => '

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', 'FirewallRuleGroup$RuleCount' => '

The number of rules in the rule group.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleGroupAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleGroupAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIpAddress' => [ 'base' => '

Provides information about the IP address type in response to UpdateResolverEndpoint.

', 'refs' => [ 'UpdateIpAddresses$member' => NULL, ], ], 'UpdateIpAddresses' => [ 'base' => NULL, 'refs' => [ 'UpdateResolverEndpointRequest$UpdateIpAddresses' => '

Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don\'t specify an IPv6 address, one will be automatically chosen from your subnet.

', ], ], 'UpdateOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverDnssecConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverDnssecConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'Validation' => [ 'base' => NULL, 'refs' => [ 'UpdateResolverDnssecConfigRequest$Validation' => '

The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status change to be completed.

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

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

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

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or Elastic Load Balancing load balancers. Resolver performs recursive lookups against public name servers for all other domain names.

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

Forward DNS queries from resolvers on your network to Route 53 Resolver

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

Conditionally forward queries from a VPC to resolvers on your network

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.

', 'operations' => [ 'AssociateFirewallRuleGroup' => '

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

', 'AssociateResolverEndpointIpAddress' => '

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

', 'AssociateResolverQueryLogConfig' => '

Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.

The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.

', 'AssociateResolverRule' => '

Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.

', 'CreateFirewallDomainList' => '

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

', 'CreateFirewallRule' => '

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

', 'CreateFirewallRuleGroup' => '

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.

', 'CreateOutpostResolver' => '

Creates a Route 53 Resolver on an Outpost.

', 'CreateResolverEndpoint' => '

Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:

', 'CreateResolverQueryLogConfig' => '

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig.

You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.

', 'CreateResolverRule' => '

For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

', 'DeleteFirewallDomainList' => '

Deletes the specified domain list.

', 'DeleteFirewallRule' => '

Deletes the specified firewall rule.

', 'DeleteFirewallRuleGroup' => '

Deletes the specified firewall rule group.

', 'DeleteOutpostResolver' => '

Deletes a Resolver on the Outpost.

', 'DeleteResolverEndpoint' => '

Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it\'s an inbound or an outbound Resolver endpoint:

', 'DeleteResolverQueryLogConfig' => '

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that\'s not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.

', 'DeleteResolverRule' => '

Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see DisassociateResolverRule.

', 'DisassociateFirewallRuleGroup' => '

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

', 'DisassociateResolverEndpointIpAddress' => '

Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

', 'DisassociateResolverQueryLogConfig' => '

Disassociates a VPC from a query logging configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:

', 'DisassociateResolverRule' => '

Removes the association between a specified Resolver rule and a specified VPC.

If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the Resolver rule.

', 'GetFirewallConfig' => '

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

', 'GetFirewallDomainList' => '

Retrieves the specified firewall domain list.

', 'GetFirewallRuleGroup' => '

Retrieves the specified firewall rule group.

', 'GetFirewallRuleGroupAssociation' => '

Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.

', 'GetFirewallRuleGroupPolicy' => '

Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

', 'GetOutpostResolver' => '

Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.

', 'GetResolverConfig' => '

Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

', 'GetResolverDnssecConfig' => '

Gets DNSSEC validation information for a specified resource.

', 'GetResolverEndpoint' => '

Gets information about a specified Resolver endpoint, such as whether it\'s an inbound or an outbound Resolver endpoint, and the current status of the endpoint.

', 'GetResolverQueryLogConfig' => '

Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.

', 'GetResolverQueryLogConfigAssociation' => '

Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.

', 'GetResolverQueryLogConfigPolicy' => '

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another Amazon Web Services account to be able to use.

', 'GetResolverRule' => '

Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with.

', 'GetResolverRuleAssociation' => '

Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule.

', 'GetResolverRulePolicy' => '

Gets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use.

', 'ImportFirewallDomains' => '

Imports domain names from a file into a domain list, for use in a DNS firewall rule group.

Each domain specification in your domain list must satisfy the following requirements:

', 'ListFirewallConfigs' => '

Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.

A single call might return only a partial list of the configurations. For information, see MaxResults.

', 'ListFirewallDomainLists' => '

Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains.

A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.

', 'ListFirewallDomains' => '

Retrieves the domains that you have defined for the specified firewall domain list.

A single call might return only a partial list of the domains. For information, see MaxResults.

', 'ListFirewallRuleGroupAssociations' => '

Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.

A single call might return only a partial list of the associations. For information, see MaxResults.

', 'ListFirewallRuleGroups' => '

Retrieves the minimal high-level information for the rule groups that you have defined.

A single call might return only a partial list of the rule groups. For information, see MaxResults.

', 'ListFirewallRules' => '

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

', 'ListOutpostResolvers' => '

Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.

', 'ListResolverConfigs' => '

Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.

', 'ListResolverDnssecConfigs' => '

Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.

', 'ListResolverEndpointIpAddresses' => '

Gets the IP addresses for a specified Resolver endpoint.

', 'ListResolverEndpoints' => '

Lists all the Resolver endpoints that were created using the current Amazon Web Services account.

', 'ListResolverQueryLogConfigAssociations' => '

Lists information about associations between Amazon VPCs and query logging configurations.

', 'ListResolverQueryLogConfigs' => '

Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.

', 'ListResolverRuleAssociations' => '

Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.

', 'ListResolverRules' => '

Lists the Resolver rules that were created using the current Amazon Web Services account.

', 'ListTagsForResource' => '

Lists the tags that you associated with the specified resource.

', 'PutFirewallRuleGroupPolicy' => '

Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

', 'PutResolverQueryLogConfigPolicy' => '

Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.

', 'PutResolverRulePolicy' => '

Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.

', 'TagResource' => '

Adds one or more tags to a specified resource.

', 'UntagResource' => '

Removes one or more tags from a specified resource.

', 'UpdateFirewallConfig' => '

Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

', 'UpdateFirewallDomains' => '

Updates the firewall domain list from an array of domain specifications.

', 'UpdateFirewallRule' => '

Updates the specified firewall rule.

', 'UpdateFirewallRuleGroupAssociation' => '

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

', 'UpdateOutpostResolver' => '

You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.

', 'UpdateResolverConfig' => '

Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

', 'UpdateResolverDnssecConfig' => '

Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.

', 'UpdateResolverEndpoint' => '

Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can\'t be updated to other type.

', 'UpdateResolverRule' => '

Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don\'t specify a parameter, it retains its current value.

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

The current account doesn\'t have the IAM permissions required to perform the specified Resolver operation.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'FirewallConfig$OwnerId' => '

The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.

', 'FirewallRuleGroup$OwnerId' => '

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

', 'FirewallRuleGroupMetadata$OwnerId' => '

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

', 'ResolverConfig$OwnerId' => '

The owner account ID of the Amazon Virtual Private Cloud VPC.

', 'ResolverDnssecConfig$OwnerId' => '

The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.

', 'ResolverQueryLogConfig$OwnerId' => '

The Amazon Web Services account ID for the account that created the query logging configuration.

', 'ResolverRule$OwnerId' => '

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$Action' => '

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', 'FirewallRule$Action' => '

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', 'ListFirewallRulesRequest$Action' => '

Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', 'UpdateFirewallRuleRequest$Action' => '

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule\'s domain list:

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$Arn' => '

The Amazon Resource Name (ARN) of the firewall domain list.

', 'FirewallDomainListMetadata$Arn' => '

The Amazon Resource Name (ARN) of the firewall domain list metadata.

', 'FirewallRuleGroup$Arn' => '

The ARN (Amazon Resource Name) of the rule group.

', 'FirewallRuleGroupAssociation$Arn' => '

The Amazon Resource Name (ARN) of the firewall rule group association.

', 'FirewallRuleGroupMetadata$Arn' => '

The ARN (Amazon Resource Name) of the rule group.

', 'GetFirewallRuleGroupPolicyRequest$Arn' => '

The ARN (Amazon Resource Name) for the rule group.

', 'GetResolverQueryLogConfigPolicyRequest$Arn' => '

The ARN of the query logging configuration that you want to get the query logging policy for.

', 'GetResolverRulePolicyRequest$Arn' => '

The ID of the Resolver rule that you want to get the Resolver rule policy for.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) for the resource that you want to list tags for.

', 'OutpostResolver$Arn' => '

The ARN (Amazon Resource Name) for the Resolver on an Outpost.

', 'PutFirewallRuleGroupPolicyRequest$Arn' => '

The ARN (Amazon Resource Name) for the rule group that you want to share.

', 'PutResolverQueryLogConfigPolicyRequest$Arn' => '

The Amazon Resource Name (ARN) of the account that you want to share rules with.

', 'PutResolverRulePolicyRequest$Arn' => '

The Amazon Resource Name (ARN) of the rule that you want to share with another account.

', 'ResolverEndpoint$Arn' => '

The ARN (Amazon Resource Name) for the Resolver endpoint.

', 'ResolverQueryLogConfig$Arn' => '

The ARN for the query logging configuration.

', 'ResolverRule$Arn' => '

The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:

', ], ], 'AssociateFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverEndpointIpAddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverEndpointIpAddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'AutodefinedReverseFlag' => [ 'base' => NULL, 'refs' => [ 'UpdateResolverConfigRequest$AutodefinedReverseFlag' => '

Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.

It can take some time for the status change to be completed.

', ], ], 'BlockOverrideDnsType' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockOverrideDnsType' => '

The DNS record\'s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

', 'FirewallRule$BlockOverrideDnsType' => '

The DNS record\'s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', 'UpdateFirewallRuleRequest$BlockOverrideDnsType' => '

The DNS record\'s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', ], ], 'BlockOverrideDomain' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockOverrideDomain' => '

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

', 'FirewallRule$BlockOverrideDomain' => '

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', 'UpdateFirewallRuleRequest$BlockOverrideDomain' => '

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', ], ], 'BlockOverrideTtl' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockOverrideTtl' => '

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

', 'UpdateFirewallRuleRequest$BlockOverrideTtl' => '

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', ], ], 'BlockResponse' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$BlockResponse' => '

The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

This setting is required if the rule action setting is BLOCK.

', 'FirewallRule$BlockResponse' => '

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

', 'UpdateFirewallRuleRequest$BlockResponse' => '

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'PutFirewallRuleGroupPolicyResponse$ReturnValue' => '

', 'PutResolverQueryLogConfigPolicyResponse$ReturnValue' => '

Whether the PutResolverQueryLogConfigPolicy request was successful.

', 'PutResolverRulePolicyResponse$ReturnValue' => '

Whether the PutResolverRulePolicy request was successful.

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

The requested state transition isn\'t valid. For example, you can\'t delete a firewall domain list if it is in the process of being deleted, or you can\'t import domains into a domain list that is in the process of being deleted.

', 'refs' => [], ], 'Count' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsResponse$TotalCount' => '

The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.

', 'ListResolverQueryLogConfigAssociationsResponse$TotalFilteredCount' => '

The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.

', 'ListResolverQueryLogConfigsResponse$TotalCount' => '

The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.

', 'ListResolverQueryLogConfigsResponse$TotalFilteredCount' => '

The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see TotalCount.

', 'ResolverQueryLogConfig$AssociationCount' => '

The number of VPCs that are associated with the query logging configuration.

', ], ], 'CreateFirewallDomainListRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallDomainListResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFirewallRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatorRequestId' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateFirewallDomainListRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateFirewallRuleGroupRequest$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'CreateFirewallRuleRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateOutpostResolverRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.

CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateResolverEndpointRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateResolverQueryLogConfigRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'CreateResolverRuleRequest$CreatorRequestId' => '

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

', 'FirewallDomainList$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallDomainListMetadata$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRule$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRuleGroup$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRuleGroupAssociation$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'FirewallRuleGroupMetadata$CreatorRequestId' => '

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

', 'OutpostResolver$CreatorRequestId' => '

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

', 'ResolverEndpoint$CreatorRequestId' => '

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

', 'ResolverQueryLogConfig$CreatorRequestId' => '

A unique string that identifies the request that created the query logging configuration. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

', 'ResolverRule$CreatorRequestId' => '

A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.

', ], ], 'DeleteFirewallDomainListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallDomainListResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationArn' => [ 'base' => NULL, 'refs' => [ 'CreateResolverQueryLogConfigRequest$DestinationArn' => '

The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

', 'ResolverQueryLogConfig$DestinationArn' => '

The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

', ], ], 'DisassociateFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverEndpointIpAddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverEndpointIpAddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DomainListFileUrl' => [ 'base' => NULL, 'refs' => [ 'ImportFirewallDomainsRequest$DomainFileUrl' => '

The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

The file must be in an S3 bucket that\'s in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateResolverRuleRequest$DomainName' => '

DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).

', 'ResolverRule$DomainName' => '

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'InternalServiceErrorException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidPolicyDocument$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'InvalidTagException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'UnknownResourceException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'Filter' => [ 'base' => '

For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.

To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

The name of the parameter that you want to use to filter objects.

The valid values for Name depend on the action that you\'re including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

ListResolverEndpoints

Valid values for Name include the following:

ListResolverRules

Valid values for Name include the following:

ListResolverRuleAssociations

Valid values for Name include the following:

ListResolverQueryLogConfigs

Valid values for Name include the following:

ListResolverQueryLogConfigAssociations

Valid values for Name include the following:

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValues$member' => NULL, ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

When you\'re using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

', ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'ListResolverDnssecConfigsRequest$Filters' => '

An optional specification to return a subset of objects.

', 'ListResolverEndpointsRequest$Filters' => '

An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverQueryLogConfigAssociationsRequest$Filters' => '

An optional specification to return a subset of query logging associations.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverQueryLogConfigsRequest$Filters' => '

An optional specification to return a subset of query logging configurations.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverRuleAssociationsRequest$Filters' => '

An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.

If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', 'ListResolverRulesRequest$Filters' => '

An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.

If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

', ], ], 'FirewallConfig' => [ 'base' => '

Configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

', 'refs' => [ 'FirewallConfigList$member' => NULL, 'GetFirewallConfigResponse$FirewallConfig' => '

Configuration of the firewall behavior provided by DNS Firewall for a single VPC from AmazonVPC.

', 'UpdateFirewallConfigResponse$FirewallConfig' => '

Configuration of the firewall behavior provided by DNS Firewall for a single VPC.

', ], ], 'FirewallConfigList' => [ 'base' => NULL, 'refs' => [ 'ListFirewallConfigsResponse$FirewallConfigs' => '

The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC).

', ], ], 'FirewallDomainImportOperation' => [ 'base' => NULL, 'refs' => [ 'ImportFirewallDomainsRequest$Operation' => '

What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list in the file.

', ], ], 'FirewallDomainList' => [ 'base' => '

High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList.

To retrieve the domains that are defined for this domain list, call ListFirewallDomains.

', 'refs' => [ 'CreateFirewallDomainListResponse$FirewallDomainList' => '

The domain list that you just created.

', 'DeleteFirewallDomainListResponse$FirewallDomainList' => '

The domain list that you just deleted.

', 'GetFirewallDomainListResponse$FirewallDomainList' => '

The domain list that you requested.

', ], ], 'FirewallDomainListMetadata' => [ 'base' => '

Minimal high-level information for a firewall domain list. The action ListFirewallDomainLists returns an array of these objects.

To retrieve full information for a firewall domain list, call GetFirewallDomainList and ListFirewallDomains.

', 'refs' => [ 'FirewallDomainListMetadataList$member' => NULL, ], ], 'FirewallDomainListMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainListsResponse$FirewallDomainLists' => '

A list of the domain lists that you have defined.

This might be a partial list of the domain lists that you\'ve defined. For information, see MaxResults.

', ], ], 'FirewallDomainListStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$Status' => '

The status of the domain list.

', 'ImportFirewallDomainsResponse$Status' => '

Status of the import request.

', 'UpdateFirewallDomainsResponse$Status' => '

Status of the UpdateFirewallDomains request.

', ], ], 'FirewallDomainName' => [ 'base' => NULL, 'refs' => [ 'FirewallDomains$member' => NULL, ], ], 'FirewallDomainRedirectionAction' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$FirewallDomainRedirectionAction' => '

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.

Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.

Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don\'t need to add the subsequent domains in the redirection list to the domain alloww list.

', 'FirewallRule$FirewallDomainRedirectionAction' => '

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.

Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.

Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don\'t need to add the subsequent domains in the domain in the redirection list to the domain alloww list.

', 'UpdateFirewallRuleRequest$FirewallDomainRedirectionAction' => '

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.

Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.

Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don\'t need to add the subsequent domains in the domain in the redirection list to the domain alloww list.

', ], ], 'FirewallDomainUpdateOperation' => [ 'base' => NULL, 'refs' => [ 'UpdateFirewallDomainsRequest$Operation' => '

What you want DNS Firewall to do with the domains that you are providing:

', ], ], 'FirewallDomains' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainsResponse$Domains' => '

A list of the domains in the firewall domain list.

This might be a partial list of the domains that you\'ve defined in the domain list. For information, see MaxResults.

', 'UpdateFirewallDomainsRequest$Domains' => '

A list of domains to use in the update operation.

There is a limit of 1000 domains per request.

Each domain specification in your domain list must satisfy the following requirements:

', ], ], 'FirewallFailOpenStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallConfig$FirewallFailOpen' => '

Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

', 'UpdateFirewallConfigRequest$FirewallFailOpen' => '

Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

', ], ], 'FirewallRule' => [ 'base' => '

A single firewall rule in a rule group.

', 'refs' => [ 'CreateFirewallRuleResponse$FirewallRule' => '

The firewall rule that you just created.

', 'DeleteFirewallRuleResponse$FirewallRule' => '

The specification for the firewall rule that you just deleted.

', 'FirewallRules$member' => NULL, 'UpdateFirewallRuleResponse$FirewallRule' => '

The firewall rule that you just updated.

', ], ], 'FirewallRuleGroup' => [ 'base' => '

High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call ListFirewallRules.

', 'refs' => [ 'CreateFirewallRuleGroupResponse$FirewallRuleGroup' => '

A collection of rules used to filter DNS network traffic.

', 'DeleteFirewallRuleGroupResponse$FirewallRuleGroup' => '

A collection of rules used to filter DNS network traffic.

', 'GetFirewallRuleGroupResponse$FirewallRuleGroup' => '

A collection of rules used to filter DNS network traffic.

', ], ], 'FirewallRuleGroupAssociation' => [ 'base' => '

An association between a firewall rule group and a VPC, which enables DNS filtering for the VPC.

', 'refs' => [ 'AssociateFirewallRuleGroupResponse$FirewallRuleGroupAssociation' => '

The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.

', 'DisassociateFirewallRuleGroupResponse$FirewallRuleGroupAssociation' => '

The firewall rule group association that you just removed.

', 'FirewallRuleGroupAssociations$member' => NULL, 'GetFirewallRuleGroupAssociationResponse$FirewallRuleGroupAssociation' => '

The association that you requested.

', 'UpdateFirewallRuleGroupAssociationResponse$FirewallRuleGroupAssociation' => '

The association that you just updated.

', ], ], 'FirewallRuleGroupAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallRuleGroupAssociation$Status' => '

The current status of the association.

', 'ListFirewallRuleGroupAssociationsRequest$Status' => '

The association Status setting that you want DNS Firewall to filter on for the list. If you don\'t specify this, then DNS Firewall returns all associations, regardless of status.

', ], ], 'FirewallRuleGroupAssociations' => [ 'base' => NULL, 'refs' => [ 'ListFirewallRuleGroupAssociationsResponse$FirewallRuleGroupAssociations' => '

A list of your firewall rule group associations.

This might be a partial list of the associations that you have defined. For information, see MaxResults.

', ], ], 'FirewallRuleGroupMetadata' => [ 'base' => '

Minimal high-level information for a firewall rule group. The action ListFirewallRuleGroups returns an array of these objects.

To retrieve full information for a firewall rule group, call GetFirewallRuleGroup and ListFirewallRules.

', 'refs' => [ 'FirewallRuleGroupMetadataList$member' => NULL, ], ], 'FirewallRuleGroupMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListFirewallRuleGroupsResponse$FirewallRuleGroups' => '

A list of your firewall rule groups.

This might be a partial list of the rule groups that you have defined. For information, see MaxResults.

', ], ], 'FirewallRuleGroupPolicy' => [ 'base' => NULL, 'refs' => [ 'GetFirewallRuleGroupPolicyResponse$FirewallRuleGroupPolicy' => '

The Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

', 'PutFirewallRuleGroupPolicyRequest$FirewallRuleGroupPolicy' => '

The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.

', ], ], 'FirewallRuleGroupStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallRuleGroup$Status' => '

The status of the domain list.

', ], ], 'FirewallRules' => [ 'base' => NULL, 'refs' => [ 'ListFirewallRulesResponse$FirewallRules' => '

A list of the rules that you have defined.

This might be a partial list of the firewall rules that you\'ve defined. For information, see MaxResults.

', ], ], 'GetFirewallConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallDomainListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallDomainListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFirewallRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverDnssecConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverDnssecConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverQueryLogConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRulePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportFirewallDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportFirewallDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'InstanceCount' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$InstanceCount' => '

Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.

', 'OutpostResolver$InstanceCount' => '

Amazon EC2 instance count for the Resolver on the Outpost.

', 'UpdateOutpostResolverRequest$InstanceCount' => '

The Amazon EC2 instance count for a Resolver on the Outpost.

', ], ], 'InternalServiceErrorException' => [ 'base' => '

We encountered an unknown error. Try again in a few minutes.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The value that you specified for NextToken in a List request isn\'t valid.

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

One or more parameters in this request are not valid.

', 'refs' => [], ], 'InvalidPolicyDocument' => [ 'base' => '

The specified Resolver rule policy is invalid.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

The request is invalid.

', 'refs' => [], ], 'InvalidTagException' => [ 'base' => '

The specified tag is invalid.

', 'refs' => [], ], 'Ip' => [ 'base' => NULL, 'refs' => [ 'IpAddressRequest$Ip' => '

The IPv4 address that you want to use for DNS queries.

', 'IpAddressResponse$Ip' => '

One IPv4 address that the Resolver endpoint uses for DNS queries.

', 'IpAddressUpdate$Ip' => '

The new IPv4 address.

', 'TargetAddress$Ip' => '

One IPv4 address that you want to forward DNS queries to.

', ], ], 'IpAddressCount' => [ 'base' => NULL, 'refs' => [ 'ResolverEndpoint$IpAddressCount' => '

The number of IP addresses that the Resolver endpoint can use for DNS queries.

', ], ], 'IpAddressRequest' => [ 'base' => '

In a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). IpAddressRequest also includes the ID of the subnet that contains the IP address.

', 'refs' => [ 'IpAddressesRequest$member' => NULL, ], ], 'IpAddressResponse' => [ 'base' => '

In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.

', 'refs' => [ 'IpAddressesResponse$member' => NULL, ], ], 'IpAddressStatus' => [ 'base' => NULL, 'refs' => [ 'IpAddressResponse$Status' => '

A status code that gives the current status of the request.

', ], ], 'IpAddressUpdate' => [ 'base' => '

In an UpdateResolverEndpoint request, information about an IP address to update.

', 'refs' => [ 'AssociateResolverEndpointIpAddressRequest$IpAddress' => '

Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

', 'DisassociateResolverEndpointIpAddressRequest$IpAddress' => '

The IPv4 address that you want to remove from a Resolver endpoint.

', ], ], 'IpAddressesRequest' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$IpAddresses' => '

The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

Even though the minimum is 1, Route 53 requires that you create at least two.

', ], ], 'IpAddressesResponse' => [ 'base' => NULL, 'refs' => [ 'ListResolverEndpointIpAddressesResponse$IpAddresses' => '

Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

', ], ], 'Ipv6' => [ 'base' => NULL, 'refs' => [ 'IpAddressRequest$Ipv6' => '

The IPv6 address that you want to use for DNS queries.

', 'IpAddressResponse$Ipv6' => '

One IPv6 address that the Resolver endpoint uses for DNS queries.

', 'IpAddressUpdate$Ipv6' => '

The new IPv6 address.

', 'TargetAddress$Ipv6' => '

One IPv6 address that you want to forward DNS queries to.

', 'UpdateIpAddress$Ipv6' => '

The IPv6 address that you want to use for DNS queries.

', ], ], 'LimitExceededException' => [ 'base' => '

The request caused one or more limits to be exceeded.

', 'refs' => [], ], 'ListDomainMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', ], ], 'ListFirewallConfigsMaxResult' => [ 'base' => NULL, 'refs' => [ 'ListFirewallConfigsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', ], ], 'ListFirewallConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFirewallRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOutpostResolversRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOutpostResolversResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverConfigsMaxResult' => [ 'base' => NULL, 'refs' => [ 'ListResolverConfigsRequest$MaxResults' => '

The maximum number of Resolver configurations that you want to return in the response to a ListResolverConfigs request. If you don\'t specify a value for MaxResults, up to 100 Resolver configurations are returned.

', ], ], 'ListResolverConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverDnssecConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverDnssecConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointIpAddressesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointIpAddressesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverQueryLogConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRuleAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRuleAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolverRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFirewallDomainListsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListFirewallRuleGroupAssociationsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListFirewallRuleGroupsRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListFirewallRulesRequest$MaxResults' => '

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don\'t specify a value for MaxResults, Resolver returns up to 100 objects.

', 'ListOutpostResolversRequest$MaxResults' => '

The maximum number of Resolvers on the Outpost that you want to return in the response to a ListOutpostResolver request. If you don\'t specify a value for MaxResults, the request returns up to 100 Resolvers.

', 'ListResolverDnssecConfigsRequest$MaxResults' => '

Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want Amazon Route 53 to return. If you don\'t specify a value for MaxResults, Route 53 returns up to 100 configuration per page.

', 'ListResolverEndpointIpAddressesRequest$MaxResults' => '

The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 IP addresses.

', 'ListResolverEndpointIpAddressesResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListResolverEndpointsRequest$MaxResults' => '

The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.

', 'ListResolverEndpointsResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListResolverQueryLogConfigAssociationsRequest$MaxResults' => '

The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 query logging associations.

', 'ListResolverQueryLogConfigsRequest$MaxResults' => '

The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

', 'ListResolverRuleAssociationsRequest$MaxResults' => '

The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 rule associations.

', 'ListResolverRuleAssociationsResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListResolverRulesRequest$MaxResults' => '

The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 Resolver rules.

', 'ListResolverRulesResponse$MaxResults' => '

The value that you specified for MaxResults in the request.

', 'ListTagsForResourceRequest$MaxResults' => '

The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don\'t specify a value for MaxResults, Resolver returns up to 100 tags.

', ], ], 'MutationProtectionStatus' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$MutationProtection' => '

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. When you create the association, the default setting is DISABLED.

', 'FirewallRuleGroupAssociation$MutationProtection' => '

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

', 'UpdateFirewallRuleGroupAssociationRequest$MutationProtection' => '

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$Name' => '

A name that lets you identify the association, to manage and use it.

', 'AssociateResolverRuleRequest$Name' => '

A name for the association that you\'re creating between a Resolver rule and a VPC.

', 'CreateFirewallDomainListRequest$Name' => '

A name that lets you identify the domain list to manage and use it.

', 'CreateFirewallRuleGroupRequest$Name' => '

A name that lets you identify the rule group, to manage and use it.

', 'CreateFirewallRuleRequest$Name' => '

A name that lets you identify the rule in the rule group.

', 'CreateResolverEndpointRequest$Name' => '

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

', 'CreateResolverRuleRequest$Name' => '

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

', 'FirewallDomainList$Name' => '

The name of the domain list.

', 'FirewallDomainListMetadata$Name' => '

The name of the domain list.

', 'FirewallRule$Name' => '

The name of the rule.

', 'FirewallRuleGroup$Name' => '

The name of the rule group.

', 'FirewallRuleGroupAssociation$Name' => '

The name of the association.

', 'FirewallRuleGroupMetadata$Name' => '

The name of the rule group.

', 'ImportFirewallDomainsResponse$Name' => '

The name of the domain list.

', 'ResolverEndpoint$Name' => '

The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

', 'ResolverRule$Name' => '

The name for the Resolver rule, which you specified when you created the Resolver rule.

', 'ResolverRuleAssociation$Name' => '

The name of an association between a Resolver rule and a VPC.

', 'ResolverRuleConfig$Name' => '

The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

', 'UpdateFirewallDomainsResponse$Name' => '

The name of the domain list.

', 'UpdateFirewallRuleGroupAssociationRequest$Name' => '

The name of the rule group association.

', 'UpdateFirewallRuleRequest$Name' => '

The name of the rule.

', 'UpdateResolverEndpointRequest$Name' => '

The name of the Resolver endpoint that you want to update.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListFirewallConfigsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallConfigsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallDomainListsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallDomainListsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallDomainsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallDomainsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallRuleGroupAssociationsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallRuleGroupAssociationsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallRuleGroupsRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallRuleGroupsResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListFirewallRulesRequest$NextToken' => '

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

', 'ListFirewallRulesResponse$NextToken' => '

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

', 'ListOutpostResolversRequest$NextToken' => '

For the first ListOutpostResolver request, omit this value.

', 'ListOutpostResolversResponse$NextToken' => '

If more than MaxResults Resolvers match the specified criteria, you can submit another ListOutpostResolver request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverConfigsRequest$NextToken' => '

(Optional) If the current Amazon Web Services account has more than MaxResults Resolver configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

', 'ListResolverConfigsResponse$NextToken' => '

If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, NextToken doesn\'t appear in the response.

If a response doesn\'t include the last of the configurations, you can get more configurations by submitting another ListResolverConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

', 'ListResolverDnssecConfigsRequest$NextToken' => '

(Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverDnssecConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

', 'ListResolverDnssecConfigsResponse$NextToken' => '

If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, NextToken doesn\'t appear in the response.

If a response doesn\'t include the last of the configurations, you can get more configurations by submitting another ListResolverDnssecConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

', 'ListResolverEndpointIpAddressesRequest$NextToken' => '

For the first ListResolverEndpointIpAddresses request, omit this value.

If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverEndpointIpAddressesResponse$NextToken' => '

If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverEndpointsRequest$NextToken' => '

For the first ListResolverEndpoints request, omit this value.

If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverEndpointsResponse$NextToken' => '

If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigAssociationsRequest$NextToken' => '

For the first ListResolverQueryLogConfigAssociations request, omit this value.

If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigAssociationsResponse$NextToken' => '

If there are more than MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigsRequest$NextToken' => '

For the first ListResolverQueryLogConfigs request, omit this value.

If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverQueryLogConfigsResponse$NextToken' => '

If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRuleAssociationsRequest$NextToken' => '

For the first ListResolverRuleAssociation request, omit this value.

If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRuleAssociationsResponse$NextToken' => '

If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRulesRequest$NextToken' => '

For the first ListResolverRules request, omit this value.

If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.

', 'ListResolverRulesResponse$NextToken' => '

If more than MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', 'ListTagsForResourceRequest$NextToken' => '

For the first ListTagsForResource request, omit this value.

If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

', 'ListTagsForResourceResponse$NextToken' => '

If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

', ], ], 'OutpostArn' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$OutpostArn' => '

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

', 'CreateResolverEndpointRequest$OutpostArn' => '

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

', 'ListOutpostResolversRequest$OutpostArn' => '

The Amazon Resource Name (ARN) of the Outpost.

', 'OutpostResolver$OutpostArn' => '

The ARN (Amazon Resource Name) for the Outpost.

', 'ResolverEndpoint$OutpostArn' => '

The ARN (Amazon Resource Name) for the Outpost.

', ], ], 'OutpostInstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$PreferredInstanceType' => '

The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.

', 'CreateResolverEndpointRequest$PreferredInstanceType' => '

The instance type. If you specify this, you must also specify a value for the OutpostArn.

', 'OutpostResolver$PreferredInstanceType' => '

The Amazon EC2 instance type.

', 'ResolverEndpoint$PreferredInstanceType' => '

The Amazon EC2 instance type.

', 'UpdateOutpostResolverRequest$PreferredInstanceType' => '

Amazon EC2 instance type.

', ], ], 'OutpostResolver' => [ 'base' => '

A complex type that contains settings for an existing Resolver on an Outpost.

', 'refs' => [ 'CreateOutpostResolverResponse$OutpostResolver' => '

Information about the CreateOutpostResolver request, including the status of the request.

', 'DeleteOutpostResolverResponse$OutpostResolver' => '

Information about the DeleteOutpostResolver request, including the status of the request.

', 'GetOutpostResolverResponse$OutpostResolver' => '

Information about the GetOutpostResolver request, including the status of the request.

', 'OutpostResolverList$member' => NULL, 'UpdateOutpostResolverResponse$OutpostResolver' => '

The response to an UpdateOutpostResolver request.

', ], ], 'OutpostResolverList' => [ 'base' => NULL, 'refs' => [ 'ListOutpostResolversResponse$OutpostResolvers' => '

The Resolvers on Outposts that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

', ], ], 'OutpostResolverName' => [ 'base' => NULL, 'refs' => [ 'CreateOutpostResolverRequest$Name' => '

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

', 'OutpostResolver$Name' => '

Name of the Resolver.

', 'UpdateOutpostResolverRequest$Name' => '

Name of the Resolver on the Outpost.

', ], ], 'OutpostResolverStatus' => [ 'base' => NULL, 'refs' => [ 'OutpostResolver$Status' => '

Status of the Resolver.

', ], ], 'OutpostResolverStatusMessage' => [ 'base' => NULL, 'refs' => [ 'OutpostResolver$StatusMessage' => '

A detailed description of the Resolver.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'TargetAddress$Port' => '

The port at Ip that you want to forward DNS queries to.

', ], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.

The allowed values for Priority are between 100 and 9900.

', 'CreateFirewallRuleRequest$Priority' => '

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

', 'FirewallRule$Priority' => '

The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

', 'FirewallRuleGroupAssociation$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.

', 'ListFirewallRuleGroupAssociationsRequest$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

', 'ListFirewallRulesRequest$Priority' => '

Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

', 'UpdateFirewallRuleGroupAssociationRequest$Priority' => '

The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.

', 'UpdateFirewallRuleRequest$Priority' => '

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'ProtocolList$member' => NULL, 'TargetAddress$Protocol' => '

The protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

', ], ], 'ProtocolList' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$Protocols' => '

The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

', 'ResolverEndpoint$Protocols' => '

Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

', 'UpdateResolverEndpointRequest$Protocols' => '

The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

For an outbound endpoint you can apply the protocols as follows:

You can\'t change the protocol of an inbound endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and then remove the Do53.

', ], ], 'PutFirewallRuleGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutFirewallRuleGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResolverQueryLogConfigPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResolverQueryLogConfigPolicyResponse' => [ 'base' => '

The response to a PutResolverQueryLogConfigPolicy request.

', 'refs' => [], ], 'PutResolverRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResolverRulePolicyResponse' => [ 'base' => '

The response to a PutResolverRulePolicy request.

', 'refs' => [], ], 'Qtype' => [ 'base' => NULL, 'refs' => [ 'CreateFirewallRuleRequest$Qtype' => '

The DNS query type you want the rule to evaluate. Allowed values are;

', 'DeleteFirewallRuleRequest$Qtype' => '

The DNS query type that the rule you are deleting evaluates. Allowed values are;

', 'FirewallRule$Qtype' => '

The DNS query type you want the rule to evaluate. Allowed values are;

', 'UpdateFirewallRuleRequest$Qtype' => '

The DNS query type you want the rule to evaluate. Allowed values are;

', ], ], 'ResolverAutodefinedReverseStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverConfig$AutodefinedReverse' => '

The status of whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. The status can be one of following:

', ], ], 'ResolverConfig' => [ 'base' => '

A complex type that contains information about a Resolver configuration for a VPC.

', 'refs' => [ 'GetResolverConfigResponse$ResolverConfig' => '

Information about the behavior configuration of Route 53 Resolver behavior for the VPC you specified in the GetResolverConfig request.

', 'ResolverConfigList$member' => NULL, 'UpdateResolverConfigResponse$ResolverConfig' => '

An array that contains settings for the specified Resolver configuration.

', ], ], 'ResolverConfigList' => [ 'base' => NULL, 'refs' => [ 'ListResolverConfigsResponse$ResolverConfigs' => '

An array that contains one ResolverConfigs element for each Resolver configuration that is associated with the current Amazon Web Services account.

', ], ], 'ResolverDNSSECValidationStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverDnssecConfig$ValidationStatus' => '

The validation status for a DNSSEC configuration. The status can be one of the following:

', ], ], 'ResolverDnssecConfig' => [ 'base' => '

A complex type that contains information about a configuration for DNSSEC validation.

', 'refs' => [ 'GetResolverDnssecConfigResponse$ResolverDNSSECConfig' => '

The information about a configuration for DNSSEC validation.

', 'ResolverDnssecConfigList$member' => NULL, 'UpdateResolverDnssecConfigResponse$ResolverDNSSECConfig' => '

A complex type that contains settings for the specified DNSSEC configuration.

', ], ], 'ResolverDnssecConfigList' => [ 'base' => NULL, 'refs' => [ 'ListResolverDnssecConfigsResponse$ResolverDnssecConfigs' => '

An array that contains one ResolverDnssecConfig element for each configuration for DNSSEC validation that is associated with the current Amazon Web Services account. It doesn\'t contain disabled DNSSEC configurations for the resource.

', ], ], 'ResolverEndpoint' => [ 'base' => '

In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.

', 'refs' => [ 'AssociateResolverEndpointIpAddressResponse$ResolverEndpoint' => '

The response to an AssociateResolverEndpointIpAddress request.

', 'CreateResolverEndpointResponse$ResolverEndpoint' => '

Information about the CreateResolverEndpoint request, including the status of the request.

', 'DeleteResolverEndpointResponse$ResolverEndpoint' => '

Information about the DeleteResolverEndpoint request, including the status of the request.

', 'DisassociateResolverEndpointIpAddressResponse$ResolverEndpoint' => '

The response to an DisassociateResolverEndpointIpAddress request.

', 'GetResolverEndpointResponse$ResolverEndpoint' => '

Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.

', 'ResolverEndpoints$member' => NULL, 'UpdateResolverEndpointResponse$ResolverEndpoint' => '

The response to an UpdateResolverEndpoint request.

', ], ], 'ResolverEndpointDirection' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$Direction' => '

Specify the applicable value:

', 'ResolverEndpoint$Direction' => '

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

', ], ], 'ResolverEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverEndpoint$Status' => '

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

', ], ], 'ResolverEndpointType' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$ResolverEndpointType' => '

For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

', 'ResolverEndpoint$ResolverEndpointType' => '

The Resolver endpoint IP address type.

', 'UpdateResolverEndpointRequest$ResolverEndpointType' => '

Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries.

Updating to IPV6 type isn\'t currently supported.

', ], ], 'ResolverEndpoints' => [ 'base' => NULL, 'refs' => [ 'ListResolverEndpointsResponse$ResolverEndpoints' => '

The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

', ], ], 'ResolverQueryLogConfig' => [ 'base' => '

In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains settings for one query logging configuration.

', 'refs' => [ 'CreateResolverQueryLogConfigResponse$ResolverQueryLogConfig' => '

Information about the CreateResolverQueryLogConfig request, including the status of the request.

', 'DeleteResolverQueryLogConfigResponse$ResolverQueryLogConfig' => '

Information about the query logging configuration that you deleted, including the status of the request.

', 'GetResolverQueryLogConfigResponse$ResolverQueryLogConfig' => '

Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig request.

', 'ResolverQueryLogConfigList$member' => NULL, ], ], 'ResolverQueryLogConfigAssociation' => [ 'base' => '

In the response to an AssociateResolverQueryLogConfig, DisassociateResolverQueryLogConfig, GetResolverQueryLogConfigAssociation, or ListResolverQueryLogConfigAssociations, request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

', 'refs' => [ 'AssociateResolverQueryLogConfigResponse$ResolverQueryLogConfigAssociation' => '

A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

', 'DisassociateResolverQueryLogConfigResponse$ResolverQueryLogConfigAssociation' => '

A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.

', 'GetResolverQueryLogConfigAssociationResponse$ResolverQueryLogConfigAssociation' => '

Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.

', 'ResolverQueryLogConfigAssociationList$member' => NULL, ], ], 'ResolverQueryLogConfigAssociationError' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfigAssociation$Error' => '

If the value of Status is FAILED, the value of Error indicates the cause:

If the value of Status is a value other than FAILED, Error is null.

', ], ], 'ResolverQueryLogConfigAssociationErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfigAssociation$ErrorMessage' => '

Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

', ], ], 'ResolverQueryLogConfigAssociationList' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsResponse$ResolverQueryLogConfigAssociations' => '

A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for Filter.

', ], ], 'ResolverQueryLogConfigAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfigAssociation$Status' => '

The status of the specified query logging association. Valid values include the following:

', ], ], 'ResolverQueryLogConfigList' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigsResponse$ResolverQueryLogConfigs' => '

A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.

', ], ], 'ResolverQueryLogConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateResolverQueryLogConfigRequest$Name' => '

The name that you want to give the query logging configuration.

', 'ResolverQueryLogConfig$Name' => '

The name of the query logging configuration.

', ], ], 'ResolverQueryLogConfigPolicy' => [ 'base' => NULL, 'refs' => [ 'GetResolverQueryLogConfigPolicyResponse$ResolverQueryLogConfigPolicy' => '

Information about the query logging policy for the query logging configuration that you specified in a GetResolverQueryLogConfigPolicy request.

', 'PutResolverQueryLogConfigPolicyRequest$ResolverQueryLogConfigPolicy' => '

An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.

', ], ], 'ResolverQueryLogConfigStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverQueryLogConfig$Status' => '

The status of the specified query logging configuration. Valid values include the following:

', ], ], 'ResolverRule' => [ 'base' => '

For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.

', 'refs' => [ 'CreateResolverRuleResponse$ResolverRule' => '

Information about the CreateResolverRule request, including the status of the request.

', 'DeleteResolverRuleResponse$ResolverRule' => '

Information about the DeleteResolverRule request, including the status of the request.

', 'GetResolverRuleResponse$ResolverRule' => '

Information about the Resolver rule that you specified in a GetResolverRule request.

', 'ResolverRules$member' => NULL, 'UpdateResolverRuleResponse$ResolverRule' => '

The response to an UpdateResolverRule request.

', ], ], 'ResolverRuleAssociation' => [ 'base' => '

In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.

', 'refs' => [ 'AssociateResolverRuleResponse$ResolverRuleAssociation' => '

Information about the AssociateResolverRule request, including the status of the request.

', 'DisassociateResolverRuleResponse$ResolverRuleAssociation' => '

Information about the DisassociateResolverRule request, including the status of the request.

', 'GetResolverRuleAssociationResponse$ResolverRuleAssociation' => '

Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.

', 'ResolverRuleAssociations$member' => NULL, ], ], 'ResolverRuleAssociationStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverRuleAssociation$Status' => '

A code that specifies the current status of the association between a Resolver rule and a VPC.

', ], ], 'ResolverRuleAssociations' => [ 'base' => NULL, 'refs' => [ 'ListResolverRuleAssociationsResponse$ResolverRuleAssociations' => '

The associations that were created between Resolver rules and VPCs using the current Amazon Web Services account, and that match the specified filters, if any.

', ], ], 'ResolverRuleConfig' => [ 'base' => '

In an UpdateResolverRule request, information about the changes that you want to make.

', 'refs' => [ 'UpdateResolverRuleRequest$Config' => '

The new settings for the Resolver rule.

', ], ], 'ResolverRulePolicy' => [ 'base' => NULL, 'refs' => [ 'GetResolverRulePolicyResponse$ResolverRulePolicy' => '

The Resolver rule policy for the rule that you specified in a GetResolverRulePolicy request.

', 'PutResolverRulePolicyRequest$ResolverRulePolicy' => '

An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.

', ], ], 'ResolverRuleStatus' => [ 'base' => NULL, 'refs' => [ 'ResolverRule$Status' => '

A code that specifies the current status of the Resolver rule.

', ], ], 'ResolverRules' => [ 'base' => NULL, 'refs' => [ 'ListResolverRulesResponse$ResolverRules' => '

The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.

', ], ], 'ResourceExistsException' => [ 'base' => '

The resource that you tried to create already exists.

', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group.

', 'AssociateFirewallRuleGroupRequest$VpcId' => '

The unique identifier of the VPC that you want to associate with the rule group.

', 'AssociateResolverEndpointIpAddressRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to associate IP addresses with.

', 'AssociateResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that you want to associate a VPC with.

', 'AssociateResolverQueryLogConfigRequest$ResourceId' => '

The ID of an Amazon VPC that you want this query logging configuration to log queries for.

The VPCs and the query logging configuration must be in the same Region.

', 'AssociateResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use ListResolverRules.

', 'AssociateResolverRuleRequest$VPCId' => '

The ID of the VPC that you want to associate the Resolver rule with.

', 'CreateFirewallRuleRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group where you want to create the rule.

', 'CreateFirewallRuleRequest$FirewallDomainListId' => '

The ID of the domain list that you want to use in the rule.

', 'CreateResolverRuleRequest$ResolverEndpointId' => '

The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

', 'DeleteFirewallDomainListRequest$FirewallDomainListId' => '

The ID of the domain list that you want to delete.

', 'DeleteFirewallRuleGroupRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to delete.

', 'DeleteFirewallRuleRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to delete the rule from.

', 'DeleteFirewallRuleRequest$FirewallDomainListId' => '

The ID of the domain list that\'s used in the rule.

', 'DeleteOutpostResolverRequest$Id' => '

A unique string that identifies the Resolver on the Outpost.

', 'DeleteResolverEndpointRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to delete.

', 'DeleteResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that you want to delete.

', 'DeleteResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to delete.

', 'DisassociateFirewallRuleGroupRequest$FirewallRuleGroupAssociationId' => '

The identifier of the FirewallRuleGroupAssociation.

', 'DisassociateResolverEndpointIpAddressRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to disassociate an IP address from.

', 'DisassociateResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that you want to disassociate a specified VPC from.

', 'DisassociateResolverQueryLogConfigRequest$ResourceId' => '

The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.

', 'DisassociateResolverRuleRequest$VPCId' => '

The ID of the VPC that you want to disassociate the Resolver rule from.

', 'DisassociateResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to disassociate from the specified VPC.

', 'FirewallConfig$Id' => '

The ID of the firewall configuration.

', 'FirewallConfig$ResourceId' => '

The ID of the VPC that this firewall configuration applies to.

', 'FirewallDomainList$Id' => '

The ID of the domain list.

', 'FirewallDomainListMetadata$Id' => '

The ID of the domain list.

', 'FirewallRule$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group of the rule.

', 'FirewallRule$FirewallDomainListId' => '

The ID of the domain list that\'s used in the rule.

', 'FirewallRuleGroup$Id' => '

The ID of the rule group.

', 'FirewallRuleGroupAssociation$Id' => '

The identifier for the association.

', 'FirewallRuleGroupAssociation$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group.

', 'FirewallRuleGroupAssociation$VpcId' => '

The unique identifier of the VPC that is associated with the rule group.

', 'FirewallRuleGroupMetadata$Id' => '

The ID of the rule group.

', 'GetFirewallConfigRequest$ResourceId' => '

The ID of the VPC from Amazon VPC that the configuration is for.

', 'GetFirewallDomainListRequest$FirewallDomainListId' => '

The ID of the domain list.

', 'GetFirewallRuleGroupAssociationRequest$FirewallRuleGroupAssociationId' => '

The identifier of the FirewallRuleGroupAssociation.

', 'GetFirewallRuleGroupRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group.

', 'GetOutpostResolverRequest$Id' => '

The ID of the Resolver on the Outpost.

', 'GetResolverConfigRequest$ResourceId' => '

Resource ID of the Amazon VPC that you want to get information about.

', 'GetResolverDnssecConfigRequest$ResourceId' => '

The ID of the virtual private cloud (VPC) for the DNSSEC validation status.

', 'GetResolverEndpointRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to get information about.

', 'GetResolverQueryLogConfigAssociationRequest$ResolverQueryLogConfigAssociationId' => '

The ID of the Resolver query logging configuration association that you want to get information about.

', 'GetResolverQueryLogConfigRequest$ResolverQueryLogConfigId' => '

The ID of the Resolver query logging configuration that you want to get information about.

', 'GetResolverRuleAssociationRequest$ResolverRuleAssociationId' => '

The ID of the Resolver rule association that you want to get information about.

', 'GetResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to get information about.

', 'ImportFirewallDomainsRequest$FirewallDomainListId' => '

The ID of the domain list that you want to modify with the import operation.

', 'ImportFirewallDomainsResponse$Id' => '

The Id of the firewall domain list that DNS Firewall just updated.

', 'IpAddressResponse$IpId' => '

The ID of one IP address.

', 'IpAddressUpdate$IpId' => '

Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

', 'ListFirewallDomainsRequest$FirewallDomainListId' => '

The ID of the domain list whose domains you want to retrieve.

', 'ListFirewallRuleGroupAssociationsRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group.

', 'ListFirewallRuleGroupAssociationsRequest$VpcId' => '

The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC.

', 'ListFirewallRulesRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group that you want to retrieve the rules for.

', 'ListResolverEndpointIpAddressesRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to get IP addresses for.

', 'OutpostResolver$Id' => '

The ID of the Resolver on Outpost.

', 'ResolverConfig$Id' => '

ID for the Resolver configuration.

', 'ResolverConfig$ResourceId' => '

The ID of the Amazon Virtual Private Cloud VPC that you\'re configuring Resolver for.

', 'ResolverDnssecConfig$Id' => '

The ID for a configuration for DNSSEC validation.

', 'ResolverDnssecConfig$ResourceId' => '

The ID of the virtual private cloud (VPC) that you\'re configuring the DNSSEC validation status for.

', 'ResolverEndpoint$Id' => '

The ID of the Resolver endpoint.

', 'ResolverEndpoint$HostVPCId' => '

The ID of the VPC that you want to create the Resolver endpoint in.

', 'ResolverQueryLogConfig$Id' => '

The ID for the query logging configuration.

', 'ResolverQueryLogConfigAssociation$Id' => '

The ID of the query logging association.

', 'ResolverQueryLogConfigAssociation$ResolverQueryLogConfigId' => '

The ID of the query logging configuration that a VPC is associated with.

', 'ResolverQueryLogConfigAssociation$ResourceId' => '

The ID of the Amazon VPC that is associated with the query logging configuration.

', 'ResolverRule$Id' => '

The ID that Resolver assigned to the Resolver rule when you created it.

', 'ResolverRule$ResolverEndpointId' => '

The ID of the endpoint that the rule is associated with.

', 'ResolverRuleAssociation$Id' => '

The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

', 'ResolverRuleAssociation$ResolverRuleId' => '

The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.

', 'ResolverRuleAssociation$VPCId' => '

The ID of the VPC that you associated the Resolver rule with.

', 'ResolverRuleConfig$ResolverEndpointId' => '

The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

', 'SecurityGroupIds$member' => NULL, 'UpdateFirewallConfigRequest$ResourceId' => '

The ID of the VPC that the configuration is for.

', 'UpdateFirewallDomainsRequest$FirewallDomainListId' => '

The ID of the domain list whose domains you want to update.

', 'UpdateFirewallDomainsResponse$Id' => '

The ID of the firewall domain list that DNS Firewall just updated.

', 'UpdateFirewallRuleGroupAssociationRequest$FirewallRuleGroupAssociationId' => '

The identifier of the FirewallRuleGroupAssociation.

', 'UpdateFirewallRuleRequest$FirewallRuleGroupId' => '

The unique identifier of the firewall rule group for the rule.

', 'UpdateFirewallRuleRequest$FirewallDomainListId' => '

The ID of the domain list to use in the rule.

', 'UpdateIpAddress$IpId' => '

The ID of the IP address, specified by the ResolverEndpointId.

', 'UpdateOutpostResolverRequest$Id' => '

A unique string that identifies Resolver on an Outpost.

', 'UpdateResolverConfigRequest$ResourceId' => '

Resource ID of the Amazon VPC that you want to update the Resolver configuration for.

', 'UpdateResolverDnssecConfigRequest$ResourceId' => '

The ID of the virtual private cloud (VPC) that you\'re updating the DNSSEC validation status for.

', 'UpdateResolverEndpointRequest$ResolverEndpointId' => '

The ID of the Resolver endpoint that you want to update.

', 'UpdateResolverRuleRequest$ResolverRuleId' => '

The ID of the Resolver rule that you want to update.

', ], ], 'ResourceInUseException' => [ 'base' => '

The resource that you tried to update or delete is currently in use.

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

The specified resource doesn\'t exist.

', 'refs' => [], ], 'ResourceUnavailableException' => [ 'base' => '

The specified resource isn\'t available.

', 'refs' => [], ], 'Rfc3339TimeString' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$CreationTime' => '

The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallDomainList$ModificationTime' => '

The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRule$CreationTime' => '

The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRule$ModificationTime' => '

The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroup$CreationTime' => '

The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroup$ModificationTime' => '

The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroupAssociation$CreationTime' => '

The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC).

', 'FirewallRuleGroupAssociation$ModificationTime' => '

The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'IpAddressResponse$CreationTime' => '

The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

', 'IpAddressResponse$ModificationTime' => '

The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'OutpostResolver$CreationTime' => '

The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).

', 'OutpostResolver$ModificationTime' => '

The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverEndpoint$CreationTime' => '

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverEndpoint$ModificationTime' => '

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverQueryLogConfig$CreationTime' => '

The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverQueryLogConfigAssociation$CreationTime' => '

The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverRule$CreationTime' => '

The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

', 'ResolverRule$ModificationTime' => '

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

', ], ], 'RuleTypeOption' => [ 'base' => NULL, 'refs' => [ 'CreateResolverRuleRequest$RuleType' => '

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

', 'ResolverRule$RuleType' => '

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

', ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateResolverEndpointRequest$SecurityGroupIds' => '

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you\'re using for DNS queries on your network.

Some security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the maximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. To avoid connection tracking caused by security group, see Untracked connections.

', 'ResolverEndpoint$SecurityGroupIds' => '

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you\'re using for DNS queries on your network.

', ], ], 'ServicePrinciple' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$ManagedOwnerName' => '

The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

', 'FirewallDomainListMetadata$ManagedOwnerName' => '

The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

', 'FirewallRuleGroupAssociation$ManagedOwnerName' => '

The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

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

Fulfilling the request would cause one or more quotas to be exceeded.

', 'refs' => [], ], 'ShareStatus' => [ 'base' => NULL, 'refs' => [ 'FirewallRuleGroup$ShareStatus' => '

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

', 'FirewallRuleGroupMetadata$ShareStatus' => '

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

', 'ResolverQueryLogConfig$ShareStatus' => '

An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

', 'ResolverRule$ShareStatus' => '

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

', ], ], 'SortByKey' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsRequest$SortBy' => '

The element that you want Resolver to sort query logging associations by.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

', 'ListResolverQueryLogConfigsRequest$SortBy' => '

The element that you want Resolver to sort query logging configurations by.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResolverQueryLogConfigAssociationsRequest$SortOrder' => '

If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

', 'ListResolverQueryLogConfigsRequest$SortOrder' => '

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$StatusMessage' => '

Additional information about the status of the list, if available.

', 'FirewallRuleGroup$StatusMessage' => '

Additional information about the status of the rule group, if available.

', 'FirewallRuleGroupAssociation$StatusMessage' => '

Additional information about the status of the response, if available.

', 'ImportFirewallDomainsResponse$StatusMessage' => '

Additional information about the status of the list, if available.

', 'IpAddressResponse$StatusMessage' => '

A message that provides additional information about the status of the request.

', 'ResolverEndpoint$StatusMessage' => '

A detailed description of the status of the Resolver endpoint.

', 'ResolverRule$StatusMessage' => '

A detailed description of the status of a Resolver rule.

', 'ResolverRuleAssociation$StatusMessage' => '

A detailed description of the status of the association between a Resolver rule and a VPC.

', 'UpdateFirewallDomainsResponse$StatusMessage' => '

Additional information about the status of the list, if available.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$FieldName' => '

For an InvalidParameterException error, the name of the parameter that\'s invalid.

', 'LimitExceededException$Message' => NULL, 'LimitExceededException$ResourceType' => '

For a LimitExceededException error, the type of resource that exceeded the current limit.

', 'ResourceExistsException$Message' => NULL, 'ResourceExistsException$ResourceType' => '

For a ResourceExistsException error, the type of resource that the error applies to.

', 'ResourceInUseException$Message' => NULL, 'ResourceInUseException$ResourceType' => '

For a ResourceInUseException error, the type of resource that is currently in use.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$ResourceType' => '

For a ResourceNotFoundException error, the type of resource that doesn\'t exist.

', 'ResourceUnavailableException$Message' => NULL, 'ResourceUnavailableException$ResourceType' => '

For a ResourceUnavailableException error, the type of resource that isn\'t available.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'IpAddressRequest$SubnetId' => '

The ID of the subnet that contains the IP address.

', 'IpAddressResponse$SubnetId' => '

The ID of one subnet.

', 'IpAddressUpdate$SubnetId' => '

The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

', ], ], 'Tag' => [ 'base' => '

One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tags that you want to remove to the specified resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AssociateFirewallRuleGroupRequest$Tags' => '

A list of the tag keys and values that you want to associate with the rule group association.

', 'CreateFirewallDomainListRequest$Tags' => '

A list of the tag keys and values that you want to associate with the domain list.

', 'CreateFirewallRuleGroupRequest$Tags' => '

A list of the tag keys and values that you want to associate with the rule group.

', 'CreateOutpostResolverRequest$Tags' => '

A string that helps identify the Route 53 Resolvers on Outpost.

', 'CreateResolverEndpointRequest$Tags' => '

A list of the tag keys and values that you want to associate with the endpoint.

', 'CreateResolverQueryLogConfigRequest$Tags' => '

A list of the tag keys and values that you want to associate with the query logging configuration.

', 'CreateResolverRuleRequest$Tags' => '

A list of the tag keys and values that you want to associate with the endpoint.

', 'ListTagsForResourceResponse$Tags' => '

The tags that are associated with the resource that you specified in the ListTagsForResource request.

', 'TagResourceRequest$Tags' => '

The tags that you want to add to the specified resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you\'re creating the resource for.

', ], ], 'TargetAddress' => [ 'base' => '

In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

', 'refs' => [ 'TargetList$member' => NULL, ], ], 'TargetList' => [ 'base' => NULL, 'refs' => [ 'CreateResolverRuleRequest$TargetIps' => '

The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

TargetIps is available only when the value of Rule type is FORWARD.

', 'ResolverRule$TargetIps' => '

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.

', 'ResolverRuleConfig$TargetIps' => '

For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

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

The request was throttled. Try again in a few minutes.

', 'refs' => [], ], 'UnknownResourceException' => [ 'base' => '

The specified resource doesn\'t exist.

', 'refs' => [], ], 'Unsigned' => [ 'base' => NULL, 'refs' => [ 'FirewallDomainList$DomainCount' => '

The number of domain names that are specified in the domain list.

', 'FirewallRule$BlockOverrideTtl' => '

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

', 'FirewallRuleGroup$RuleCount' => '

The number of rules in the rule group.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleGroupAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleGroupAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFirewallRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIpAddress' => [ 'base' => '

Provides information about the IP address type in response to UpdateResolverEndpoint.

', 'refs' => [ 'UpdateIpAddresses$member' => NULL, ], ], 'UpdateIpAddresses' => [ 'base' => NULL, 'refs' => [ 'UpdateResolverEndpointRequest$UpdateIpAddresses' => '

Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don\'t specify an IPv6 address, one will be automatically chosen from your subnet.

', ], ], 'UpdateOutpostResolverRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateOutpostResolverResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverDnssecConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverDnssecConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResolverRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'Validation' => [ 'base' => NULL, 'refs' => [ 'UpdateResolverDnssecConfigRequest$Validation' => '

The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status change to be completed.

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

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

', 'refs' => [], ], ],]; diff --git a/src/data/sagemaker/2017-07-24/api-2.json b/src/data/sagemaker/2017-07-24/api-2.json index c5ff76ac2b..d7d2fb9f62 100644 --- a/src/data/sagemaker/2017-07-24/api-2.json +++ b/src/data/sagemaker/2017-07-24/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"api.sagemaker", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"SageMaker", "serviceFullName":"Amazon SageMaker Service", "serviceId":"SageMaker", @@ -7487,7 +7488,8 @@ "Environment":{"shape":"TrainingEnvironmentMap"}, "RetryStrategy":{"shape":"RetryStrategy"}, "RemoteDebugConfig":{"shape":"RemoteDebugConfig"}, - "InfraCheckConfig":{"shape":"InfraCheckConfig"} + "InfraCheckConfig":{"shape":"InfraCheckConfig"}, + "SessionChainingConfig":{"shape":"SessionChainingConfig"} } }, "CreateTrainingJobResponse":{ @@ -11056,6 +11058,7 @@ "members":{ } }, + "EnableSessionTagChaining":{"type":"boolean"}, "Endpoint":{ "type":"structure", "required":[ @@ -18642,6 +18645,14 @@ "ml.g5.16xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", + "ml.g6.xlarge", + "ml.g6.2xlarge", + "ml.g6.4xlarge", + "ml.g6.8xlarge", + "ml.g6.12xlarge", + "ml.g6.16xlarge", + "ml.g6.24xlarge", + "ml.g6.48xlarge", "ml.p4d.24xlarge", "ml.c7g.large", "ml.c7g.xlarge", @@ -20274,6 +20285,12 @@ "ProvisioningParameters":{"shape":"ProvisioningParameters"} } }, + "SessionChainingConfig":{ + "type":"structure", + "members":{ + "EnableSessionTagChaining":{"shape":"EnableSessionTagChaining"} + } + }, "SessionExpirationDurationInSeconds":{ "type":"integer", "max":43200, diff --git a/src/data/sagemaker/2017-07-24/api-2.json.php b/src/data/sagemaker/2017-07-24/api-2.json.php index 58159ece88..f7bd55117f 100644 --- a/src/data/sagemaker/2017-07-24/api-2.json.php +++ b/src/data/sagemaker/2017-07-24/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-07-24', 'endpointPrefix' => 'api.sagemaker', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'SageMaker', 'serviceFullName' => 'Amazon SageMaker Service', 'serviceId' => 'SageMaker', 'signatureVersion' => 'v4', 'signingName' => 'sagemaker', 'targetPrefix' => 'SageMaker', 'uid' => 'sagemaker-2017-07-24', ], 'operations' => [ 'AddAssociation' => [ 'name' => 'AddAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddAssociationRequest', ], 'output' => [ 'shape' => 'AddAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], ], 'AssociateTrialComponent' => [ 'name' => 'AssociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTrialComponentRequest', ], 'output' => [ 'shape' => 'AssociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'BatchDescribeModelPackage' => [ 'name' => 'BatchDescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDescribeModelPackageInput', ], 'output' => [ 'shape' => 'BatchDescribeModelPackageOutput', ], ], 'CreateAction' => [ 'name' => 'CreateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActionRequest', ], 'output' => [ 'shape' => 'CreateActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAlgorithm' => [ 'name' => 'CreateAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAlgorithmInput', ], 'output' => [ 'shape' => 'CreateAlgorithmOutput', ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateAppImageConfig' => [ 'name' => 'CreateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppImageConfigRequest', ], 'output' => [ 'shape' => 'CreateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateArtifact' => [ 'name' => 'CreateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateArtifactRequest', ], 'output' => [ 'shape' => 'CreateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJob' => [ 'name' => 'CreateAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobRequest', ], 'output' => [ 'shape' => 'CreateAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJobV2' => [ 'name' => 'CreateAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobV2Request', ], 'output' => [ 'shape' => 'CreateAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateCodeRepository' => [ 'name' => 'CreateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCodeRepositoryInput', ], 'output' => [ 'shape' => 'CreateCodeRepositoryOutput', ], ], 'CreateCompilationJob' => [ 'name' => 'CreateCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCompilationJobRequest', ], 'output' => [ 'shape' => 'CreateCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateContext' => [ 'name' => 'CreateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContextRequest', ], 'output' => [ 'shape' => 'CreateContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDataQualityJobDefinition' => [ 'name' => 'CreateDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateDeviceFleet' => [ 'name' => 'CreateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateEdgeDeploymentPlan' => [ 'name' => 'CreateEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'CreateEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgeDeploymentStage' => [ 'name' => 'CreateEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgePackagingJob' => [ 'name' => 'CreateEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgePackagingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpoint' => [ 'name' => 'CreateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointInput', ], 'output' => [ 'shape' => 'CreateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpointConfig' => [ 'name' => 'CreateEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointConfigInput', ], 'output' => [ 'shape' => 'CreateEndpointConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateExperiment' => [ 'name' => 'CreateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateExperimentRequest', ], 'output' => [ 'shape' => 'CreateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFeatureGroup' => [ 'name' => 'CreateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFeatureGroupRequest', ], 'output' => [ 'shape' => 'CreateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFlowDefinition' => [ 'name' => 'CreateFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFlowDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHub' => [ 'name' => 'CreateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHubRequest', ], 'output' => [ 'shape' => 'CreateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateHumanTaskUi' => [ 'name' => 'CreateHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHumanTaskUiRequest', ], 'output' => [ 'shape' => 'CreateHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHyperParameterTuningJob' => [ 'name' => 'CreateHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'CreateHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImage' => [ 'name' => 'CreateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageRequest', ], 'output' => [ 'shape' => 'CreateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImageVersion' => [ 'name' => 'CreateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageVersionRequest', ], 'output' => [ 'shape' => 'CreateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateInferenceComponent' => [ 'name' => 'CreateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceComponentInput', ], 'output' => [ 'shape' => 'CreateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceExperiment' => [ 'name' => 'CreateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'CreateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceRecommendationsJob' => [ 'name' => 'CreateInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'CreateInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateLabelingJob' => [ 'name' => 'CreateLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLabelingJobRequest', ], 'output' => [ 'shape' => 'CreateLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModel' => [ 'name' => 'CreateModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelInput', ], 'output' => [ 'shape' => 'CreateModelOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelBiasJobDefinition' => [ 'name' => 'CreateModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelCard' => [ 'name' => 'CreateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardRequest', ], 'output' => [ 'shape' => 'CreateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelCardExportJob' => [ 'name' => 'CreateModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardExportJobRequest', ], 'output' => [ 'shape' => 'CreateModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelExplainabilityJobDefinition' => [ 'name' => 'CreateModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelPackage' => [ 'name' => 'CreateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageInput', ], 'output' => [ 'shape' => 'CreateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelPackageGroup' => [ 'name' => 'CreateModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageGroupInput', ], 'output' => [ 'shape' => 'CreateModelPackageGroupOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelQualityJobDefinition' => [ 'name' => 'CreateModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateMonitoringSchedule' => [ 'name' => 'CreateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'CreateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateNotebookInstance' => [ 'name' => 'CreateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateNotebookInstanceLifecycleConfig' => [ 'name' => 'CreateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreatePresignedDomainUrl' => [ 'name' => 'CreatePresignedDomainUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedDomainUrlRequest', ], 'output' => [ 'shape' => 'CreatePresignedDomainUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'CreatePresignedNotebookInstanceUrl' => [ 'name' => 'CreatePresignedNotebookInstanceUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlInput', ], 'output' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlOutput', ], ], 'CreateProcessingJob' => [ 'name' => 'CreateProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProcessingJobRequest', ], 'output' => [ 'shape' => 'CreateProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectInput', ], 'output' => [ 'shape' => 'CreateProjectOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateSpace' => [ 'name' => 'CreateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSpaceRequest', ], 'output' => [ 'shape' => 'CreateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateStudioLifecycleConfig' => [ 'name' => 'CreateStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'CreateStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateTrainingJob' => [ 'name' => 'CreateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrainingJobRequest', ], 'output' => [ 'shape' => 'CreateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTransformJob' => [ 'name' => 'CreateTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransformJobRequest', ], 'output' => [ 'shape' => 'CreateTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTrial' => [ 'name' => 'CreateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialRequest', ], 'output' => [ 'shape' => 'CreateTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateTrialComponent' => [ 'name' => 'CreateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialComponentRequest', ], 'output' => [ 'shape' => 'CreateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateUserProfile' => [ 'name' => 'CreateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserProfileRequest', ], 'output' => [ 'shape' => 'CreateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateWorkforce' => [ 'name' => 'CreateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkforceRequest', ], 'output' => [ 'shape' => 'CreateWorkforceResponse', ], ], 'CreateWorkteam' => [ 'name' => 'CreateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkteamRequest', ], 'output' => [ 'shape' => 'CreateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeleteAction' => [ 'name' => 'DeleteAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActionRequest', ], 'output' => [ 'shape' => 'DeleteActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAlgorithm' => [ 'name' => 'DeleteAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlgorithmInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAppImageConfig' => [ 'name' => 'DeleteAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppImageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteArtifact' => [ 'name' => 'DeleteArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteArtifactRequest', ], 'output' => [ 'shape' => 'DeleteArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAssociation' => [ 'name' => 'DeleteAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAssociationRequest', ], 'output' => [ 'shape' => 'DeleteAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteCodeRepository' => [ 'name' => 'DeleteCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCodeRepositoryInput', ], ], 'DeleteCompilationJob' => [ 'name' => 'DeleteCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteContext' => [ 'name' => 'DeleteContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContextRequest', ], 'output' => [ 'shape' => 'DeleteContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDataQualityJobDefinition' => [ 'name' => 'DeleteDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDataQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDeviceFleet' => [ 'name' => 'DeleteDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteEdgeDeploymentPlan' => [ 'name' => 'DeleteEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentPlanRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEdgeDeploymentStage' => [ 'name' => 'DeleteEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEndpoint' => [ 'name' => 'DeleteEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointInput', ], ], 'DeleteEndpointConfig' => [ 'name' => 'DeleteEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointConfigInput', ], ], 'DeleteExperiment' => [ 'name' => 'DeleteExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteExperimentRequest', ], 'output' => [ 'shape' => 'DeleteExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFeatureGroup' => [ 'name' => 'DeleteFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFeatureGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFlowDefinition' => [ 'name' => 'DeleteFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHub' => [ 'name' => 'DeleteHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHubContent' => [ 'name' => 'DeleteHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubContentRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHumanTaskUi' => [ 'name' => 'DeleteHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DeleteHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHyperParameterTuningJob' => [ 'name' => 'DeleteHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHyperParameterTuningJobRequest', ], ], 'DeleteImage' => [ 'name' => 'DeleteImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageRequest', ], 'output' => [ 'shape' => 'DeleteImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImageVersion' => [ 'name' => 'DeleteImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageVersionRequest', ], 'output' => [ 'shape' => 'DeleteImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteInferenceComponent' => [ 'name' => 'DeleteInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceComponentInput', ], ], 'DeleteInferenceExperiment' => [ 'name' => 'DeleteInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DeleteInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModel' => [ 'name' => 'DeleteModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelInput', ], ], 'DeleteModelBiasJobDefinition' => [ 'name' => 'DeleteModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelBiasJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelCard' => [ 'name' => 'DeleteModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelCardRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelExplainabilityJobDefinition' => [ 'name' => 'DeleteModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelExplainabilityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelPackage' => [ 'name' => 'DeleteModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroup' => [ 'name' => 'DeleteModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroupPolicy' => [ 'name' => 'DeleteModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupPolicyInput', ], ], 'DeleteModelQualityJobDefinition' => [ 'name' => 'DeleteModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteMonitoringSchedule' => [ 'name' => 'DeleteMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteNotebookInstance' => [ 'name' => 'DeleteNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceInput', ], ], 'DeleteNotebookInstanceLifecycleConfig' => [ 'name' => 'DeleteNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceLifecycleConfigInput', ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteSpace' => [ 'name' => 'DeleteSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSpaceRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteStudioLifecycleConfig' => [ 'name' => 'DeleteStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioLifecycleConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsInput', ], 'output' => [ 'shape' => 'DeleteTagsOutput', ], ], 'DeleteTrial' => [ 'name' => 'DeleteTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialRequest', ], 'output' => [ 'shape' => 'DeleteTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteTrialComponent' => [ 'name' => 'DeleteTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialComponentRequest', ], 'output' => [ 'shape' => 'DeleteTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteUserProfile' => [ 'name' => 'DeleteUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteWorkforce' => [ 'name' => 'DeleteWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkforceRequest', ], 'output' => [ 'shape' => 'DeleteWorkforceResponse', ], ], 'DeleteWorkteam' => [ 'name' => 'DeleteWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkteamRequest', ], 'output' => [ 'shape' => 'DeleteWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeregisterDevices' => [ 'name' => 'DeregisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDevicesRequest', ], ], 'DescribeAction' => [ 'name' => 'DescribeAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActionRequest', ], 'output' => [ 'shape' => 'DescribeActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmInput', ], 'output' => [ 'shape' => 'DescribeAlgorithmOutput', ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAppImageConfig' => [ 'name' => 'DescribeAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppImageConfigRequest', ], 'output' => [ 'shape' => 'DescribeAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeArtifact' => [ 'name' => 'DescribeArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeArtifactRequest', ], 'output' => [ 'shape' => 'DescribeArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJob' => [ 'name' => 'DescribeAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobRequest', ], 'output' => [ 'shape' => 'DescribeAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJobV2' => [ 'name' => 'DescribeAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobV2Request', ], 'output' => [ 'shape' => 'DescribeAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCluster' => [ 'name' => 'DescribeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterRequest', ], 'output' => [ 'shape' => 'DescribeClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeClusterNode' => [ 'name' => 'DescribeClusterNode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterNodeRequest', ], 'output' => [ 'shape' => 'DescribeClusterNodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCodeRepository' => [ 'name' => 'DescribeCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCodeRepositoryInput', ], 'output' => [ 'shape' => 'DescribeCodeRepositoryOutput', ], ], 'DescribeCompilationJob' => [ 'name' => 'DescribeCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCompilationJobRequest', ], 'output' => [ 'shape' => 'DescribeCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeContext' => [ 'name' => 'DescribeContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContextRequest', ], 'output' => [ 'shape' => 'DescribeContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDataQualityJobDefinition' => [ 'name' => 'DescribeDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDevice' => [ 'name' => 'DescribeDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceRequest', ], 'output' => [ 'shape' => 'DescribeDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDeviceFleet' => [ 'name' => 'DescribeDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceFleetRequest', ], 'output' => [ 'shape' => 'DescribeDeviceFleetResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgeDeploymentPlan' => [ 'name' => 'DescribeEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'DescribeEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgePackagingJob' => [ 'name' => 'DescribeEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgePackagingJobRequest', ], 'output' => [ 'shape' => 'DescribeEdgePackagingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointInput', ], 'output' => [ 'shape' => 'DescribeEndpointOutput', ], ], 'DescribeEndpointConfig' => [ 'name' => 'DescribeEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointConfigInput', ], 'output' => [ 'shape' => 'DescribeEndpointConfigOutput', ], ], 'DescribeExperiment' => [ 'name' => 'DescribeExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExperimentRequest', ], 'output' => [ 'shape' => 'DescribeExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureGroup' => [ 'name' => 'DescribeFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureGroupRequest', ], 'output' => [ 'shape' => 'DescribeFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureMetadata' => [ 'name' => 'DescribeFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureMetadataRequest', ], 'output' => [ 'shape' => 'DescribeFeatureMetadataResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFlowDefinition' => [ 'name' => 'DescribeFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHub' => [ 'name' => 'DescribeHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubRequest', ], 'output' => [ 'shape' => 'DescribeHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHubContent' => [ 'name' => 'DescribeHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubContentRequest', ], 'output' => [ 'shape' => 'DescribeHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHumanTaskUi' => [ 'name' => 'DescribeHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DescribeHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHyperParameterTuningJob' => [ 'name' => 'DescribeHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'DescribeHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImage' => [ 'name' => 'DescribeImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageRequest', ], 'output' => [ 'shape' => 'DescribeImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImageVersion' => [ 'name' => 'DescribeImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageVersionRequest', ], 'output' => [ 'shape' => 'DescribeImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceComponent' => [ 'name' => 'DescribeInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceComponentInput', ], 'output' => [ 'shape' => 'DescribeInferenceComponentOutput', ], ], 'DescribeInferenceExperiment' => [ 'name' => 'DescribeInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DescribeInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceRecommendationsJob' => [ 'name' => 'DescribeInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'DescribeInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLabelingJob' => [ 'name' => 'DescribeLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLabelingJobRequest', ], 'output' => [ 'shape' => 'DescribeLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLineageGroup' => [ 'name' => 'DescribeLineageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLineageGroupRequest', ], 'output' => [ 'shape' => 'DescribeLineageGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModel' => [ 'name' => 'DescribeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelInput', ], 'output' => [ 'shape' => 'DescribeModelOutput', ], ], 'DescribeModelBiasJobDefinition' => [ 'name' => 'DescribeModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCard' => [ 'name' => 'DescribeModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardRequest', ], 'output' => [ 'shape' => 'DescribeModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCardExportJob' => [ 'name' => 'DescribeModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardExportJobRequest', ], 'output' => [ 'shape' => 'DescribeModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelExplainabilityJobDefinition' => [ 'name' => 'DescribeModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelPackage' => [ 'name' => 'DescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageInput', ], 'output' => [ 'shape' => 'DescribeModelPackageOutput', ], ], 'DescribeModelPackageGroup' => [ 'name' => 'DescribeModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageGroupInput', ], 'output' => [ 'shape' => 'DescribeModelPackageGroupOutput', ], ], 'DescribeModelQualityJobDefinition' => [ 'name' => 'DescribeModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeMonitoringSchedule' => [ 'name' => 'DescribeMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'DescribeMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeNotebookInstance' => [ 'name' => 'DescribeNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceOutput', ], ], 'DescribeNotebookInstanceLifecycleConfig' => [ 'name' => 'DescribeNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigOutput', ], ], 'DescribePipeline' => [ 'name' => 'DescribePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineRequest', ], 'output' => [ 'shape' => 'DescribePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineDefinitionForExecution' => [ 'name' => 'DescribePipelineDefinitionForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineDefinitionForExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineDefinitionForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineExecution' => [ 'name' => 'DescribePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProcessingJob' => [ 'name' => 'DescribeProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProcessingJobRequest', ], 'output' => [ 'shape' => 'DescribeProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProject' => [ 'name' => 'DescribeProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProjectInput', ], 'output' => [ 'shape' => 'DescribeProjectOutput', ], ], 'DescribeSpace' => [ 'name' => 'DescribeSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpaceRequest', ], 'output' => [ 'shape' => 'DescribeSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStudioLifecycleConfig' => [ 'name' => 'DescribeStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'DescribeStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeSubscribedWorkteam' => [ 'name' => 'DescribeSubscribedWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSubscribedWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeSubscribedWorkteamResponse', ], ], 'DescribeTrainingJob' => [ 'name' => 'DescribeTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrainingJobRequest', ], 'output' => [ 'shape' => 'DescribeTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTransformJob' => [ 'name' => 'DescribeTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTransformJobRequest', ], 'output' => [ 'shape' => 'DescribeTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrial' => [ 'name' => 'DescribeTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialRequest', ], 'output' => [ 'shape' => 'DescribeTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrialComponent' => [ 'name' => 'DescribeTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialComponentRequest', ], 'output' => [ 'shape' => 'DescribeTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeUserProfile' => [ 'name' => 'DescribeUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserProfileRequest', ], 'output' => [ 'shape' => 'DescribeUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DescribeWorkforce' => [ 'name' => 'DescribeWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkforceRequest', ], 'output' => [ 'shape' => 'DescribeWorkforceResponse', ], ], 'DescribeWorkteam' => [ 'name' => 'DescribeWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeWorkteamResponse', ], ], 'DisableSagemakerServicecatalogPortfolio' => [ 'name' => 'DisableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioOutput', ], ], 'DisassociateTrialComponent' => [ 'name' => 'DisassociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTrialComponentRequest', ], 'output' => [ 'shape' => 'DisassociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'EnableSagemakerServicecatalogPortfolio' => [ 'name' => 'EnableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioOutput', ], ], 'GetDeviceFleetReport' => [ 'name' => 'GetDeviceFleetReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceFleetReportRequest', ], 'output' => [ 'shape' => 'GetDeviceFleetReportResponse', ], ], 'GetLineageGroupPolicy' => [ 'name' => 'GetLineageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLineageGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetLineageGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetModelPackageGroupPolicy' => [ 'name' => 'GetModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'GetModelPackageGroupPolicyOutput', ], ], 'GetSagemakerServicecatalogPortfolioStatus' => [ 'name' => 'GetSagemakerServicecatalogPortfolioStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusInput', ], 'output' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusOutput', ], ], 'GetScalingConfigurationRecommendation' => [ 'name' => 'GetScalingConfigurationRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetScalingConfigurationRecommendationRequest', ], 'output' => [ 'shape' => 'GetScalingConfigurationRecommendationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetSearchSuggestions' => [ 'name' => 'GetSearchSuggestions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSearchSuggestionsRequest', ], 'output' => [ 'shape' => 'GetSearchSuggestionsResponse', ], ], 'ImportHubContent' => [ 'name' => 'ImportHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportHubContentRequest', ], 'output' => [ 'shape' => 'ImportHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListActions' => [ 'name' => 'ListActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActionsRequest', ], 'output' => [ 'shape' => 'ListActionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAlgorithms' => [ 'name' => 'ListAlgorithms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAlgorithmsInput', ], 'output' => [ 'shape' => 'ListAlgorithmsOutput', ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAppImageConfigs' => [ 'name' => 'ListAppImageConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppImageConfigsRequest', ], 'output' => [ 'shape' => 'ListAppImageConfigsResponse', ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAssociations' => [ 'name' => 'ListAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAssociationsRequest', ], 'output' => [ 'shape' => 'ListAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAutoMLJobs' => [ 'name' => 'ListAutoMLJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAutoMLJobsRequest', ], 'output' => [ 'shape' => 'ListAutoMLJobsResponse', ], ], 'ListCandidatesForAutoMLJob' => [ 'name' => 'ListCandidatesForAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCandidatesForAutoMLJobRequest', ], 'output' => [ 'shape' => 'ListCandidatesForAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusterNodes' => [ 'name' => 'ListClusterNodes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClusterNodesRequest', ], 'output' => [ 'shape' => 'ListClusterNodesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], ], 'ListCodeRepositories' => [ 'name' => 'ListCodeRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCodeRepositoriesInput', ], 'output' => [ 'shape' => 'ListCodeRepositoriesOutput', ], ], 'ListCompilationJobs' => [ 'name' => 'ListCompilationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCompilationJobsRequest', ], 'output' => [ 'shape' => 'ListCompilationJobsResponse', ], ], 'ListContexts' => [ 'name' => 'ListContexts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContextsRequest', ], 'output' => [ 'shape' => 'ListContextsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListDataQualityJobDefinitions' => [ 'name' => 'ListDataQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDataQualityJobDefinitionsResponse', ], ], 'ListDeviceFleets' => [ 'name' => 'ListDeviceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceFleetsRequest', ], 'output' => [ 'shape' => 'ListDeviceFleetsResponse', ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResponse', ], ], 'ListEdgeDeploymentPlans' => [ 'name' => 'ListEdgeDeploymentPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgeDeploymentPlansRequest', ], 'output' => [ 'shape' => 'ListEdgeDeploymentPlansResponse', ], ], 'ListEdgePackagingJobs' => [ 'name' => 'ListEdgePackagingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgePackagingJobsRequest', ], 'output' => [ 'shape' => 'ListEdgePackagingJobsResponse', ], ], 'ListEndpointConfigs' => [ 'name' => 'ListEndpointConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointConfigsInput', ], 'output' => [ 'shape' => 'ListEndpointConfigsOutput', ], ], 'ListEndpoints' => [ 'name' => 'ListEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointsInput', ], 'output' => [ 'shape' => 'ListEndpointsOutput', ], ], 'ListExperiments' => [ 'name' => 'ListExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExperimentsRequest', ], 'output' => [ 'shape' => 'ListExperimentsResponse', ], ], 'ListFeatureGroups' => [ 'name' => 'ListFeatureGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFeatureGroupsRequest', ], 'output' => [ 'shape' => 'ListFeatureGroupsResponse', ], ], 'ListFlowDefinitions' => [ 'name' => 'ListFlowDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFlowDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFlowDefinitionsResponse', ], ], 'ListHubContentVersions' => [ 'name' => 'ListHubContentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentVersionsRequest', ], 'output' => [ 'shape' => 'ListHubContentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubContents' => [ 'name' => 'ListHubContents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentsRequest', ], 'output' => [ 'shape' => 'ListHubContentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubs' => [ 'name' => 'ListHubs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubsRequest', ], 'output' => [ 'shape' => 'ListHubsResponse', ], ], 'ListHumanTaskUis' => [ 'name' => 'ListHumanTaskUis', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHumanTaskUisRequest', ], 'output' => [ 'shape' => 'ListHumanTaskUisResponse', ], ], 'ListHyperParameterTuningJobs' => [ 'name' => 'ListHyperParameterTuningJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHyperParameterTuningJobsRequest', ], 'output' => [ 'shape' => 'ListHyperParameterTuningJobsResponse', ], ], 'ListImageVersions' => [ 'name' => 'ListImageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImageVersionsRequest', ], 'output' => [ 'shape' => 'ListImageVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListImages' => [ 'name' => 'ListImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImagesRequest', ], 'output' => [ 'shape' => 'ListImagesResponse', ], ], 'ListInferenceComponents' => [ 'name' => 'ListInferenceComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceComponentsInput', ], 'output' => [ 'shape' => 'ListInferenceComponentsOutput', ], ], 'ListInferenceExperiments' => [ 'name' => 'ListInferenceExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceExperimentsRequest', ], 'output' => [ 'shape' => 'ListInferenceExperimentsResponse', ], ], 'ListInferenceRecommendationsJobSteps' => [ 'name' => 'ListInferenceRecommendationsJobSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobStepsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListInferenceRecommendationsJobs' => [ 'name' => 'ListInferenceRecommendationsJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobsResponse', ], ], 'ListLabelingJobs' => [ 'name' => 'ListLabelingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsResponse', ], ], 'ListLabelingJobsForWorkteam' => [ 'name' => 'ListLabelingJobsForWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsForWorkteamRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsForWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListLineageGroups' => [ 'name' => 'ListLineageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLineageGroupsRequest', ], 'output' => [ 'shape' => 'ListLineageGroupsResponse', ], ], 'ListModelBiasJobDefinitions' => [ 'name' => 'ListModelBiasJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelBiasJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelBiasJobDefinitionsResponse', ], ], 'ListModelCardExportJobs' => [ 'name' => 'ListModelCardExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardExportJobsRequest', ], 'output' => [ 'shape' => 'ListModelCardExportJobsResponse', ], ], 'ListModelCardVersions' => [ 'name' => 'ListModelCardVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardVersionsRequest', ], 'output' => [ 'shape' => 'ListModelCardVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListModelCards' => [ 'name' => 'ListModelCards', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardsRequest', ], 'output' => [ 'shape' => 'ListModelCardsResponse', ], ], 'ListModelExplainabilityJobDefinitions' => [ 'name' => 'ListModelExplainabilityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsResponse', ], ], 'ListModelMetadata' => [ 'name' => 'ListModelMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelMetadataRequest', ], 'output' => [ 'shape' => 'ListModelMetadataResponse', ], ], 'ListModelPackageGroups' => [ 'name' => 'ListModelPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackageGroupsInput', ], 'output' => [ 'shape' => 'ListModelPackageGroupsOutput', ], ], 'ListModelPackages' => [ 'name' => 'ListModelPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackagesInput', ], 'output' => [ 'shape' => 'ListModelPackagesOutput', ], ], 'ListModelQualityJobDefinitions' => [ 'name' => 'ListModelQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelQualityJobDefinitionsResponse', ], ], 'ListModels' => [ 'name' => 'ListModels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelsInput', ], 'output' => [ 'shape' => 'ListModelsOutput', ], ], 'ListMonitoringAlertHistory' => [ 'name' => 'ListMonitoringAlertHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertHistoryRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertHistoryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringAlerts' => [ 'name' => 'ListMonitoringAlerts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertsRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringExecutions' => [ 'name' => 'ListMonitoringExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringExecutionsRequest', ], 'output' => [ 'shape' => 'ListMonitoringExecutionsResponse', ], ], 'ListMonitoringSchedules' => [ 'name' => 'ListMonitoringSchedules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringSchedulesRequest', ], 'output' => [ 'shape' => 'ListMonitoringSchedulesResponse', ], ], 'ListNotebookInstanceLifecycleConfigs' => [ 'name' => 'ListNotebookInstanceLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsInput', ], 'output' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsOutput', ], ], 'ListNotebookInstances' => [ 'name' => 'ListNotebookInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstancesInput', ], 'output' => [ 'shape' => 'ListNotebookInstancesOutput', ], ], 'ListPipelineExecutionSteps' => [ 'name' => 'ListPipelineExecutionSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionStepsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineExecutions' => [ 'name' => 'ListPipelineExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineParametersForExecution' => [ 'name' => 'ListPipelineParametersForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineParametersForExecutionRequest', ], 'output' => [ 'shape' => 'ListPipelineParametersForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], ], 'ListProcessingJobs' => [ 'name' => 'ListProcessingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProcessingJobsRequest', ], 'output' => [ 'shape' => 'ListProcessingJobsResponse', ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsInput', ], 'output' => [ 'shape' => 'ListProjectsOutput', ], ], 'ListResourceCatalogs' => [ 'name' => 'ListResourceCatalogs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceCatalogsRequest', ], 'output' => [ 'shape' => 'ListResourceCatalogsResponse', ], ], 'ListSpaces' => [ 'name' => 'ListSpaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSpacesRequest', ], 'output' => [ 'shape' => 'ListSpacesResponse', ], ], 'ListStageDevices' => [ 'name' => 'ListStageDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStageDevicesRequest', ], 'output' => [ 'shape' => 'ListStageDevicesResponse', ], ], 'ListStudioLifecycleConfigs' => [ 'name' => 'ListStudioLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioLifecycleConfigsRequest', ], 'output' => [ 'shape' => 'ListStudioLifecycleConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'ListSubscribedWorkteams' => [ 'name' => 'ListSubscribedWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSubscribedWorkteamsRequest', ], 'output' => [ 'shape' => 'ListSubscribedWorkteamsResponse', ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsInput', ], 'output' => [ 'shape' => 'ListTagsOutput', ], ], 'ListTrainingJobs' => [ 'name' => 'ListTrainingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsResponse', ], ], 'ListTrainingJobsForHyperParameterTuningJob' => [ 'name' => 'ListTrainingJobsForHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTransformJobs' => [ 'name' => 'ListTransformJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTransformJobsRequest', ], 'output' => [ 'shape' => 'ListTransformJobsResponse', ], ], 'ListTrialComponents' => [ 'name' => 'ListTrialComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialComponentsRequest', ], 'output' => [ 'shape' => 'ListTrialComponentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTrials' => [ 'name' => 'ListTrials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialsRequest', ], 'output' => [ 'shape' => 'ListTrialsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListUserProfiles' => [ 'name' => 'ListUserProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserProfilesRequest', ], 'output' => [ 'shape' => 'ListUserProfilesResponse', ], ], 'ListWorkforces' => [ 'name' => 'ListWorkforces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkforcesRequest', ], 'output' => [ 'shape' => 'ListWorkforcesResponse', ], ], 'ListWorkteams' => [ 'name' => 'ListWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkteamsRequest', ], 'output' => [ 'shape' => 'ListWorkteamsResponse', ], ], 'PutModelPackageGroupPolicy' => [ 'name' => 'PutModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'PutModelPackageGroupPolicyOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'QueryLineage' => [ 'name' => 'QueryLineage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'QueryLineageRequest', ], 'output' => [ 'shape' => 'QueryLineageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RegisterDevices' => [ 'name' => 'RegisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDevicesRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'RenderUiTemplate' => [ 'name' => 'RenderUiTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenderUiTemplateRequest', ], 'output' => [ 'shape' => 'RenderUiTemplateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RetryPipelineExecution' => [ 'name' => 'RetryPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RetryPipelineExecutionRequest', ], 'output' => [ 'shape' => 'RetryPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'Search' => [ 'name' => 'Search', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchRequest', ], 'output' => [ 'shape' => 'SearchResponse', ], ], 'SendPipelineExecutionStepFailure' => [ 'name' => 'SendPipelineExecutionStepFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepFailureRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepFailureResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'SendPipelineExecutionStepSuccess' => [ 'name' => 'SendPipelineExecutionStepSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepSuccessRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepSuccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StartEdgeDeploymentStage' => [ 'name' => 'StartEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartEdgeDeploymentStageRequest', ], ], 'StartInferenceExperiment' => [ 'name' => 'StartInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StartInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StartMonitoringSchedule' => [ 'name' => 'StartMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StartNotebookInstance' => [ 'name' => 'StartNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookInstanceInput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartPipelineExecution' => [ 'name' => 'StartPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StartPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StopAutoMLJob' => [ 'name' => 'StopAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopAutoMLJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopCompilationJob' => [ 'name' => 'StopCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopEdgeDeploymentStage' => [ 'name' => 'StopEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgeDeploymentStageRequest', ], ], 'StopEdgePackagingJob' => [ 'name' => 'StopEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgePackagingJobRequest', ], ], 'StopHyperParameterTuningJob' => [ 'name' => 'StopHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopHyperParameterTuningJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceExperiment' => [ 'name' => 'StopInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StopInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceRecommendationsJob' => [ 'name' => 'StopInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceRecommendationsJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopLabelingJob' => [ 'name' => 'StopLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopLabelingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopMonitoringSchedule' => [ 'name' => 'StopMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopNotebookInstance' => [ 'name' => 'StopNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookInstanceInput', ], ], 'StopPipelineExecution' => [ 'name' => 'StopPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StopPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'StopProcessingJob' => [ 'name' => 'StopProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopProcessingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTrainingJob' => [ 'name' => 'StopTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTrainingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTransformJob' => [ 'name' => 'StopTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTransformJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAction' => [ 'name' => 'UpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateActionRequest', ], 'output' => [ 'shape' => 'UpdateActionResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAppImageConfig' => [ 'name' => 'UpdateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAppImageConfigRequest', ], 'output' => [ 'shape' => 'UpdateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateArtifact' => [ 'name' => 'UpdateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateArtifactRequest', ], 'output' => [ 'shape' => 'UpdateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateCluster' => [ 'name' => 'UpdateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterRequest', ], 'output' => [ 'shape' => 'UpdateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateClusterSoftware' => [ 'name' => 'UpdateClusterSoftware', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterSoftwareRequest', ], 'output' => [ 'shape' => 'UpdateClusterSoftwareResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateCodeRepository' => [ 'name' => 'UpdateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCodeRepositoryInput', ], 'output' => [ 'shape' => 'UpdateCodeRepositoryOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateContext' => [ 'name' => 'UpdateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContextRequest', ], 'output' => [ 'shape' => 'UpdateContextResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateDeviceFleet' => [ 'name' => 'UpdateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'UpdateDevices' => [ 'name' => 'UpdateDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicesRequest', ], ], 'UpdateDomain' => [ 'name' => 'UpdateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainRequest', ], 'output' => [ 'shape' => 'UpdateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateEndpoint' => [ 'name' => 'UpdateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointInput', ], 'output' => [ 'shape' => 'UpdateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateEndpointWeightsAndCapacities' => [ 'name' => 'UpdateEndpointWeightsAndCapacities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesInput', ], 'output' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateExperiment' => [ 'name' => 'UpdateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateExperimentRequest', ], 'output' => [ 'shape' => 'UpdateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureGroup' => [ 'name' => 'UpdateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureGroupRequest', ], 'output' => [ 'shape' => 'UpdateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateFeatureMetadata' => [ 'name' => 'UpdateFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureMetadataRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateHub' => [ 'name' => 'UpdateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateHubRequest', ], 'output' => [ 'shape' => 'UpdateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImage' => [ 'name' => 'UpdateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageRequest', ], 'output' => [ 'shape' => 'UpdateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImageVersion' => [ 'name' => 'UpdateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageVersionRequest', ], 'output' => [ 'shape' => 'UpdateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateInferenceComponent' => [ 'name' => 'UpdateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceComponentRuntimeConfig' => [ 'name' => 'UpdateInferenceComponentRuntimeConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceExperiment' => [ 'name' => 'UpdateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'UpdateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateModelCard' => [ 'name' => 'UpdateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelCardRequest', ], 'output' => [ 'shape' => 'UpdateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateModelPackage' => [ 'name' => 'UpdateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelPackageInput', ], 'output' => [ 'shape' => 'UpdateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateMonitoringAlert' => [ 'name' => 'UpdateMonitoringAlert', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringAlertRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringAlertResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMonitoringSchedule' => [ 'name' => 'UpdateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateNotebookInstance' => [ 'name' => 'UpdateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateNotebookInstanceLifecycleConfig' => [ 'name' => 'UpdateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdatePipelineExecution' => [ 'name' => 'UpdatePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineExecutionRequest', ], 'output' => [ 'shape' => 'UpdatePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectInput', ], 'output' => [ 'shape' => 'UpdateProjectOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateSpace' => [ 'name' => 'UpdateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSpaceRequest', ], 'output' => [ 'shape' => 'UpdateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrainingJob' => [ 'name' => 'UpdateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrainingJobRequest', ], 'output' => [ 'shape' => 'UpdateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateTrial' => [ 'name' => 'UpdateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialRequest', ], 'output' => [ 'shape' => 'UpdateTrialResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrialComponent' => [ 'name' => 'UpdateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialComponentRequest', ], 'output' => [ 'shape' => 'UpdateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateUserProfile' => [ 'name' => 'UpdateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserProfileRequest', ], 'output' => [ 'shape' => 'UpdateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateWorkforce' => [ 'name' => 'UpdateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkforceRequest', ], 'output' => [ 'shape' => 'UpdateWorkforceResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateWorkteam' => [ 'name' => 'UpdateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkteamRequest', ], 'output' => [ 'shape' => 'UpdateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], ], 'shapes' => [ 'Accept' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'AcceptEula' => [ 'type' => 'boolean', ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^\\d+$', ], 'ActionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*', ], 'ActionSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String64', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AddAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'AddAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'max' => 3, ], 'AdditionalInferenceSpecificationDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Containers', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'AdditionalInferenceSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalInferenceSpecificationDefinition', ], 'max' => 15, 'min' => 1, ], 'AdditionalS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AdditionalS3DataSourceDataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], ], ], 'AdditionalS3DataSourceDataType' => [ 'type' => 'string', 'enum' => [ 'S3Object', 'S3Prefix', ], ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'Version', 'AgentCount', ], 'members' => [ 'Version' => [ 'shape' => 'EdgeVersion', ], 'AgentCount' => [ 'shape' => 'Long', ], ], ], 'AgentVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersion', ], ], 'AggregationTransformationValue' => [ 'type' => 'string', 'enum' => [ 'sum', 'avg', 'first', 'min', 'max', ], ], 'AggregationTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'AggregationTransformationValue', ], 'max' => 50, 'min' => 1, ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'AlarmName' => [ 'shape' => 'AlarmName', ], ], ], 'AlarmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], 'max' => 10, 'min' => 1, ], 'AlarmName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?!\\s*$).+', ], 'AlgorithmArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$', ], 'AlgorithmImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'AlgorithmSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'AlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'EnableSageMakerMetricsTimeSeries' => [ 'shape' => 'Boolean', ], 'ContainerEntrypoint' => [ 'shape' => 'TrainingContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'TrainingContainerArguments', ], 'TrainingImageConfig' => [ 'shape' => 'TrainingImageConfig', ], ], ], 'AlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'AlgorithmStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ValidationStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], ], ], 'AlgorithmStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedAlgorithmStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'AlgorithmStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmStatusItem', ], ], 'AlgorithmSummary' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'AlgorithmStatus', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], ], ], 'AlgorithmSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmSummary', ], ], 'AlgorithmValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TrainingJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TrainingJobDefinition' => [ 'shape' => 'TrainingJobDefinition', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'AlgorithmValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmValidationProfile', ], 'max' => 1, 'min' => 1, ], 'AlgorithmValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'AlgorithmValidationProfiles', ], ], ], 'AnnotationConsolidationConfig' => [ 'type' => 'structure', 'required' => [ 'AnnotationConsolidationLambdaArn', ], 'members' => [ 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], ], ], 'AppArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*', ], 'AppDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'AppImageConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*', ], 'AppImageConfigDetails' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'AppImageConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppImageConfigDetails', ], ], 'AppImageConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppImageConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'AppInstanceType' => [ 'type' => 'string', 'enum' => [ 'system', 'ml.t3.micro', 'ml.t3.small', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.geospatial.interactive', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.p5.48xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r6i.large', 'ml.r6i.xlarge', 'ml.r6i.2xlarge', 'ml.r6i.4xlarge', 'ml.r6i.8xlarge', 'ml.r6i.12xlarge', 'ml.r6i.16xlarge', 'ml.r6i.24xlarge', 'ml.r6i.32xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', 'ml.m6id.large', 'ml.m6id.xlarge', 'ml.m6id.2xlarge', 'ml.m6id.4xlarge', 'ml.m6id.8xlarge', 'ml.m6id.12xlarge', 'ml.m6id.16xlarge', 'ml.m6id.24xlarge', 'ml.m6id.32xlarge', 'ml.c6id.large', 'ml.c6id.xlarge', 'ml.c6id.2xlarge', 'ml.c6id.4xlarge', 'ml.c6id.8xlarge', 'ml.c6id.12xlarge', 'ml.c6id.16xlarge', 'ml.c6id.24xlarge', 'ml.c6id.32xlarge', 'ml.r6id.large', 'ml.r6id.xlarge', 'ml.r6id.2xlarge', 'ml.r6id.4xlarge', 'ml.r6id.8xlarge', 'ml.r6id.12xlarge', 'ml.r6id.16xlarge', 'ml.r6id.24xlarge', 'ml.r6id.32xlarge', ], ], 'AppList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppDetails', ], ], 'AppManaged' => [ 'type' => 'boolean', ], 'AppName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppNetworkAccessType' => [ 'type' => 'string', 'enum' => [ 'PublicInternetOnly', 'VpcOnly', ], ], 'AppSecurityGroupManagement' => [ 'type' => 'string', 'enum' => [ 'Service', 'Customer', ], ], 'AppSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'AppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'ContainerArguments', ], ], ], 'AppStatus' => [ 'type' => 'string', 'enum' => [ 'Deleted', 'Deleting', 'Failed', 'InService', 'Pending', ], ], 'AppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'DetailedProfiler', 'TensorBoard', 'CodeEditor', 'JupyterLab', 'RStudioServerPro', 'RSessionGateway', 'Canvas', ], ], 'ApprovalDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'ArnOrName' => [ 'type' => 'string', 'max' => 170, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:artifact/.*', ], 'ArtifactDigest' => [ 'type' => 'string', 'pattern' => '^[\\w:]+$', ], 'ArtifactProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'ArtifactPropertyValue', ], 'max' => 30, ], 'ArtifactPropertyValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ArtifactSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceTypes' => [ 'shape' => 'ArtifactSourceTypes', ], ], ], 'ArtifactSourceIdType' => [ 'type' => 'string', 'enum' => [ 'MD5Hash', 'S3ETag', 'S3Version', 'Custom', ], ], 'ArtifactSourceType' => [ 'type' => 'structure', 'required' => [ 'SourceIdType', 'Value', ], 'members' => [ 'SourceIdType' => [ 'shape' => 'ArtifactSourceIdType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ArtifactSourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSourceType', ], ], 'ArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSummary', ], ], 'ArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssemblyType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', ], ], 'AssociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'AssociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'AssociationEdgeType' => [ 'type' => 'string', 'enum' => [ 'ContributedTo', 'AssociatedWith', 'DerivedFrom', 'Produced', 'SameAs', ], ], 'AssociationEntityArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*', ], 'AssociationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationSummary', ], ], 'AssociationSummary' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'SourceName' => [ 'shape' => 'ExperimentEntityName', ], 'DestinationName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'AsyncInferenceClientConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrentInvocationsPerInstance' => [ 'shape' => 'MaxConcurrentInvocationsPerInstance', ], ], ], 'AsyncInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'OutputConfig', ], 'members' => [ 'ClientConfig' => [ 'shape' => 'AsyncInferenceClientConfig', ], 'OutputConfig' => [ 'shape' => 'AsyncInferenceOutputConfig', ], ], ], 'AsyncInferenceNotificationConfig' => [ 'type' => 'structure', 'members' => [ 'SuccessTopic' => [ 'shape' => 'SnsTopicArn', ], 'ErrorTopic' => [ 'shape' => 'SnsTopicArn', ], 'IncludeInferenceResponseIn' => [ 'shape' => 'AsyncNotificationTopicTypeList', ], ], ], 'AsyncInferenceOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'DestinationS3Uri', ], 'NotificationConfig' => [ 'shape' => 'AsyncInferenceNotificationConfig', ], 'S3FailurePath' => [ 'shape' => 'DestinationS3Uri', ], ], ], 'AsyncNotificationTopicTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AsyncNotificationTopicTypes', ], 'max' => 2, 'min' => 0, ], 'AsyncNotificationTopicTypes' => [ 'type' => 'string', 'enum' => [ 'SUCCESS_NOTIFICATION_TOPIC', 'ERROR_NOTIFICATION_TOPIC', ], ], 'AthenaCatalog' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'AthenaDatabase' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'AthenaDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'Catalog', 'Database', 'QueryString', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'Catalog' => [ 'shape' => 'AthenaCatalog', ], 'Database' => [ 'shape' => 'AthenaDatabase', ], 'QueryString' => [ 'shape' => 'AthenaQueryString', ], 'WorkGroup' => [ 'shape' => 'AthenaWorkGroup', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'AthenaResultFormat', ], 'OutputCompression' => [ 'shape' => 'AthenaResultCompressionType', ], ], ], 'AthenaQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'AthenaResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'SNAPPY', 'ZLIB', ], ], 'AthenaResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'ORC', 'AVRO', 'JSON', 'TEXTFILE', ], ], 'AthenaWorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9._-]+', ], 'AttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.+', ], 'AttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeName', ], 'max' => 16, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoGenerateEndpointName' => [ 'type' => 'boolean', ], 'AutoMLAlgorithm' => [ 'type' => 'string', 'enum' => [ 'xgboost', 'linear-learner', 'mlp', 'lightgbm', 'catboost', 'randomforest', 'extra-trees', 'nn-torch', 'fastai', ], ], 'AutoMLAlgorithmConfig' => [ 'type' => 'structure', 'required' => [ 'AutoMLAlgorithms', ], 'members' => [ 'AutoMLAlgorithms' => [ 'shape' => 'AutoMLAlgorithms', ], ], ], 'AutoMLAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithm', ], 'max' => 11, ], 'AutoMLAlgorithmsConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithmConfig', ], 'max' => 1, ], 'AutoMLCandidate' => [ 'type' => 'structure', 'required' => [ 'CandidateName', 'ObjectiveStatus', 'CandidateSteps', 'CandidateStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CandidateName' => [ 'shape' => 'CandidateName', ], 'FinalAutoMLJobObjectiveMetric' => [ 'shape' => 'FinalAutoMLJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], 'CandidateSteps' => [ 'shape' => 'CandidateSteps', ], 'CandidateStatus' => [ 'shape' => 'CandidateStatus', ], 'InferenceContainers' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'CandidateProperties' => [ 'shape' => 'CandidateProperties', ], 'InferenceContainerDefinitions' => [ 'shape' => 'AutoMLInferenceContainerDefinitions', ], ], ], 'AutoMLCandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'AutoMLCandidateStep' => [ 'type' => 'structure', 'required' => [ 'CandidateStepType', 'CandidateStepArn', 'CandidateStepName', ], 'members' => [ 'CandidateStepType' => [ 'shape' => 'CandidateStepType', ], 'CandidateStepArn' => [ 'shape' => 'CandidateStepArn', ], 'CandidateStepName' => [ 'shape' => 'CandidateStepName', ], ], ], 'AutoMLCandidates' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidate', ], ], 'AutoMLChannel' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'AutoMLChannelType' => [ 'type' => 'string', 'enum' => [ 'training', 'validation', ], ], 'AutoMLContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', 'ModelDataUrl', ], 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'AutoMLContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLContainerDefinition', ], 'max' => 5, ], 'AutoMLDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'AutoMLS3DataSource', ], ], ], 'AutoMLDataSplitConfig' => [ 'type' => 'structure', 'members' => [ 'ValidationFraction' => [ 'shape' => 'ValidationFraction', ], ], ], 'AutoMLFailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'AutoMLInferenceContainerDefinitions' => [ 'type' => 'map', 'key' => [ 'shape' => 'AutoMLProcessingUnit', ], 'value' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'max' => 2, ], 'AutoMLInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*', ], 'AutoMLJobArtifacts' => [ 'type' => 'structure', 'members' => [ 'CandidateDefinitionNotebookLocation' => [ 'shape' => 'CandidateDefinitionNotebookLocation', ], 'DataExplorationNotebookLocation' => [ 'shape' => 'DataExplorationNotebookLocation', ], ], ], 'AutoMLJobChannel' => [ 'type' => 'structure', 'members' => [ 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], ], ], 'AutoMLJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'MaxCandidates' => [ 'shape' => 'MaxCandidates', ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'shape' => 'MaxRuntimePerTrainingJobInSeconds', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'shape' => 'MaxAutoMLJobRuntimeInSeconds', ], ], ], 'AutoMLJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'CandidateGenerationConfig' => [ 'shape' => 'AutoMLCandidateGenerationConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], ], ], 'AutoMLJobInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'AutoMLJobObjective' => [ 'type' => 'structure', 'required' => [ 'MetricName', ], 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'AutoMLJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'AutoMLJobSecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'MaxCandidatesReached', 'Failed', 'Stopped', 'MaxAutoMLJobRuntimeReached', 'Stopping', 'CandidateDefinitionsGenerated', 'Completed', 'ExplainabilityError', 'DeployingModel', 'ModelDeploymentError', 'GeneratingModelInsightsReport', 'ModelInsightsError', 'AnalyzingData', 'FeatureEngineering', 'ModelTuning', 'GeneratingExplainabilityReport', 'TrainingModels', 'PreTraining', ], ], 'AutoMLJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'AutoMLJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'AutoMLJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobSummary', ], ], 'AutoMLJobSummary' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], ], ], 'AutoMLMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'AutoMLMaxResultsForTrials' => [ 'type' => 'integer', 'max' => 300, 'min' => 1, ], 'AutoMLMetricEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'BalancedAccuracy', 'R2', 'Recall', 'RecallMacro', 'Precision', 'PrecisionMacro', 'MAE', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMetricExtendedEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'LogLoss', 'InferenceLatency', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', 'Rouge1', 'Rouge2', 'RougeL', 'RougeLSum', 'Perplexity', 'ValidationLoss', 'TrainingLoss', ], ], 'AutoMLMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'ENSEMBLING', 'HYPERPARAMETER_TUNING', ], ], 'AutoMLNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'AutoMLOutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLPartialFailureReason' => [ 'type' => 'structure', 'members' => [ 'PartialFailureMessage' => [ 'shape' => 'AutoMLFailureReason', ], ], ], 'AutoMLPartialFailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLPartialFailureReason', ], 'max' => 5, 'min' => 1, ], 'AutoMLProblemTypeConfig' => [ 'type' => 'structure', 'members' => [ 'ImageClassificationJobConfig' => [ 'shape' => 'ImageClassificationJobConfig', ], 'TextClassificationJobConfig' => [ 'shape' => 'TextClassificationJobConfig', ], 'TimeSeriesForecastingJobConfig' => [ 'shape' => 'TimeSeriesForecastingJobConfig', ], 'TabularJobConfig' => [ 'shape' => 'TabularJobConfig', ], 'TextGenerationJobConfig' => [ 'shape' => 'TextGenerationJobConfig', ], ], 'union' => true, ], 'AutoMLProblemTypeConfigName' => [ 'type' => 'string', 'enum' => [ 'ImageClassification', 'TextClassification', 'TimeSeriesForecasting', 'Tabular', 'TextGeneration', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'TabularResolvedAttributes' => [ 'shape' => 'TabularResolvedAttributes', ], 'TextGenerationResolvedAttributes' => [ 'shape' => 'TextGenerationResolvedAttributes', ], ], 'union' => true, ], 'AutoMLProcessingUnit' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'AutoMLResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'AutoMLProblemTypeResolvedAttributes' => [ 'shape' => 'AutoMLProblemTypeResolvedAttributes', ], ], ], 'AutoMLS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AutoMLS3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'AutoMLSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'AutoMLSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'AutoMLSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'AutoParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'ValueHint', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'ValueHint' => [ 'shape' => 'ParameterValue', ], ], ], 'AutoParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoParameter', ], 'max' => 100, 'min' => 0, ], 'AutoRollbackConfig' => [ 'type' => 'structure', 'members' => [ 'Alarms' => [ 'shape' => 'AlarmList', ], ], ], 'Autotune' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'AutotuneMode', ], ], ], 'AutotuneMode' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'type' => 'string', 'enum' => [ 'AWS/Rekognition/DetectModerationLabels/Image/V3', 'AWS/Textract/AnalyzeDocument/Forms/V1', ], ], 'BacktestResultsLocation' => [ 'type' => 'string', 'min' => 1, ], 'BaseModelName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'BatchDataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'GenerateInferenceId' => [ 'shape' => 'Boolean', ], ], ], 'BatchDescribeModelPackageError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'ErrorResponse', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorResponse' => [ 'shape' => 'String', ], ], ], 'BatchDescribeModelPackageErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageError', ], ], 'BatchDescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArnList', ], 'members' => [ 'ModelPackageArnList' => [ 'shape' => 'ModelPackageArnList', ], ], ], 'BatchDescribeModelPackageOutput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageSummaries' => [ 'shape' => 'ModelPackageSummaries', ], 'BatchDescribeModelPackageErrorMap' => [ 'shape' => 'BatchDescribeModelPackageErrorMap', ], ], ], 'BatchDescribeModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageArn', 'CreationTime', 'InferenceSpecification', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'BatchStrategy' => [ 'type' => 'string', 'enum' => [ 'MultiRecord', 'SingleRecord', ], ], 'BatchTransformInput' => [ 'type' => 'structure', 'required' => [ 'DataCapturedDestinationS3Uri', 'DatasetFormat', 'LocalPath', ], 'members' => [ 'DataCapturedDestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'DatasetFormat' => [ 'shape' => 'MonitoringDatasetFormat', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'BestObjectiveNotImproving' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTrainingJobsNotImproving' => [ 'shape' => 'MaxNumberOfTrainingJobsNotImproving', ], ], ], 'Bias' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], 'PreTrainingReport' => [ 'shape' => 'MetricsSource', ], 'PostTrainingReport' => [ 'shape' => 'MetricsSource', ], ], ], 'BillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'BlockedReason' => [ 'type' => 'string', 'max' => 1024, ], 'BlueGreenUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'TrafficRoutingConfiguration', ], 'members' => [ 'TrafficRoutingConfiguration' => [ 'shape' => 'TrafficRoutingConfig', ], 'TerminationWaitInSeconds' => [ 'shape' => 'TerminationWaitInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOperator' => [ 'type' => 'string', 'enum' => [ 'And', 'Or', ], ], 'Branch' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[^ ~^:?*\\[]+', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'CacheHitResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'CallbackStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'SqsQueueUrl' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'CallbackToken' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]+$', ], 'CandidateArtifactLocations' => [ 'type' => 'structure', 'required' => [ 'Explainability', ], 'members' => [ 'Explainability' => [ 'shape' => 'ExplainabilityLocation', ], 'ModelInsights' => [ 'shape' => 'ModelInsightsLocation', ], 'BacktestResults' => [ 'shape' => 'BacktestResultsLocation', ], ], ], 'CandidateDefinitionNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'CandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'CandidateName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateProperties' => [ 'type' => 'structure', 'members' => [ 'CandidateArtifactLocations' => [ 'shape' => 'CandidateArtifactLocations', ], 'CandidateMetrics' => [ 'shape' => 'MetricDataList', ], ], ], 'CandidateSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'CandidateStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'CandidateStepArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*', ], 'CandidateStepName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateStepType' => [ 'type' => 'string', 'enum' => [ 'AWS::SageMaker::TrainingJob', 'AWS::SageMaker::TransformJob', 'AWS::SageMaker::ProcessingJob', ], ], 'CandidateSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidateStep', ], ], 'CanvasAppSettings' => [ 'type' => 'structure', 'members' => [ 'TimeSeriesForecastingSettings' => [ 'shape' => 'TimeSeriesForecastingSettings', ], 'ModelRegisterSettings' => [ 'shape' => 'ModelRegisterSettings', ], 'WorkspaceSettings' => [ 'shape' => 'WorkspaceSettings', ], 'IdentityProviderOAuthSettings' => [ 'shape' => 'IdentityProviderOAuthSettings', ], 'DirectDeploySettings' => [ 'shape' => 'DirectDeploySettings', ], 'KendraSettings' => [ 'shape' => 'KendraSettings', ], 'GenerativeAiSettings' => [ 'shape' => 'GenerativeAiSettings', ], ], ], 'CapacitySize' => [ 'type' => 'structure', 'required' => [ 'Type', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'CapacitySizeType', ], 'Value' => [ 'shape' => 'CapacitySizeValue', ], ], ], 'CapacitySizeType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_COUNT', 'CAPACITY_PERCENT', ], ], 'CapacitySizeValue' => [ 'type' => 'integer', 'min' => 1, ], 'CapacityUnit' => [ 'type' => 'integer', 'max' => 10000000, 'min' => 0, ], 'CaptureContentTypeHeader' => [ 'type' => 'structure', 'members' => [ 'CsvContentTypes' => [ 'shape' => 'CsvContentTypes', ], 'JsonContentTypes' => [ 'shape' => 'JsonContentTypes', ], ], ], 'CaptureMode' => [ 'type' => 'string', 'enum' => [ 'Input', 'Output', 'InputAndOutput', ], ], 'CaptureOption' => [ 'type' => 'structure', 'required' => [ 'CaptureMode', ], 'members' => [ 'CaptureMode' => [ 'shape' => 'CaptureMode', ], ], ], 'CaptureOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptureOption', ], 'max' => 32, 'min' => 1, ], 'CaptureStatus' => [ 'type' => 'string', 'enum' => [ 'Started', 'Stopped', ], ], 'Catalog' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'CategoricalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String64', ], 'Value' => [ 'shape' => 'CategoricalParameterRangeValues', ], ], ], 'CategoricalParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String128', ], 'max' => 3, 'min' => 1, ], 'CategoricalParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameterRange', ], 'max' => 30, 'min' => 0, ], 'CategoricalParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameter', ], 'max' => 5, 'min' => 1, ], 'Cents' => [ 'type' => 'integer', 'max' => 99, 'min' => 0, ], 'CertifyForMarketplace' => [ 'type' => 'boolean', ], 'Channel' => [ 'type' => 'structure', 'required' => [ 'ChannelName', 'DataSource', ], 'members' => [ 'ChannelName' => [ 'shape' => 'ChannelName', ], 'DataSource' => [ 'shape' => 'DataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'RecordWrapperType' => [ 'shape' => 'RecordWrapper', ], 'InputMode' => [ 'shape' => 'TrainingInputMode', ], 'ShuffleConfig' => [ 'shape' => 'ShuffleConfig', ], ], ], 'ChannelName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9\\.\\-_]+', ], 'ChannelSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'SupportedContentTypes', 'SupportedInputModes', ], 'members' => [ 'Name' => [ 'shape' => 'ChannelName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedCompressionTypes' => [ 'shape' => 'CompressionTypes', ], 'SupportedInputModes' => [ 'shape' => 'InputModes', ], ], ], 'ChannelSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSpecification', ], 'max' => 8, 'min' => 1, ], 'CheckpointConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'Cidr' => [ 'type' => 'string', 'max' => 64, 'min' => 4, '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]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)', ], 'Cidrs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cidr', ], ], 'ClarifyCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'ClarifyContentTemplate' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyEnableExplanations' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyExplainerConfig' => [ 'type' => 'structure', 'required' => [ 'ShapConfig', ], 'members' => [ 'EnableExplanations' => [ 'shape' => 'ClarifyEnableExplanations', ], 'InferenceConfig' => [ 'shape' => 'ClarifyInferenceConfig', ], 'ShapConfig' => [ 'shape' => 'ClarifyShapConfig', ], ], ], 'ClarifyFeatureHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeatureType' => [ 'type' => 'string', 'enum' => [ 'numerical', 'categorical', 'text', ], ], 'ClarifyFeatureTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyFeatureType', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeaturesAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyHeader' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'FeaturesAttribute' => [ 'shape' => 'ClarifyFeaturesAttribute', ], 'ContentTemplate' => [ 'shape' => 'ClarifyContentTemplate', ], 'MaxRecordCount' => [ 'shape' => 'ClarifyMaxRecordCount', ], 'MaxPayloadInMB' => [ 'shape' => 'ClarifyMaxPayloadInMB', ], 'ProbabilityIndex' => [ 'shape' => 'ClarifyProbabilityIndex', ], 'LabelIndex' => [ 'shape' => 'ClarifyLabelIndex', ], 'ProbabilityAttribute' => [ 'shape' => 'ClarifyProbabilityAttribute', ], 'LabelAttribute' => [ 'shape' => 'ClarifyLabelAttribute', ], 'LabelHeaders' => [ 'shape' => 'ClarifyLabelHeaders', ], 'FeatureHeaders' => [ 'shape' => 'ClarifyFeatureHeaders', ], 'FeatureTypes' => [ 'shape' => 'ClarifyFeatureTypes', ], ], ], 'ClarifyLabelAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyLabelHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 16, 'min' => 1, ], 'ClarifyLabelIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyMaxPayloadInMB' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'ClarifyMaxRecordCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyMimeType' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*', ], 'ClarifyProbabilityAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyProbabilityIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyShapBaseline' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'ClarifyShapBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'MimeType' => [ 'shape' => 'ClarifyMimeType', ], 'ShapBaseline' => [ 'shape' => 'ClarifyShapBaseline', ], 'ShapBaselineUri' => [ 'shape' => 'Url', ], ], ], 'ClarifyShapConfig' => [ 'type' => 'structure', 'required' => [ 'ShapBaselineConfig', ], 'members' => [ 'ShapBaselineConfig' => [ 'shape' => 'ClarifyShapBaselineConfig', ], 'NumberOfSamples' => [ 'shape' => 'ClarifyShapNumberOfSamples', ], 'UseLogit' => [ 'shape' => 'ClarifyShapUseLogit', ], 'Seed' => [ 'shape' => 'ClarifyShapSeed', ], 'TextConfig' => [ 'shape' => 'ClarifyTextConfig', ], ], ], 'ClarifyShapNumberOfSamples' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyShapSeed' => [ 'type' => 'integer', ], 'ClarifyShapUseLogit' => [ 'type' => 'boolean', ], 'ClarifyTextConfig' => [ 'type' => 'structure', 'required' => [ 'Language', 'Granularity', ], 'members' => [ 'Language' => [ 'shape' => 'ClarifyTextLanguage', ], 'Granularity' => [ 'shape' => 'ClarifyTextGranularity', ], ], ], 'ClarifyTextGranularity' => [ 'type' => 'string', 'enum' => [ 'token', 'sentence', 'paragraph', ], ], 'ClarifyTextLanguage' => [ 'type' => 'string', 'enum' => [ 'af', 'sq', 'ar', 'hy', 'eu', 'bn', 'bg', 'ca', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'de', 'el', 'gu', 'he', 'hi', 'hu', 'is', 'id', 'ga', 'it', 'kn', 'ky', 'lv', 'lt', 'lb', 'mk', 'ml', 'mr', 'ne', 'nb', 'fa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sr', 'tn', 'si', 'sk', 'sl', 'es', 'sv', 'tl', 'ta', 'tt', 'te', 'tr', 'uk', 'ur', 'yo', 'lij', 'xx', ], ], 'ClientId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', ], 'ClientSecret' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', 'sensitive' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'ClusterArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$', ], 'ClusterInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClusterInstanceGroupDetails' => [ 'type' => 'structure', 'members' => [ 'CurrentCount' => [ 'shape' => 'ClusterNonNegativeInstanceCount', ], 'TargetCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupDetails', ], ], 'ClusterInstanceGroupName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterInstanceGroupSpecification' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceGroupName', 'InstanceType', 'LifeCycleConfig', 'ExecutionRole', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupSpecification', ], 'max' => 5, 'min' => 1, ], 'ClusterInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Running', 'Failure', 'Pending', 'ShuttingDown', 'SystemUpdating', ], ], 'ClusterInstanceStatusDetails' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ClusterInstanceStatus', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ClusterInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.c5n.large', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', ], ], 'ClusterLifeCycleConfig' => [ 'type' => 'structure', 'required' => [ 'SourceS3Uri', 'OnCreate', ], 'members' => [ 'SourceS3Uri' => [ 'shape' => 'S3Uri', ], 'OnCreate' => [ 'shape' => 'ClusterLifeCycleConfigFileName', ], ], ], 'ClusterLifeCycleConfigFileName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\S\\s]+$', ], 'ClusterName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterNameOrArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$', ], 'ClusterNodeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterNodeId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z][-a-zA-Z0-9]*$', ], 'ClusterNodeSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterNodeSummary', ], ], 'ClusterNodeSummary' => [ 'type' => 'structure', 'required' => [ 'InstanceGroupName', 'InstanceId', 'InstanceType', 'LaunchTime', 'InstanceStatus', ], 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], ], ], 'ClusterNonNegativeInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'ClusterSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'NAME', ], ], 'ClusterStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Deleting', 'Failed', 'InService', 'RollingBack', 'SystemUpdating', 'Updating', ], ], 'ClusterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSummary', ], ], 'ClusterSummary' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterName', 'CreationTime', 'ClusterStatus', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], ], ], 'ClusterThreadsPerCore' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'CodeEditorAppImageConfig' => [ 'type' => 'structure', 'members' => [ 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], 'ContainerConfig' => [ 'shape' => 'ContainerConfig', ], ], ], 'CodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'CodeRepositories' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepository', ], 'max' => 10, ], 'CodeRepository' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'RepositoryUrl', ], ], ], 'CodeRepositoryArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$', ], 'CodeRepositoryContains' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameOrUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'CodeRepositorySortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'CodeRepositorySortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'CodeRepositorySummary' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'CodeRepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositorySummary', ], ], 'CognitoConfig' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'UserGroup', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'UserGroup' => [ 'shape' => 'CognitoUserGroup', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoUserGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CognitoUserPool' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'CollectionConfig' => [ 'type' => 'structure', 'members' => [ 'VectorConfig' => [ 'shape' => 'VectorConfig', ], ], 'union' => true, ], 'CollectionConfiguration' => [ 'type' => 'structure', 'members' => [ 'CollectionName' => [ 'shape' => 'CollectionName', ], 'CollectionParameters' => [ 'shape' => 'CollectionParameters', ], ], ], 'CollectionConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectionConfiguration', ], 'max' => 20, 'min' => 0, ], 'CollectionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'CollectionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'CollectionType' => [ 'type' => 'string', 'enum' => [ 'List', 'Set', 'Vector', ], ], 'CompilationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*', ], 'CompilationJobStatus' => [ 'type' => 'string', 'enum' => [ 'INPROGRESS', 'COMPLETED', 'FAILED', 'STARTING', 'STOPPING', 'STOPPED', ], ], 'CompilationJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompilationJobSummary', ], ], 'CompilationJobSummary' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CreationTime', 'CompilationJobStatus', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'CompilationTargetDevice' => [ 'shape' => 'TargetDevice', ], 'CompilationTargetPlatformOs' => [ 'shape' => 'TargetPlatformOs', ], 'CompilationTargetPlatformArch' => [ 'shape' => 'TargetPlatformArch', ], 'CompilationTargetPlatformAccelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], ], ], 'CompilerOptions' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '.*', ], 'CompleteOnConvergence' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Enabled', ], ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'CompressionTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompressionType', ], ], 'ConditionOutcome' => [ 'type' => 'string', 'enum' => [ 'True', 'False', ], ], 'ConditionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Outcome' => [ 'shape' => 'ConditionOutcome', ], ], ], 'ConfigKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'ConfigValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 100, 'min' => 1, ], 'ContainerConfig' => [ 'type' => 'structure', 'members' => [ 'ContainerArguments' => [ 'shape' => 'CustomImageContainerArguments', ], 'ContainerEntrypoint' => [ 'shape' => 'CustomImageContainerEntrypoint', ], 'ContainerEnvironmentVariables' => [ 'shape' => 'CustomImageContainerEnvironmentVariables', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageConfig' => [ 'shape' => 'ImageConfig', ], 'Mode' => [ 'shape' => 'ContainerMode', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'MultiModelConfig' => [ 'shape' => 'MultiModelConfig', ], ], ], 'ContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], 'max' => 15, ], 'ContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'ContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerHostname' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ContainerImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '[\\S]+', ], 'ContainerMode' => [ 'type' => 'string', 'enum' => [ 'SingleModel', 'MultiModel', ], ], 'ContentClassifier' => [ 'type' => 'string', 'enum' => [ 'FreeOfPersonallyIdentifiableInformation', 'FreeOfAdultContent', ], ], 'ContentClassifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentClassifier', ], 'max' => 256, ], 'ContentColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContentDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentType', ], ], 'ContextArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*', ], 'ContextName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}', ], 'ContextNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})', ], 'ContextSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ContextSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextSummary', ], ], 'ContextSummary' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ContinuousParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'ContinuousParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ContinuousParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousParameterRange', ], 'max' => 30, 'min' => 0, ], 'ConvergenceDetected' => [ 'type' => 'structure', 'members' => [ 'CompleteOnConvergence' => [ 'shape' => 'CompleteOnConvergence', ], ], ], 'CountryCode' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Z]{2}', ], 'CreateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', 'Source', 'ActionType', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'CreateAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'TrainingSpecification', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmArn', ], 'members' => [ 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], ], ], 'CreateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'Tags' => [ 'shape' => 'TagList', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'CreateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], ], ], 'CreateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'Source', 'ArtifactType', ], 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'CreateAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], ], ], 'CreateAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'AutoMLProblemTypeConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], ], ], 'CreateAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterName', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'CreateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'GitConfig', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'CreateCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'RoleArn', 'OutputConfig', 'StoppingCondition', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobArn', ], 'members' => [ 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], ], ], 'CreateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', 'Source', 'ContextType', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'CreateDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'AuthMode', 'DefaultUserSettings', 'SubnetIds', 'VpcId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Tags' => [ 'shape' => 'TagList', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'CreateEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], ], ], 'CreateEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], ], ], 'CreateEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', 'CompilationJobName', 'ModelName', 'ModelVersion', 'RoleArn', 'OutputConfig', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'ProductionVariants', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigArn', ], 'members' => [ 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], ], ], 'CreateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'CreateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'CreateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'CreateFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], ], ], 'CreateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubDescription', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'CreateHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'UiTemplate', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'CreateHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobConfig', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'CreateHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobArn', ], 'members' => [ 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'CreateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'RoleArn', ], 'members' => [ 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'CreateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'BaseImage', 'ClientToken', 'ImageName', ], 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ImageName' => [ 'shape' => 'ImageName', ], 'Aliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'CreateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'CreateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'EndpointName', 'VariantName', 'Specification', 'RuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'CreateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'RoleArn', 'EndpointName', 'ModelVariants', 'ShadowModeConfig', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'CreateInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'RoleArn', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'OutputConfig' => [ 'shape' => 'RecommendationJobOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobArn', ], 'members' => [ 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], ], ], 'CreateLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelAttributeName', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobArn', ], 'members' => [ 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], ], ], 'CreateModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardExportJobName', 'OutputConfig', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], ], ], 'CreateModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'CreateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'Content', 'ModelCardStatus', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelArn', ], 'members' => [ 'ModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'CreateModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'CreateModelPackageInput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], ], ], 'CreateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'CreateModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'CreateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'InstanceType', 'RoleArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], ], ], 'CreateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], ], ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', 'RoleArn', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'CreatePresignedDomainUrlRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], 'ExpiresInSeconds' => [ 'shape' => 'ExpiresInSeconds', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'LandingUri' => [ 'shape' => 'LandingUri', ], ], ], 'CreatePresignedDomainUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'PresignedDomainUrl', ], ], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'NotebookInstanceUrl', ], ], ], 'CreateProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'RoleArn', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobArn', ], 'members' => [ 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'CreateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ServiceCatalogProvisioningDetails', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectId', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], ], ], 'CreateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'CreateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'CreateStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', 'StudioLifecycleConfigContent', 'StudioLifecycleConfigAppType', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'CreateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'CreateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'CreateTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'ModelName', 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobArn', ], 'members' => [ 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], ], ], 'CreateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'CreateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', 'ExperimentName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'CreateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'CreateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'CreateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'CreateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'WorkforceArn', ], 'members' => [ 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], ], ], 'CreateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateWorkteamResponse' => [ 'type' => 'structure', 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', ], 'CrossAccountFilterOption' => [ 'type' => 'string', 'enum' => [ 'SameAccount', 'CrossAccount', ], ], 'CsvContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'CsvContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CsvContentType', ], 'max' => 10, 'min' => 1, ], 'CustomFileSystem' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystem' => [ 'shape' => 'EFSFileSystem', ], ], 'union' => true, ], 'CustomFileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystemConfig' => [ 'shape' => 'EFSFileSystemConfig', ], ], 'union' => true, ], 'CustomFileSystemConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystemConfig', ], 'max' => 2, ], 'CustomFileSystems' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystem', ], 'max' => 1, ], 'CustomImage' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'AppImageConfigName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageVersionNumber' => [ 'shape' => 'ImageVersionNumber', 'box' => true, ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'CustomImageContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString64', ], 'max' => 50, ], 'CustomImageContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString256', ], 'max' => 1, ], 'CustomImageContainerEnvironmentVariables' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonEmptyString256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 25, ], 'CustomImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomImage', ], 'max' => 200, ], 'CustomPosixUserConfig' => [ 'type' => 'structure', 'required' => [ 'Uid', 'Gid', ], 'members' => [ 'Uid' => [ 'shape' => 'Uid', ], 'Gid' => [ 'shape' => 'Gid', ], ], ], 'CustomerMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}', ], 'CustomerMetadataKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerMetadataKey', ], ], 'CustomerMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerMetadataKey', ], 'value' => [ 'shape' => 'CustomerMetadataValue', ], 'max' => 50, 'min' => 1, ], 'CustomerMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}', ], 'CustomizedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Statistic' => [ 'shape' => 'Statistic', ], ], ], 'DataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'InitialSamplingPercentage', 'DestinationS3Uri', 'CaptureOptions', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'InitialSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CaptureOptions' => [ 'shape' => 'CaptureOptionList', ], 'CaptureContentTypeHeader' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'DataCaptureConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EnableCapture', 'CaptureStatus', 'CurrentSamplingPercentage', 'DestinationS3Uri', 'KmsKeyId', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'CaptureStatus' => [ 'shape' => 'CaptureStatus', ], 'CurrentSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'DataCatalogConfig' => [ 'type' => 'structure', 'required' => [ 'TableName', 'Catalog', 'Database', ], 'members' => [ 'TableName' => [ 'shape' => 'TableName', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'DataExplorationNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'DataInputConfig' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DataProcessing' => [ 'type' => 'structure', 'members' => [ 'InputFilter' => [ 'shape' => 'JsonPath', ], 'OutputFilter' => [ 'shape' => 'JsonPath', ], 'JoinSource' => [ 'shape' => 'JoinSource', ], ], ], 'DataQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'DataQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'DataQualityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3DataSource', ], 'FileSystemDataSource' => [ 'shape' => 'FileSystemDataSource', ], ], ], 'DataSourceName' => [ 'type' => 'string', 'enum' => [ 'SalesforceGenie', 'Snowflake', ], ], 'Database' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'DatasetDefinition' => [ 'type' => 'structure', 'members' => [ 'AthenaDatasetDefinition' => [ 'shape' => 'AthenaDatasetDefinition', ], 'RedshiftDatasetDefinition' => [ 'shape' => 'RedshiftDatasetDefinition', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'DataDistributionType' => [ 'shape' => 'DataDistributionType', ], 'InputMode' => [ 'shape' => 'InputMode', ], ], ], 'DebugHookConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'HookParameters' => [ 'shape' => 'HookParameters', ], 'CollectionConfigurations' => [ 'shape' => 'CollectionConfigurations', ], ], ], 'DebugRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'DebugRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'DebugRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DebugRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'DefaultEbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'DefaultEbsVolumeSizeInGb', 'MaximumEbsVolumeSizeInGb', ], 'members' => [ 'DefaultEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], 'MaximumEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'DefaultGid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DefaultSpaceSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'JupyterLabAppSettings', ], 'SpaceStorageSettings' => [ 'shape' => 'DefaultSpaceStorageSettings', ], 'CustomPosixUserConfig' => [ 'shape' => 'CustomPosixUserConfig', ], 'CustomFileSystemConfigs' => [ 'shape' => 'CustomFileSystemConfigs', ], ], ], 'DefaultSpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultEbsStorageSettings' => [ 'shape' => 'DefaultEbsStorageSettings', ], ], ], 'DefaultUid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DeleteActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'DeleteAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DeleteArtifactRequest' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], ], ], 'DeleteArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DeleteAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'DeleteCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], ], ], 'DeleteContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'RetentionPolicy' => [ 'shape' => 'RetentionPolicy', ], ], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DeleteEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DeleteExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'DeleteFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'DeleteFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DeleteFlowDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', 'HubContentVersion', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DeleteHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DeleteHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DeleteHumanTaskUiResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DeleteImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DeleteImageResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DeleteImageVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DeleteInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DeleteInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DeleteModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DeleteModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DeleteNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'DeleteProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DeleteSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DeleteTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'DeleteTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'DeleteTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DeleteUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DeleteWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DeleteWorkforceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DeleteWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Success', ], 'members' => [ 'Success' => [ 'shape' => 'Success', ], ], ], 'DependencyCopyPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DependencyOriginPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DeployedImage' => [ 'type' => 'structure', 'members' => [ 'SpecifiedImage' => [ 'shape' => 'ContainerImage', ], 'ResolvedImage' => [ 'shape' => 'ContainerImage', ], 'ResolutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeployedImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeployedImage', ], ], 'DeploymentConfig' => [ 'type' => 'structure', 'members' => [ 'BlueGreenUpdatePolicy' => [ 'shape' => 'BlueGreenUpdatePolicy', ], 'RollingUpdatePolicy' => [ 'shape' => 'RollingUpdatePolicy', ], 'AutoRollbackConfiguration' => [ 'shape' => 'AutoRollbackConfig', ], ], ], 'DeploymentRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationStatus', ], 'members' => [ 'RecommendationStatus' => [ 'shape' => 'RecommendationStatus', ], 'RealTimeInferenceRecommendations' => [ 'shape' => 'RealTimeInferenceRecommendations', ], ], ], 'DeploymentStage' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], ], ], 'DeploymentStageMaxResults' => [ 'type' => 'integer', 'max' => 10, ], 'DeploymentStageStatusSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStageStatusSummary', ], ], 'DeploymentStageStatusSummary' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', 'DeploymentConfig', 'DeploymentStatus', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], 'DeploymentStatus' => [ 'shape' => 'EdgeDeploymentStatus', ], ], ], 'DeploymentStages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStage', ], ], 'DeregisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceNames', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], ], ], 'DerivedInformation' => [ 'type' => 'structure', 'members' => [ 'DerivedDataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'DescribeActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ActionArn' => [ 'shape' => 'ActionArn', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'TrainingSpecification', 'AlgorithmStatus', 'AlgorithmStatusDetails', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], 'AlgorithmStatusDetails' => [ 'shape' => 'AlgorithmStatusDetails', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], ], ], 'DescribeAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DescribeAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'LastHealthCheckTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUserActivityTimestamp' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'DescribeArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DescribeArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'ResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], ], ], 'DescribeAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'AutoMLProblemTypeConfigName' => [ 'shape' => 'AutoMLProblemTypeConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'AutoMLResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], ], ], 'DescribeClusterNodeRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'NodeId', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'NodeId' => [ 'shape' => 'ClusterNodeId', ], ], ], 'DescribeClusterNodeResponse' => [ 'type' => 'structure', 'required' => [ 'NodeDetails', ], 'members' => [ 'NodeDetails' => [ 'shape' => 'ClusterNodeDetails', ], ], ], 'DescribeClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DescribeClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterStatus', 'InstanceGroups', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureMessage' => [ 'shape' => 'String', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupDetailsList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'DescribeCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'DescribeCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CompilationJobStatus', 'StoppingCondition', 'CreationTime', 'LastModifiedTime', 'FailureReason', 'ModelArtifacts', 'RoleArn', 'InputConfig', 'OutputConfig', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'InferenceImage' => [ 'shape' => 'InferenceImage', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'ModelDigests' => [ 'shape' => 'ModelDigests', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'DerivedInformation' => [ 'shape' => 'DerivedInformation', ], ], ], 'DescribeContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextNameOrArn', ], ], ], 'DescribeContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'ContextArn' => [ 'shape' => 'ContextArn', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceFleetResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceFleetArn', 'OutputConfig', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'IotRoleAlias' => [ 'shape' => 'IotRoleAlias', ], ], ], 'DescribeDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', 'RegistrationTime', ], 'members' => [ 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModels', ], 'MaxModels' => [ 'shape' => 'Integer', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'HomeEfsFileSystemId' => [ 'shape' => 'ResourceId', ], 'SingleSignOnManagedApplicationInstanceId' => [ 'shape' => 'String256', ], 'SingleSignOnApplicationArn' => [ 'shape' => 'SingleSignOnApplicationArn', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SecurityGroupIdForDomainBoundary' => [ 'shape' => 'SecurityGroupId', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'Url' => [ 'shape' => 'String1024', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'DeploymentStageMaxResults', ], ], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'Stages' => [ 'shape' => 'DeploymentStageStatusSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeEdgePackagingJobResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'EdgePackagingJobStatusMessage' => [ 'shape' => 'String', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ModelArtifact' => [ 'shape' => 'S3Uri', ], 'ModelSignature' => [ 'shape' => 'String', ], 'PresetDeploymentOutput' => [ 'shape' => 'EdgePresetDeploymentOutput', ], ], ], 'DescribeEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DescribeEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'ProductionVariants', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'DescribeEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DescribeEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastDeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'PendingDeploymentSummary' => [ 'shape' => 'PendingDeploymentSummary', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'DescribeExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', 'CreationTime', 'NextToken', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfigDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'OnlineStoreTotalSizeBytes' => [ 'shape' => 'OnlineStoreTotalSizeBytes', ], ], ], 'DescribeFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], ], ], 'DescribeFeatureMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'FeatureName', 'FeatureType', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'DescribeFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DescribeFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', 'FlowDefinitionName', 'FlowDefinitionStatus', 'CreationTime', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DescribeHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DescribeHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubArn', 'HubContentDocument', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentDependencies' => [ 'shape' => 'HubContentDependencyList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DescribeHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DescribeHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', 'HumanTaskUiName', 'CreationTime', 'UiTemplate', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiStatus' => [ 'shape' => 'HumanTaskUiStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'UiTemplate' => [ 'shape' => 'UiTemplateInfo', ], ], ], 'DescribeHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DescribeHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobConfig', 'HyperParameterTuningJobStatus', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Autotune' => [ 'shape' => 'Autotune', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], ], ], 'DescribeImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DescribeImageResponse' => [ 'type' => 'structure', 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'DescribeImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DescribeImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ContainerImage' => [ 'shape' => 'ImageContainerImage', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'DescribeInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DescribeInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'InferenceComponentArn', 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecificationSummary', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfigSummary', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], ], ], 'DescribeInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DescribeInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Name', 'Type', 'Status', 'EndpointMetadata', 'ModelVariants', ], 'members' => [ 'Arn' => [ 'shape' => 'InferenceExperimentArn', ], 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointMetadata' => [ 'shape' => 'EndpointMetadata', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigSummaryList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], ], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'JobArn', 'RoleArn', 'Status', 'CreationTime', 'LastModifiedTime', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'InferenceRecommendations' => [ 'shape' => 'InferenceRecommendations', ], 'EndpointPerformances' => [ 'shape' => 'EndpointPerformances', ], ], ], 'DescribeLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'DescribeLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobStatus', 'LabelCounters', 'CreationTime', 'LastModifiedTime', 'JobReferenceCode', 'LabelingJobName', 'LabelingJobArn', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], ], ], 'DescribeLineageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeLineageGroupResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'DescribeModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'OutputConfig', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExportArtifacts' => [ 'shape' => 'ModelCardExportArtifacts', ], ], ], 'DescribeModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], ], ], 'DescribeModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', 'ModelCardName', 'ModelCardVersion', 'Content', 'ModelCardStatus', 'CreationTime', 'CreatedBy', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ModelCardProcessingStatus' => [ 'shape' => 'ModelCardProcessingStatus', ], ], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DescribeModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'CreationTime', 'ModelArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'DescribeModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'CreatedBy', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'DescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DescribeModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', 'ModelPackageStatusDetails', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], ], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DescribeMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', 'MonitoringScheduleName', 'MonitoringScheduleStatus', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'DescribeNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], ], ], 'DescribeNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'DescribePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], ], ], 'DescribePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'DescribeProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'DescribeProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'ProcessingJobArn', 'ProcessingJobStatus', 'CreationTime', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'DescribeProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DescribeProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectName', 'ProjectId', 'ServiceCatalogProvisioningDetails', 'ProjectStatus', 'CreationTime', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceArn' => [ 'shape' => 'SpaceArn', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DescribeStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DescribeStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'DescribeSubscribedWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'DescribeSubscribedWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteam', ], 'members' => [ 'SubscribedWorkteam' => [ 'shape' => 'SubscribedWorkteam', ], ], ], 'DescribeTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'DescribeTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'ModelArtifacts', 'TrainingJobStatus', 'SecondaryStatus', 'AlgorithmSpecification', 'ResourceConfig', 'StoppingCondition', 'CreationTime', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ProfilerRuleEvaluationStatuses' => [ 'shape' => 'ProfilerRuleEvaluationStatuses', ], 'ProfilingStatus' => [ 'shape' => 'ProfilingStatus', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'DescribeTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'DescribeTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'TransformJobStatus', 'ModelName', 'TransformInput', 'TransformResources', 'CreationTime', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'DescribeTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Sources' => [ 'shape' => 'TrialComponentSources', ], ], ], 'DescribeTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], ], ], 'DescribeUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DescribeUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'DescribeWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DescribeWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'DescribeWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DescribeWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 128, ], 'DesiredWeightAndCapacity' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'ServerlessUpdateConfig' => [ 'shape' => 'ProductionVariantServerlessUpdateConfig', ], ], ], 'DesiredWeightAndCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredWeightAndCapacity', ], 'min' => 1, ], 'DestinationS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/])/?(.*)$', ], 'DetailedAlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'DetailedModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'DeviceName', ], 'members' => [ 'DeviceName' => [ 'shape' => 'DeviceName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'IotThingName' => [ 'shape' => 'ThingName', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'READYTODEPLOY', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'DeviceDeploymentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceDeploymentSummary', ], ], 'DeviceDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'StageName', 'DeviceName', 'DeviceArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], 'DeployedStageName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceName' => [ 'shape' => 'DeviceName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceDeploymentStatus' => [ 'shape' => 'DeviceDeploymentStatus', ], 'DeviceDeploymentStatusMessage' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeploymentStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceDescription' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetArn' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceFleetDescription' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFleetSummary', ], ], 'DeviceFleetSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'DeviceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceName', ], ], 'DeviceSelectionConfig' => [ 'type' => 'structure', 'required' => [ 'DeviceSubsetType', ], 'members' => [ 'DeviceSubsetType' => [ 'shape' => 'DeviceSubsetType', ], 'Percentage' => [ 'shape' => 'Percentage', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], 'DeviceNameContains' => [ 'shape' => 'DeviceName', ], ], ], 'DeviceStats' => [ 'type' => 'structure', 'required' => [ 'ConnectedDeviceCount', 'RegisteredDeviceCount', ], 'members' => [ 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'RegisteredDeviceCount' => [ 'shape' => 'Long', ], ], ], 'DeviceSubsetType' => [ 'type' => 'string', 'enum' => [ 'PERCENTAGE', 'SELECTION', 'NAMECONTAINS', ], ], 'DeviceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceSummary', ], ], 'DeviceSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceArn', ], 'members' => [ 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModelSummaries', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'Dimension' => [ 'type' => 'integer', 'max' => 8192, 'min' => 1, ], 'DirectDeploySettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'DirectInternetAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Direction' => [ 'type' => 'string', 'enum' => [ 'Both', 'Ascendants', 'Descendants', ], ], 'DirectoryPath' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'DisableProfiler' => [ 'type' => 'boolean', ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'type' => 'boolean', ], 'DisassociateDefaultCodeRepository' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'type' => 'boolean', ], 'DisassociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DisassociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DockerSettings' => [ 'type' => 'structure', 'members' => [ 'EnableDockerAccess' => [ 'shape' => 'FeatureStatus', ], 'VpcOnlyTrustedAccounts' => [ 'shape' => 'VpcOnlyTrustedAccounts', ], ], ], 'DocumentSchemaVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'Dollars' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'DomainArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*', ], 'DomainDetails' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^d-(-*[a-z0-9]){1,61}', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'DomainSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 3, ], 'DomainSettings' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'RStudioServerProDomainSettings' => [ 'shape' => 'RStudioServerProDomainSettings', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainSettingsForUpdate' => [ 'type' => 'structure', 'members' => [ 'RStudioServerProDomainSettingsForUpdate' => [ 'shape' => 'RStudioServerProDomainSettingsForUpdate', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleParameterValue' => [ 'type' => 'double', ], 'DriftCheckBaselines' => [ 'type' => 'structure', 'members' => [ 'Bias' => [ 'shape' => 'DriftCheckBias', ], 'Explainability' => [ 'shape' => 'DriftCheckExplainability', ], 'ModelQuality' => [ 'shape' => 'DriftCheckModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'DriftCheckModelDataQuality', ], ], ], 'DriftCheckBias' => [ 'type' => 'structure', 'members' => [ 'ConfigFile' => [ 'shape' => 'FileSource', ], 'PreTrainingConstraints' => [ 'shape' => 'MetricsSource', ], 'PostTrainingConstraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckExplainability' => [ 'type' => 'structure', 'members' => [ 'Constraints' => [ 'shape' => 'MetricsSource', ], 'ConfigFile' => [ 'shape' => 'FileSource', ], ], ], 'DriftCheckModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DynamicScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], 'ScaleInCooldown' => [ 'shape' => 'Integer', ], 'ScaleOutCooldown' => [ 'shape' => 'Integer', ], 'ScalingPolicies' => [ 'shape' => 'ScalingPolicies', ], ], ], 'EFSFileSystem' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], ], ], 'EFSFileSystemConfig' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemPath' => [ 'shape' => 'FileSystemPath', ], ], ], 'EMRStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'String256', ], 'StepId' => [ 'shape' => 'String256', ], 'StepName' => [ 'shape' => 'String256', ], 'LogFilePath' => [ 'shape' => 'String1024', ], ], ], 'EbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'EbsVolumeSizeInGb', ], 'members' => [ 'EbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'Edge' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'EdgeDeploymentConfig' => [ 'type' => 'structure', 'required' => [ 'FailureHandlingPolicy', ], 'members' => [ 'FailureHandlingPolicy' => [ 'shape' => 'FailureHandlingPolicy', ], ], ], 'EdgeDeploymentModelConfig' => [ 'type' => 'structure', 'required' => [ 'ModelHandle', 'EdgePackagingJobName', ], 'members' => [ 'ModelHandle' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'EdgeDeploymentModelConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentModelConfig', ], ], 'EdgeDeploymentPlanArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgeDeploymentPlanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentPlanSummary', ], ], 'EdgeDeploymentPlanSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'DeviceFleetName', 'EdgeDeploymentSuccess', 'EdgeDeploymentPending', 'EdgeDeploymentFailed', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeDeploymentStatus' => [ 'type' => 'structure', 'required' => [ 'StageStatus', 'EdgeDeploymentSuccessInStage', 'EdgeDeploymentPendingInStage', 'EdgeDeploymentFailedInStage', ], 'members' => [ 'StageStatus' => [ 'shape' => 'StageStatus', ], 'EdgeDeploymentSuccessInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPendingInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailedInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentStatusMessage' => [ 'shape' => 'String', ], 'EdgeDeploymentStageStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModel' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'LatestSampleTime' => [ 'shape' => 'Timestamp', ], 'LatestInference' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModelStat' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', 'OfflineDeviceCount', 'ConnectedDeviceCount', 'ActiveDeviceCount', 'SamplingDeviceCount', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'OfflineDeviceCount' => [ 'shape' => 'Long', ], 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'ActiveDeviceCount' => [ 'shape' => 'Long', ], 'SamplingDeviceCount' => [ 'shape' => 'Long', ], ], ], 'EdgeModelStats' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelStat', ], ], 'EdgeModelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelSummary', ], ], 'EdgeModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'EdgeModels' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModel', ], ], 'EdgeOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'PresetDeploymentType' => [ 'shape' => 'EdgePresetDeploymentType', ], 'PresetDeploymentConfig' => [ 'shape' => 'String', ], ], ], 'EdgePackagingJobArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgePackagingJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'INPROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'EdgePackagingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgePackagingJobSummary', ], ], 'EdgePackagingJobSummary' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgePresetDeploymentArtifact' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'EdgePresetDeploymentOutput' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'EdgePresetDeploymentType', ], 'Artifact' => [ 'shape' => 'EdgePresetDeploymentArtifact', ], 'Status' => [ 'shape' => 'EdgePresetDeploymentStatus', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'EdgePresetDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', ], ], 'EdgePresetDeploymentType' => [ 'type' => 'string', 'enum' => [ 'GreengrassV2Component', ], ], 'EdgeVersion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\ \\_\\.]+', ], 'Edges' => [ 'type' => 'list', 'member' => [ 'shape' => 'Edge', ], ], 'EfsUid' => [ 'type' => 'string', 'max' => 10, 'pattern' => '\\d+', ], 'EnableCapture' => [ 'type' => 'boolean', ], 'EnableInfraCheck' => [ 'type' => 'boolean', ], 'EnableIotRoleAlias' => [ 'type' => 'boolean', ], 'EnableRemoteDebug' => [ 'type' => 'boolean', ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringSchedules' => [ 'shape' => 'MonitoringScheduleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'EndpointArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*', ], 'EndpointConfigArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*', ], 'EndpointConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'EndpointConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'EndpointConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointConfigSummary', ], ], 'EndpointInfo' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'EndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'LocalPath', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'EndpointInputConfiguration' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameterRanges' => [ 'shape' => 'EnvironmentParameterRanges', ], ], ], 'EndpointInputConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInputConfiguration', ], 'max' => 10, 'min' => 1, ], 'EndpointMetadata' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'EndpointName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointOutputConfiguration' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'VariantName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'String', ], 'VariantName' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialInstanceCount' => [ 'shape' => 'InitialInstanceCount', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointPerformance' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointInfo', ], 'members' => [ 'Metrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointInfo' => [ 'shape' => 'EndpointInfo', ], ], ], 'EndpointPerformances' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointPerformance', ], 'max' => 1, ], 'EndpointSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'EndpointStatus' => [ 'type' => 'string', 'enum' => [ 'OutOfService', 'Creating', 'Updating', 'SystemUpdating', 'RollingBack', 'InService', 'Deleting', 'Failed', 'UpdateRollbackFailed', ], ], 'EndpointSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'EndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointSummary', ], ], 'Endpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInfo', ], 'max' => 1, ], 'EntityDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'EntityName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'EnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'EnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'EnvironmentKey', ], 'value' => [ 'shape' => 'EnvironmentValue', ], 'max' => 100, ], 'EnvironmentParameter' => [ 'type' => 'structure', 'required' => [ 'Key', 'ValueType', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'EnvironmentParameterRanges' => [ 'type' => 'structure', 'members' => [ 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameters', ], ], ], 'EnvironmentParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentParameter', ], 'max' => 10, 'min' => 1, ], 'EnvironmentValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'ExcludeFeaturesAttribute' => [ 'type' => 'string', 'max' => 100, ], 'ExecutionRoleIdentityConfig' => [ 'type' => 'string', 'enum' => [ 'USER_PROFILE_NAME', 'DISABLED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Completed', 'CompletedWithViolations', 'InProgress', 'Failed', 'Stopping', 'Stopped', ], ], 'ExitMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'Experiment' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*', ], 'ExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentDisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ExperimentDescription' => [ 'type' => 'string', 'max' => 3072, 'pattern' => '.*', ], 'ExperimentEntityName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'ExperimentEntityNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'ExperimentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'ExperimentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'ExperimentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'ExperimentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExperimentSummary', ], ], 'ExperimentSummary' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentSource' => [ 'shape' => 'ExperimentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ExpiresInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Explainability' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], ], ], 'ExplainabilityLocation' => [ 'type' => 'string', 'min' => 1, ], 'ExplainerConfig' => [ 'type' => 'structure', 'members' => [ 'ClarifyExplainerConfig' => [ 'shape' => 'ClarifyExplainerConfig', ], ], ], 'FailStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String3072', ], ], ], 'FailureHandlingPolicy' => [ 'type' => 'string', 'enum' => [ 'ROLLBACK_ON_FAILURE', 'DO_NOTHING', ], ], 'FailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'FeatureAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 100, 'min' => 1, ], 'FeatureDefinition' => [ 'type' => 'structure', 'required' => [ 'FeatureName', 'FeatureType', ], 'members' => [ 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CollectionType' => [ 'shape' => 'CollectionType', ], 'CollectionConfig' => [ 'shape' => 'CollectionConfig', ], ], ], 'FeatureDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 2500, 'min' => 1, ], 'FeatureDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '.*', ], 'FeatureGroup' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'FeatureGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*', ], 'FeatureGroupMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'FeatureGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}', ], 'FeatureGroupNameContains' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FeatureGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})', ], 'FeatureGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'FeatureGroupStatus', 'OfflineStoreStatus', 'CreationTime', ], ], 'FeatureGroupSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'FeatureGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'CreateFailed', 'Deleting', 'DeleteFailed', ], ], 'FeatureGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureGroupSummary', ], ], 'FeatureGroupSummary' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureGroupArn', 'CreationTime', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], ], ], 'FeatureMetadata' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'FeatureName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}', ], 'FeatureParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'FeatureParameterKey', ], 'Value' => [ 'shape' => 'FeatureParameterValue', ], ], ], 'FeatureParameterAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, ], 'FeatureParameterKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameterRemovals' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameterKey', ], 'max' => 25, ], 'FeatureParameterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, 'min' => 0, ], 'FeatureStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'FeatureType' => [ 'type' => 'string', 'enum' => [ 'Integral', 'Fractional', 'String', ], ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'FileSystemAccessMode' => [ 'type' => 'string', 'enum' => [ 'rw', 'ro', ], ], 'FileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'MountPath' => [ 'shape' => 'MountPath', ], 'DefaultUid' => [ 'shape' => 'DefaultUid', 'box' => true, ], 'DefaultGid' => [ 'shape' => 'DefaultGid', 'box' => true, ], ], ], 'FileSystemDataSource' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', 'FileSystemAccessMode', 'FileSystemType', 'DirectoryPath', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemAccessMode' => [ 'shape' => 'FileSystemAccessMode', ], 'FileSystemType' => [ 'shape' => 'FileSystemType', ], 'DirectoryPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'FileSystemId' => [ 'type' => 'string', 'max' => 21, 'min' => 11, 'pattern' => '^(fs-[0-9a-f]{8,})$', ], 'FileSystemPath' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^\\/\\S*$', ], 'FileSystemType' => [ 'type' => 'string', 'enum' => [ 'EFS', 'FSxLustre', ], ], 'FillingTransformationMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FillingType', ], 'value' => [ 'shape' => 'FillingTransformationValue', ], 'max' => 6, 'min' => 1, ], 'FillingTransformationValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-]+$', ], 'FillingTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'FillingTransformationMap', ], 'max' => 50, 'min' => 1, ], 'FillingType' => [ 'type' => 'string', 'enum' => [ 'frontfill', 'middlefill', 'backfill', 'futurefill', 'frontfill_value', 'middlefill_value', 'backfill_value', 'futurefill_value', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ResourcePropertyName', ], 'Operator' => [ 'shape' => 'Operator', ], 'Value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'FinalAutoMLJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'AutoMLJobObjectiveType', ], 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'MetricValue', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'MetricValue', ], ], ], 'FinalMetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricData', ], 'max' => 40, 'min' => 0, ], 'FlatInvocations' => [ 'type' => 'string', 'enum' => [ 'Continue', 'Stop', ], ], 'Float' => [ 'type' => 'float', ], 'FlowDefinitionArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:flow-definition/.*', ], 'FlowDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9]){0,62}', ], 'FlowDefinitionOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'FlowDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Active', 'Failed', 'Deleting', ], ], 'FlowDefinitionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionSummary', ], ], 'FlowDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'FlowDefinitionArn', 'FlowDefinitionStatus', 'CreationTime', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'FlowDefinitionTaskCount' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'FlowDefinitionTaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'FlowDefinitionTaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'FlowDefinitionTaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionTaskKeyword', ], 'max' => 5, 'min' => 1, ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'FlowDefinitionTaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'ForecastFrequency' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$', ], 'ForecastHorizon' => [ 'type' => 'integer', 'min' => 1, ], 'ForecastQuantile' => [ 'type' => 'string', 'max' => 4, 'min' => 2, 'pattern' => '(^p[1-9]\\d?$)', ], 'ForecastQuantiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastQuantile', ], 'max' => 5, 'min' => 1, ], 'Framework' => [ 'type' => 'string', 'enum' => [ 'TENSORFLOW', 'KERAS', 'MXNET', 'ONNX', 'PYTORCH', 'XGBOOST', 'TFLITE', 'DARKNET', 'SKLEARN', ], ], 'FrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.]+', ], 'GenerateCandidateDefinitionsOnly' => [ 'type' => 'boolean', ], 'GenerativeAiSettings' => [ 'type' => 'structure', 'members' => [ 'AmazonBedrockRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'GetDeviceFleetReportRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'GetDeviceFleetReportResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'ReportGenerated' => [ 'shape' => 'Timestamp', ], 'DeviceStats' => [ 'shape' => 'DeviceStats', ], 'AgentVersions' => [ 'shape' => 'AgentVersions', ], 'ModelStats' => [ 'shape' => 'EdgeModelStats', ], ], ], 'GetLineageGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'LineageGroupNameOrArn', ], ], ], 'GetLineageGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'ResourcePolicy' => [ 'shape' => 'ResourcePolicyString', ], ], ], 'GetModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'GetModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ResourcePolicy', ], 'members' => [ 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SagemakerServicecatalogStatus', ], ], ], 'GetScalingConfigurationRecommendationRequest' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobName', ], 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], ], ], 'GetScalingConfigurationRecommendationResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], 'Metric' => [ 'shape' => 'ScalingPolicyMetric', ], 'DynamicScalingConfiguration' => [ 'shape' => 'DynamicScalingConfiguration', ], ], ], 'GetSearchSuggestionsRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SuggestionQuery' => [ 'shape' => 'SuggestionQuery', ], ], ], 'GetSearchSuggestionsResponse' => [ 'type' => 'structure', 'members' => [ 'PropertyNameSuggestions' => [ 'shape' => 'PropertyNameSuggestionList', ], ], ], 'Gid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 1001, ], 'GitConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'GitConfigUrl', ], 'Branch' => [ 'shape' => 'Branch', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 11, 'pattern' => '^https://([^/]+)/?.{3,1016}$', ], 'Group' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupingAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'GroupingAttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingAttributeName', ], 'max' => 5, 'min' => 1, ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], 'max' => 10, 'min' => 1, ], 'HolidayConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'HolidayConfigAttributes', ], 'max' => 1, 'min' => 1, ], 'HolidayConfigAttributes' => [ 'type' => 'structure', 'members' => [ 'CountryCode' => [ 'shape' => 'CountryCode', ], ], ], 'HookParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'Horovod' => [ 'type' => 'boolean', ], 'HubArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDependency' => [ 'type' => 'structure', 'members' => [ 'DependencyOriginPath' => [ 'shape' => 'DependencyOriginPath', ], 'DependencyCopyPath' => [ 'shape' => 'DependencyCopyPath', ], ], ], 'HubContentDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentDependency', ], 'max' => 50, ], 'HubContentDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubContentDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDocument' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentInfo' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubContentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentInfo', ], ], 'HubContentMarkdown' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubContentSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubContentSortBy' => [ 'type' => 'string', 'enum' => [ 'HubContentName', 'CreationTime', 'HubContentStatus', ], ], 'HubContentStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Importing', 'Deleting', 'ImportFailed', 'DeleteFailed', ], ], 'HubContentType' => [ 'type' => 'string', 'enum' => [ 'Model', 'Notebook', ], ], 'HubContentVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'HubDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubInfo' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubInfo', ], ], 'HubName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubS3StorageConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3OutputPath', ], ], ], 'HubSearchKeyword' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[^A-Z]*$', ], 'HubSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubSortBy' => [ 'type' => 'string', 'enum' => [ 'HubName', 'CreationTime', 'HubStatus', 'AccountIdOwner', ], ], 'HubStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Deleting', 'CreateFailed', 'UpdateFailed', 'DeleteFailed', ], ], 'HumanLoopActivationConditions' => [ 'type' => 'string', 'max' => 10240, ], 'HumanLoopActivationConditionsConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditions', ], 'members' => [ 'HumanLoopActivationConditions' => [ 'shape' => 'HumanLoopActivationConditions', 'jsonvalue' => true, ], ], ], 'HumanLoopActivationConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditionsConfig', ], 'members' => [ 'HumanLoopActivationConditionsConfig' => [ 'shape' => 'HumanLoopActivationConditionsConfig', ], ], ], 'HumanLoopConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'HumanTaskUiArn', 'TaskTitle', 'TaskDescription', 'TaskCount', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'TaskTitle' => [ 'shape' => 'FlowDefinitionTaskTitle', ], 'TaskDescription' => [ 'shape' => 'FlowDefinitionTaskDescription', ], 'TaskCount' => [ 'shape' => 'FlowDefinitionTaskCount', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'FlowDefinitionTaskAvailabilityLifetimeInSeconds', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'FlowDefinitionTaskTimeLimitInSeconds', ], 'TaskKeywords' => [ 'shape' => 'FlowDefinitionTaskKeywords', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanLoopRequestSource' => [ 'type' => 'structure', 'required' => [ 'AwsManagedHumanLoopRequestSource', ], 'members' => [ 'AwsManagedHumanLoopRequestSource' => [ 'shape' => 'AwsManagedHumanLoopRequestSource', ], ], ], 'HumanTaskConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'UiConfig', 'PreHumanTaskLambdaArn', 'TaskTitle', 'TaskDescription', 'NumberOfHumanWorkersPerDataObject', 'TaskTimeLimitInSeconds', 'AnnotationConsolidationConfig', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'UiConfig' => [ 'shape' => 'UiConfig', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'TaskKeywords' => [ 'shape' => 'TaskKeywords', ], 'TaskTitle' => [ 'shape' => 'TaskTitle', ], 'TaskDescription' => [ 'shape' => 'TaskDescription', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'TaskTimeLimitInSeconds', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'TaskAvailabilityLifetimeInSeconds', ], 'MaxConcurrentTaskCount' => [ 'shape' => 'MaxConcurrentTaskCount', ], 'AnnotationConsolidationConfig' => [ 'shape' => 'AnnotationConsolidationConfig', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanTaskUiArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/.*', ], 'HumanTaskUiName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9])*', ], 'HumanTaskUiStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'HumanTaskUiSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HumanTaskUiSummary', ], ], 'HumanTaskUiSummary' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'HumanTaskUiArn', 'CreationTime', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], ], ], 'HyperParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'HyperParameterScalingType' => [ 'type' => 'string', 'enum' => [ 'Auto', 'Linear', 'Logarithmic', 'ReverseLogarithmic', ], ], 'HyperParameterSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Type' => [ 'shape' => 'ParameterType', ], 'Range' => [ 'shape' => 'ParameterRange', ], 'IsTunable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'DefaultValue' => [ 'shape' => 'HyperParameterValue', ], ], ], 'HyperParameterSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterSpecification', ], 'max' => 100, 'min' => 0, ], 'HyperParameterTrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'StoppingCondition', ], 'members' => [ 'DefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TuningObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'HyperParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'StaticHyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'HyperParameterAlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'HyperParameterTuningResourceConfig' => [ 'shape' => 'HyperParameterTuningResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Environment' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentMap', ], ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'HyperParameterTrainingJobDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'max' => 10, 'min' => 1, ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentKey', ], 'value' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentValue', ], 'max' => 48, ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'HyperParameterTrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], ], 'HyperParameterTrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', 'TunedHyperParameters', ], 'members' => [ 'TrainingJobDefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'TunedHyperParameters' => [ 'shape' => 'HyperParameters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'shape' => 'FinalHyperParameterTuningJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], ], ], 'HyperParameterTuningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'Prioritized', ], ], 'HyperParameterTuningInstanceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], ], ], 'HyperParameterTuningInstanceConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningInstanceConfig', ], 'max' => 6, 'min' => 1, ], 'HyperParameterTuningJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*', ], 'HyperParameterTuningJobCompletionDetails' => [ 'type' => 'structure', 'members' => [ 'NumberOfTrainingJobsObjectiveNotImproving' => [ 'shape' => 'Integer', ], 'ConvergenceDetectedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterTuningJobConfig' => [ 'type' => 'structure', 'required' => [ 'Strategy', 'ResourceLimits', ], 'members' => [ 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'StrategyConfig' => [ 'shape' => 'HyperParameterTuningJobStrategyConfig', ], 'HyperParameterTuningJobObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], 'ParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'TrainingJobEarlyStoppingType' => [ 'shape' => 'TrainingJobEarlyStoppingType', ], 'TuningJobCompletionCriteria' => [ 'shape' => 'TuningJobCompletionCriteria', ], 'RandomSeed' => [ 'shape' => 'RandomSeed', ], ], ], 'HyperParameterTuningJobConsumedResources' => [ 'type' => 'structure', 'members' => [ 'RuntimeInSeconds' => [ 'shape' => 'Integer', ], ], ], 'HyperParameterTuningJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'HyperParameterTuningJobObjective' => [ 'type' => 'structure', 'required' => [ 'Type', 'MetricName', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'HyperParameterTuningJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'HyperParameterTuningJobObjectives' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobObjective', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'HyperParameterTuningJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'Status', 'CreationTime', ], ], 'HyperParameterTuningJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', 'Deleting', 'DeleteFailed', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'HyperbandStrategyConfig' => [ 'shape' => 'HyperbandStrategyConfig', ], ], ], 'HyperParameterTuningJobStrategyType' => [ 'type' => 'string', 'enum' => [ 'Bayesian', 'Random', 'Hyperband', 'Grid', ], ], 'HyperParameterTuningJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobSummary', ], ], 'HyperParameterTuningJobSummary' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobStatus', 'Strategy', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'type' => 'structure', 'required' => [ 'ParentHyperParameterTuningJobs', 'WarmStartType', ], 'members' => [ 'ParentHyperParameterTuningJobs' => [ 'shape' => 'ParentHyperParameterTuningJobs', ], 'WarmStartType' => [ 'shape' => 'HyperParameterTuningJobWarmStartType', ], ], ], 'HyperParameterTuningJobWarmStartType' => [ 'type' => 'string', 'enum' => [ 'IdenticalDataAndAlgorithm', 'TransferLearning', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 15768000, 'min' => 120, ], 'HyperParameterTuningResourceConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AllocationStrategy' => [ 'shape' => 'HyperParameterTuningAllocationStrategy', ], 'InstanceConfigs' => [ 'shape' => 'HyperParameterTuningInstanceConfigs', ], ], ], 'HyperParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterKey', ], 'value' => [ 'shape' => 'HyperParameterValue', ], 'max' => 100, 'min' => 0, ], 'HyperbandStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'MinResource' => [ 'shape' => 'HyperbandStrategyMinResource', ], 'MaxResource' => [ 'shape' => 'HyperbandStrategyMaxResource', ], ], ], 'HyperbandStrategyMaxResource' => [ 'type' => 'integer', 'min' => 1, ], 'HyperbandStrategyMinResource' => [ 'type' => 'integer', 'min' => 1, ], 'IamIdentity' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], 'PrincipalId' => [ 'shape' => 'String', ], 'SourceIdentity' => [ 'shape' => 'String', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 32, ], 'IdentityProviderOAuthSetting' => [ 'type' => 'structure', 'members' => [ 'DataSourceName' => [ 'shape' => 'DataSourceName', ], 'Status' => [ 'shape' => 'FeatureStatus', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'IdentityProviderOAuthSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdentityProviderOAuthSetting', ], 'max' => 20, ], 'Image' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageName', 'ImageStatus', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ImageArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$', ], 'ImageBaseImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'ImageClassificationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ImageConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryAccessMode', ], 'members' => [ 'RepositoryAccessMode' => [ 'shape' => 'RepositoryAccessMode', ], 'RepositoryAuthConfig' => [ 'shape' => 'RepositoryAuthConfig', ], ], ], 'ImageContainerImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImageDeleteProperty' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '(^DisplayName$)|(^Description$)', ], 'ImageDeletePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageDeleteProperty', ], 'max' => 2, ], 'ImageDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'ImageDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ImageDisplayName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^\\S(.*\\S)?$', ], 'ImageName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$', ], 'ImageNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9\\-.]+$', ], 'ImageSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'IMAGE_NAME', ], ], 'ImageSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageUri' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'ImageVersion' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageVersionArn', 'ImageVersionStatus', 'LastModifiedTime', 'Version', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], ], ], 'ImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)', ], 'ImageVersionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$', ], 'ImageVersionNumber' => [ 'type' => 'integer', 'min' => 0, ], 'ImageVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'VERSION', ], ], 'ImageVersionSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageVersion', ], ], 'Images' => [ 'type' => 'list', 'member' => [ 'shape' => 'Image', ], ], 'ImportHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubContentDocument', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ImportHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', 'HubContentArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], ], ], 'InferenceComponentArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'InferenceComponentComputeResourceRequirements' => [ 'type' => 'structure', 'required' => [ 'MinMemoryRequiredInMb', ], 'members' => [ 'NumberOfCpuCoresRequired' => [ 'shape' => 'NumberOfCpuCores', ], 'NumberOfAcceleratorDevicesRequired' => [ 'shape' => 'NumberOfAcceleratorDevices', ], 'MinMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], 'MaxMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], ], ], 'InferenceComponentContainerSpecification' => [ 'type' => 'structure', 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'DeployedImage' => [ 'shape' => 'DeployedImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentCopyCount' => [ 'type' => 'integer', 'min' => 0, ], 'InferenceComponentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$', ], 'InferenceComponentNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'InferenceComponentRuntimeConfig' => [ 'type' => 'structure', 'required' => [ 'CopyCount', ], 'members' => [ 'CopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'type' => 'structure', 'members' => [ 'DesiredCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], 'CurrentCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'InferenceComponentSpecification' => [ 'type' => 'structure', 'required' => [ 'ComputeResourceRequirements', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecification', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecificationSummary', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentStartupParameters' => [ 'type' => 'structure', 'members' => [ 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], ], ], 'InferenceComponentStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Failed', 'Deleting', ], ], 'InferenceComponentSummary' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'InferenceComponentArn', 'InferenceComponentName', 'EndpointArn', 'EndpointName', 'VariantName', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceComponentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceComponentSummary', ], ], 'InferenceExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'InferenceExecutionMode', ], ], ], 'InferenceExecutionMode' => [ 'type' => 'string', 'enum' => [ 'Serial', 'Direct', ], ], 'InferenceExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*', ], 'InferenceExperimentDataStorageConfig' => [ 'type' => 'structure', 'required' => [ 'Destination', ], 'members' => [ 'Destination' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'ContentType' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'InferenceExperimentDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceExperimentSummary', ], ], 'InferenceExperimentName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'InferenceExperimentSchedule' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceExperimentStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'Updating', 'Running', 'Starting', 'Stopping', 'Completed', 'Cancelled', ], ], 'InferenceExperimentStatusReason' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentStopDesiredState' => [ 'type' => 'string', 'enum' => [ 'Completed', 'Cancelled', ], ], 'InferenceExperimentSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'Status', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'InferenceExperimentType' => [ 'type' => 'string', 'enum' => [ 'ShadowMode', ], ], 'InferenceImage' => [ 'type' => 'string', 'max' => 256, ], 'InferenceMetrics' => [ 'type' => 'structure', 'required' => [ 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'InferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointConfiguration', 'ModelConfiguration', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'InferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendation', ], 'max' => 10, 'min' => 1, ], 'InferenceRecommendationsJob' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobDescription', 'JobType', 'JobArn', 'Status', 'CreationTime', 'RoleArn', 'LastModifiedTime', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'InferenceRecommendationsJobStep' => [ 'type' => 'structure', 'required' => [ 'StepType', 'JobName', 'Status', ], 'members' => [ 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'InferenceBenchmark' => [ 'shape' => 'RecommendationJobInferenceBenchmark', ], ], ], 'InferenceRecommendationsJobSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJobStep', ], ], 'InferenceRecommendationsJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJob', ], ], 'InferenceSpecification' => [ 'type' => 'structure', 'required' => [ 'Containers', ], 'members' => [ 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'InferenceSpecificationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'InfraCheckConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInfraCheck' => [ 'shape' => 'EnableInfraCheck', ], ], ], 'InitialInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InitialNumberOfUsers' => [ 'type' => 'integer', 'min' => 1, ], 'InitialTaskCount' => [ 'type' => 'integer', 'min' => 1, ], 'InputConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'Framework', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], 'Framework' => [ 'shape' => 'Framework', ], 'FrameworkVersion' => [ 'shape' => 'FrameworkVersion', ], ], ], 'InputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 20, 'min' => 1, ], 'InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'InputModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInputMode', ], 'min' => 1, ], 'InstanceGroup' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'InstanceGroupName', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'InstanceGroupName', ], ], ], 'InstanceGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.+', ], 'InstanceGroupNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupName', ], 'max' => 5, ], 'InstanceGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], 'max' => 5, ], 'InstanceMetadataServiceConfiguration' => [ 'type' => 'structure', 'required' => [ 'MinimumInstanceMetadataServiceVersion', ], 'members' => [ 'MinimumInstanceMetadataServiceVersion' => [ 'shape' => 'MinimumInstanceMetadataServiceVersion', ], ], ], 'InstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r6i.large', 'ml.r6i.xlarge', 'ml.r6i.2xlarge', 'ml.r6i.4xlarge', 'ml.r6i.8xlarge', 'ml.r6i.12xlarge', 'ml.r6i.16xlarge', 'ml.r6i.24xlarge', 'ml.r6i.32xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', 'ml.m6id.large', 'ml.m6id.xlarge', 'ml.m6id.2xlarge', 'ml.m6id.4xlarge', 'ml.m6id.8xlarge', 'ml.m6id.12xlarge', 'ml.m6id.16xlarge', 'ml.m6id.24xlarge', 'ml.m6id.32xlarge', 'ml.c6id.large', 'ml.c6id.xlarge', 'ml.c6id.2xlarge', 'ml.c6id.4xlarge', 'ml.c6id.8xlarge', 'ml.c6id.12xlarge', 'ml.c6id.16xlarge', 'ml.c6id.24xlarge', 'ml.c6id.32xlarge', 'ml.r6id.large', 'ml.r6id.xlarge', 'ml.r6id.2xlarge', 'ml.r6id.4xlarge', 'ml.r6id.8xlarge', 'ml.r6id.12xlarge', 'ml.r6id.16xlarge', 'ml.r6id.24xlarge', 'ml.r6id.32xlarge', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'IntegerParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'IntegerParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameterRange', ], 'max' => 30, 'min' => 0, ], 'InvocationEndTime' => [ 'type' => 'timestamp', ], 'InvocationStartTime' => [ 'type' => 'timestamp', ], 'InvocationsMaxRetries' => [ 'type' => 'integer', 'max' => 3, 'min' => 0, ], 'InvocationsTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 1, ], 'IotRoleAlias' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'ItemIdentifierAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'JobDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'JobReferenceCode' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.+', ], 'JobReferenceCodeContains' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'JobType' => [ 'type' => 'string', 'enum' => [ 'TRAINING', 'INFERENCE', 'NOTEBOOK_KERNEL', ], ], 'JoinSource' => [ 'type' => 'string', 'enum' => [ 'Input', 'None', ], ], 'JsonContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'JsonContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonContentType', ], 'max' => 10, 'min' => 1, ], 'JsonPath' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'JupyterLabAppImageConfig' => [ 'type' => 'structure', 'members' => [ 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], 'ContainerConfig' => [ 'shape' => 'ContainerConfig', ], ], ], 'JupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'JupyterServerAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'KeepAlivePeriodInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'KendraSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'KernelDisplayName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelGatewayAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'KernelGatewayImageConfig' => [ 'type' => 'structure', 'required' => [ 'KernelSpecs', ], 'members' => [ 'KernelSpecs' => [ 'shape' => 'KernelSpecs', ], 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], ], ], 'KernelName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelSpec' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'KernelName', ], 'DisplayName' => [ 'shape' => 'KernelDisplayName', ], ], ], 'KernelSpecs' => [ 'type' => 'list', 'member' => [ 'shape' => 'KernelSpec', ], 'max' => 5, 'min' => 1, ], 'Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '^[a-zA-Z0-9:/_-]*$', ], 'LabelAttributeName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}', ], 'LabelCounter' => [ 'type' => 'integer', 'min' => 0, ], 'LabelCounters' => [ 'type' => 'structure', 'members' => [ 'TotalLabeled' => [ 'shape' => 'LabelCounter', ], 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'MachineLabeled' => [ 'shape' => 'LabelCounter', ], 'FailedNonRetryableError' => [ 'shape' => 'LabelCounter', ], 'Unlabeled' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelCountersForWorkteam' => [ 'type' => 'structure', 'members' => [ 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'PendingHuman' => [ 'shape' => 'LabelCounter', ], 'Total' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:.*', ], 'LabelingJobAlgorithmsConfig' => [ 'type' => 'structure', 'required' => [ 'LabelingJobAlgorithmSpecificationArn', ], 'members' => [ 'LabelingJobAlgorithmSpecificationArn' => [ 'shape' => 'LabelingJobAlgorithmSpecificationArn', ], 'InitialActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], 'LabelingJobResourceConfig' => [ 'shape' => 'LabelingJobResourceConfig', ], ], ], 'LabelingJobArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*', ], 'LabelingJobDataAttributes' => [ 'type' => 'structure', 'members' => [ 'ContentClassifiers' => [ 'shape' => 'ContentClassifiers', ], ], ], 'LabelingJobDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'LabelingJobS3DataSource', ], 'SnsDataSource' => [ 'shape' => 'LabelingJobSnsDataSource', ], ], ], 'LabelingJobForWorkteamSummary' => [ 'type' => 'structure', 'required' => [ 'JobReferenceCode', 'WorkRequesterAccountId', 'CreationTime', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'WorkRequesterAccountId' => [ 'shape' => 'AccountId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LabelCounters' => [ 'shape' => 'LabelCountersForWorkteam', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], ], ], 'LabelingJobForWorkteamSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobForWorkteamSummary', ], ], 'LabelingJobInputConfig' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'LabelingJobDataSource', ], 'DataAttributes' => [ 'shape' => 'LabelingJobDataAttributes', ], ], ], 'LabelingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'LabelingJobOutput' => [ 'type' => 'structure', 'required' => [ 'OutputDatasetS3Uri', ], 'members' => [ 'OutputDatasetS3Uri' => [ 'shape' => 'S3Uri', ], 'FinalActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'LabelingJobOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobResourceConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'LabelingJobS3DataSource' => [ 'type' => 'structure', 'required' => [ 'ManifestS3Uri', ], 'members' => [ 'ManifestS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'LabelingJobSnsDataSource' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'LabelingJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxHumanLabeledObjectCount' => [ 'shape' => 'MaxHumanLabeledObjectCount', ], 'MaxPercentageOfInputDatasetLabeled' => [ 'shape' => 'MaxPercentageOfInputDatasetLabeled', ], ], ], 'LabelingJobSummary' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelingJobArn', 'CreationTime', 'LastModifiedTime', 'LabelingJobStatus', 'LabelCounters', 'WorkteamArn', 'PreHumanTaskLambdaArn', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], ], ], 'LabelingJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobSummary', ], ], 'LambdaFunctionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*', ], 'LambdaStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'LandingUri' => [ 'type' => 'string', 'max' => 1023, ], 'LastModifiedTime' => [ 'type' => 'timestamp', ], 'LastUpdateStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'LastUpdateStatusValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'LastUpdateStatusValue' => [ 'type' => 'string', 'enum' => [ 'Successful', 'Failed', 'InProgress', ], ], 'LifecycleConfigArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], 'LineageEntityParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'StringParameterValue', ], 'max' => 30, ], 'LineageGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*', ], 'LineageGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'LineageGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageGroupSummary', ], ], 'LineageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'LineageType' => [ 'type' => 'string', 'enum' => [ 'TrialComponent', 'Artifact', 'Context', 'Action', ], ], 'ListActionsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ActionType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortActionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlgorithmsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'AlgorithmSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAlgorithmsOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSummaryList', ], 'members' => [ 'AlgorithmSummaryList' => [ 'shape' => 'AlgorithmSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageVersionAliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppImageConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'AppImageConfigName', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'AppImageConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAppImageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AppImageConfigs' => [ 'shape' => 'AppImageConfigList', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'AppSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameEquals' => [ 'shape' => 'UserProfileName', ], 'SpaceNameEquals' => [ 'shape' => 'SpaceName', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'members' => [ 'Apps' => [ 'shape' => 'AppList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortArtifactsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListArtifactsResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactSummaries' => [ 'shape' => 'ArtifactSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortAssociationsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationSummaries' => [ 'shape' => 'AssociationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'AutoMLNameContains', ], 'StatusEquals' => [ 'shape' => 'AutoMLJobStatus', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'AutoMLSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobSummaries', ], 'members' => [ 'AutoMLJobSummaries' => [ 'shape' => 'AutoMLJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'StatusEquals' => [ 'shape' => 'CandidateStatus', ], 'CandidateNameEquals' => [ 'shape' => 'CandidateName', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'CandidateSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResultsForTrials', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'Candidates', ], 'members' => [ 'Candidates' => [ 'shape' => 'AutoMLCandidates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListClusterNodesRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'InstanceGroupNameContains' => [ 'shape' => 'ClusterInstanceGroupName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClusterNodesResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterNodeSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterNodeSummaries' => [ 'shape' => 'ClusterNodeSummaries', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterSummaries' => [ 'shape' => 'ClusterSummaries', ], ], ], 'ListCodeRepositoriesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'CodeRepositoryNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'CodeRepositorySortBy', ], 'SortOrder' => [ 'shape' => 'CodeRepositorySortOrder', ], ], ], 'ListCodeRepositoriesOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositorySummaryList', ], 'members' => [ 'CodeRepositorySummaryList' => [ 'shape' => 'CodeRepositorySummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'CompilationJobStatus', ], 'SortBy' => [ 'shape' => 'ListCompilationJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListCompilationJobsResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobSummaries', ], 'members' => [ 'CompilationJobSummaries' => [ 'shape' => 'CompilationJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListContextsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortContextsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListContextsResponse' => [ 'type' => 'structure', 'members' => [ 'ContextSummaries' => [ 'shape' => 'ContextSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListDataQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListDeviceFleetsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListDeviceFleetsResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetSummaries', ], 'members' => [ 'DeviceFleetSummaries' => [ 'shape' => 'DeviceFleetSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'LatestHeartbeatAfter' => [ 'shape' => 'Timestamp', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceSummaries', ], 'members' => [ 'DeviceSummaries' => [ 'shape' => 'DeviceSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Domains' => [ 'shape' => 'DomainList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'DeviceFleetNameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListEdgeDeploymentPlansSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgeDeploymentPlansResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanSummaries', ], 'members' => [ 'EdgeDeploymentPlanSummaries' => [ 'shape' => 'EdgeDeploymentPlanSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DEVICE_FLEET_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListEdgePackagingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelNameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'EdgePackagingJobStatus', ], 'SortBy' => [ 'shape' => 'ListEdgePackagingJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgePackagingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobSummaries', ], 'members' => [ 'EdgePackagingJobSummaries' => [ 'shape' => 'EdgePackagingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgePackagingJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'MODEL_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'STATUS', ], ], 'ListEndpointConfigsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointConfigSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListEndpointConfigsOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigs', ], 'members' => [ 'EndpointConfigs' => [ 'shape' => 'EndpointConfigSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListEndpointsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'EndpointStatus', ], ], ], 'ListEndpointsOutput' => [ 'type' => 'structure', 'required' => [ 'Endpoints', ], 'members' => [ 'Endpoints' => [ 'shape' => 'EndpointSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentSummaries' => [ 'shape' => 'ExperimentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'FeatureGroupNameContains', ], 'FeatureGroupStatusEquals' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatusEquals' => [ 'shape' => 'OfflineStoreStatusValue', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'SortOrder' => [ 'shape' => 'FeatureGroupSortOrder', ], 'SortBy' => [ 'shape' => 'FeatureGroupSortBy', ], 'MaxResults' => [ 'shape' => 'FeatureGroupMaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupSummaries', ], 'members' => [ 'FeatureGroupSummaries' => [ 'shape' => 'FeatureGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListFlowDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionSummaries', ], 'members' => [ 'FlowDefinitionSummaries' => [ 'shape' => 'FlowDefinitionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'MinVersion' => [ 'shape' => 'HubContentVersion', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsResponse' => [ 'type' => 'structure', 'required' => [ 'HubSummaries', ], 'members' => [ 'HubSummaries' => [ 'shape' => 'HubInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHumanTaskUisRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListHumanTaskUisResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiSummaries', ], 'members' => [ 'HumanTaskUiSummaries' => [ 'shape' => 'HumanTaskUiSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHyperParameterTuningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'SortBy' => [ 'shape' => 'HyperParameterTuningJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'HyperParameterTuningJobStatus', ], ], ], 'ListHyperParameterTuningJobsResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobSummaries', ], 'members' => [ 'HyperParameterTuningJobSummaries' => [ 'shape' => 'HyperParameterTuningJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ImageVersionSortOrder', ], ], ], 'ListImageVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersions' => [ 'shape' => 'ImageVersions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImagesRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ImageNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageSortBy', ], 'SortOrder' => [ 'shape' => 'ImageSortOrder', ], ], ], 'ListImagesResponse' => [ 'type' => 'structure', 'members' => [ 'Images' => [ 'shape' => 'Images', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceComponentsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'InferenceComponentSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'InferenceComponentNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'InferenceComponentStatus', ], 'EndpointNameEquals' => [ 'shape' => 'EndpointName', ], 'VariantNameEquals' => [ 'shape' => 'VariantName', ], ], ], 'ListInferenceComponentsOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponents', ], 'members' => [ 'InferenceComponents' => [ 'shape' => 'InferenceComponentSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInferenceExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'StatusEquals' => [ 'shape' => 'InferenceExperimentStatus', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortInferenceExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListInferenceExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceExperiments' => [ 'shape' => 'InferenceExperimentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'InferenceRecommendationsJobSteps', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'RecommendationJobStatus', ], 'SortBy' => [ 'shape' => 'ListInferenceRecommendationsJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelNameEquals' => [ 'shape' => 'ModelName', ], 'ModelPackageVersionArnEquals' => [ 'shape' => 'ModelPackageArn', ], ], ], 'ListInferenceRecommendationsJobsResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobs', ], 'members' => [ 'InferenceRecommendationsJobs' => [ 'shape' => 'InferenceRecommendationsJobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'JobReferenceCodeContains' => [ 'shape' => 'JobReferenceCodeContains', ], 'SortBy' => [ 'shape' => 'ListLabelingJobsForWorkteamSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListLabelingJobsForWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobSummaryList', ], 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobForWorkteamSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ListLabelingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'StatusEquals' => [ 'shape' => 'LabelingJobStatus', ], ], ], 'ListLabelingJobsResponse' => [ 'type' => 'structure', 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLineageEntityParameterKey' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameterValue', ], ], 'ListLineageGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortLineageGroupsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListLineageGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupSummaries' => [ 'shape' => 'LineageGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'ListModelBiasJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelBiasJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModelCardExportJobNameContains' => [ 'shape' => 'EntityName', ], 'StatusEquals' => [ 'shape' => 'ModelCardExportJobStatus', ], 'SortBy' => [ 'shape' => 'ModelCardExportJobSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardExportJobSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelCardExportJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobSummaries', ], 'members' => [ 'ModelCardExportJobSummaries' => [ 'shape' => 'ModelCardExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardVersionSummaryList', ], 'members' => [ 'ModelCardVersionSummaryList' => [ 'shape' => 'ModelCardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardSummaries', ], 'members' => [ 'ModelCardSummaries' => [ 'shape' => 'ModelCardSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelMetadataRequest' => [ 'type' => 'structure', 'members' => [ 'SearchExpression' => [ 'shape' => 'ModelMetadataSearchExpression', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'ModelMetadataSummaries', ], 'members' => [ 'ModelMetadataSummaries' => [ 'shape' => 'ModelMetadataSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackageGroupsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageGroupSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackageGroupsOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupSummaryList', ], 'members' => [ 'ModelPackageGroupSummaryList' => [ 'shape' => 'ModelPackageGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackagesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageType' => [ 'shape' => 'ModelPackageType', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackagesOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageSummaryList', ], 'members' => [ 'ModelPackageSummaryList' => [ 'shape' => 'ModelPackageSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ModelSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ModelNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelsOutput' => [ 'type' => 'structure', 'required' => [ 'Models', ], 'members' => [ 'Models' => [ 'shape' => 'ModelSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListMonitoringAlertHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'SortBy' => [ 'shape' => 'MonitoringAlertHistorySortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'ListMonitoringAlertHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertHistory' => [ 'shape' => 'MonitoringAlertHistoryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringAlertsRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMonitoringAlertsResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringExecutionsRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringExecutionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ScheduledTimeBefore' => [ 'shape' => 'Timestamp', ], 'ScheduledTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ExecutionStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringExecutionsResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringExecutionSummaries', ], 'members' => [ 'MonitoringExecutionSummaries' => [ 'shape' => 'MonitoringExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringSchedulesRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringScheduleSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringSchedulesResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleSummaries', ], 'members' => [ 'MonitoringScheduleSummaries' => [ 'shape' => 'MonitoringScheduleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], ], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstanceLifecycleConfigs' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummaryList', ], ], ], 'ListNotebookInstancesInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'StatusEquals' => [ 'shape' => 'NotebookInstanceStatus', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepositoryContains' => [ 'shape' => 'CodeRepositoryContains', ], 'AdditionalCodeRepositoryEquals' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], ], ], 'ListNotebookInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstances' => [ 'shape' => 'NotebookInstanceSummaryList', ], ], ], 'ListPipelineExecutionStepsRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListPipelineExecutionStepsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSteps' => [ 'shape' => 'PipelineExecutionStepList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineExecutionsRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelineExecutionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineExecutionsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSummaries' => [ 'shape' => 'PipelineExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineParametersForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineParametersForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineNamePrefix' => [ 'shape' => 'PipelineName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelinesBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineSummaries' => [ 'shape' => 'PipelineSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProcessingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'String', ], 'StatusEquals' => [ 'shape' => 'ProcessingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListProcessingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobSummaries', ], 'members' => [ 'ProcessingJobSummaries' => [ 'shape' => 'ProcessingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProjectsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ProjectEntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ProjectSortBy', ], 'SortOrder' => [ 'shape' => 'ProjectSortOrder', ], ], ], 'ListProjectsOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectSummaryList', ], 'members' => [ 'ProjectSummaryList' => [ 'shape' => 'ProjectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'ResourceCatalogName', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'ResourceCatalogSortOrder', ], 'SortBy' => [ 'shape' => 'ResourceCatalogSortBy', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceCatalogs' => [ 'shape' => 'ResourceCatalogList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSpacesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SpaceSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'SpaceNameContains' => [ 'shape' => 'SpaceName', ], ], ], 'ListSpacesResponse' => [ 'type' => 'structure', 'members' => [ 'Spaces' => [ 'shape' => 'SpaceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStageDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ExcludeDevicesDeployedInOtherStage' => [ 'shape' => 'Boolean', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'ListStageDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceDeploymentSummaries', ], 'members' => [ 'DeviceDeploymentSummaries' => [ 'shape' => 'DeviceDeploymentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStudioLifecycleConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'StudioLifecycleConfigName', ], 'AppTypeEquals' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'StudioLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListStudioLifecycleConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'StudioLifecycleConfigs' => [ 'shape' => 'StudioLifecycleConfigsList', ], ], ], 'ListSubscribedWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListSubscribedWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteams', ], 'members' => [ 'SubscribedWorkteams' => [ 'shape' => 'SubscribedWorkteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListTagsMaxResults', ], ], ], 'ListTagsMaxResults' => [ 'type' => 'integer', 'min' => 50, ], 'ListTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'TrainingJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'HyperParameterTrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'WarmPoolStatusEquals' => [ 'shape' => 'WarmPoolResourceStatus', ], ], ], 'ListTrainingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'TrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTransformJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TransformJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListTransformJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobSummaries', ], 'members' => [ 'TransformJobSummaries' => [ 'shape' => 'TransformJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentKey256' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentKey256', ], ], 'ListTrialComponentsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'SourceArn' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialComponentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialSummaries' => [ 'shape' => 'TrialSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'UserProfileSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameContains' => [ 'shape' => 'UserProfileName', ], ], ], 'ListUserProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfiles' => [ 'shape' => 'UserProfileList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkforcesSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkforceName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkforcesResponse' => [ 'type' => 'structure', 'required' => [ 'Workforces', ], 'members' => [ 'Workforces' => [ 'shape' => 'Workforces', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'ListWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkteamsSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'Workteams', ], 'members' => [ 'Workteams' => [ 'shape' => 'Workteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkteamsSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'Long' => [ 'type' => 'long', ], 'MLFramework' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingMinInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxCandidates' => [ 'type' => 'integer', 'max' => 750, 'min' => 1, ], 'MaxConcurrentInvocationsPerInstance' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxConcurrentTaskCount' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'MaxConcurrentTransforms' => [ 'type' => 'integer', 'min' => 0, ], 'MaxHumanLabeledObjectCount' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'type' => 'integer', 'min' => 3, ], 'MaxParallelExecutionSteps' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxPayloadInMB' => [ 'type' => 'integer', 'min' => 0, ], 'MaxPendingTimeInSeconds' => [ 'type' => 'integer', 'max' => 2419200, 'min' => 7200, ], 'MaxPercentageOfInputDatasetLabeled' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxWaitTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaximumExecutionTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 600, ], 'MaximumRetryAttempts' => [ 'type' => 'integer', 'max' => 30, 'min' => 1, ], 'MediaType' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[-\\w]+\\/[-\\w+]+$', ], 'MemberDefinition' => [ 'type' => 'structure', 'members' => [ 'CognitoMemberDefinition' => [ 'shape' => 'CognitoMemberDefinition', ], 'OidcMemberDefinition' => [ 'shape' => 'OidcMemberDefinition', ], ], ], 'MemberDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberDefinition', ], 'max' => 10, 'min' => 1, ], 'MemoryInMb' => [ 'type' => 'integer', 'min' => 128, ], 'MetadataProperties' => [ 'type' => 'structure', 'members' => [ 'CommitId' => [ 'shape' => 'MetadataPropertyValue', ], 'Repository' => [ 'shape' => 'MetadataPropertyValue', ], 'GeneratedBy' => [ 'shape' => 'MetadataPropertyValue', ], 'ProjectId' => [ 'shape' => 'MetadataPropertyValue', ], ], ], 'MetadataPropertyValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'MetricData' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'Float', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatum', ], 'max' => 40, 'min' => 0, ], 'MetricDatum' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'Float', ], 'Set' => [ 'shape' => 'MetricSetSource', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricExtendedEnum', ], ], ], 'MetricDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Regex', ], 'members' => [ 'Name' => [ 'shape' => 'MetricName', ], 'Regex' => [ 'shape' => 'MetricRegex', ], ], ], 'MetricDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDefinition', ], 'max' => 40, 'min' => 0, ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'MetricRegex' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.+', ], 'MetricSetSource' => [ 'type' => 'string', 'enum' => [ 'Train', 'Validation', 'Test', ], ], 'MetricSpecification' => [ 'type' => 'structure', 'members' => [ 'Predefined' => [ 'shape' => 'PredefinedMetricSpecification', ], 'Customized' => [ 'shape' => 'CustomizedMetricSpecification', ], ], 'union' => true, ], 'MetricValue' => [ 'type' => 'float', ], 'MetricsSource' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'type' => 'string', 'max' => 1, 'pattern' => '1|2', ], 'Model' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'ModelAccessConfig' => [ 'type' => 'structure', 'required' => [ 'AcceptEula', ], 'members' => [ 'AcceptEula' => [ 'shape' => 'AcceptEula', ], ], ], 'ModelApprovalStatus' => [ 'type' => 'string', 'enum' => [ 'Approved', 'Rejected', 'PendingManualApproval', ], ], 'ModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*', ], 'ModelArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ModelArtifacts', ], 'members' => [ 'S3ModelArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelBiasAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelBiasBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelBiasJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelCacheSetting' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], 'ModelPackageGroupName' => [ 'shape' => 'String', ], ], ], 'ModelCardArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardContent' => [ 'type' => 'string', 'max' => 100000, 'min' => 0, 'pattern' => '.*', 'sensitive' => true, ], 'ModelCardExportArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ExportArtifacts', ], 'members' => [ 'S3ExportArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardExportJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardExportJobSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ModelCardExportJobSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', ], ], 'ModelCardExportJobSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardExportJobSummary', ], ], 'ModelCardExportOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})', ], 'ModelCardProcessingStatus' => [ 'type' => 'string', 'enum' => [ 'DeleteInProgress', 'DeletePending', 'ContentDeleted', 'ExportJobsDeleted', 'DeleteCompleted', 'DeleteFailed', ], ], 'ModelCardSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ModelCardSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelCardSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardStatus' => [ 'type' => 'string', 'enum' => [ 'Draft', 'PendingReview', 'Approved', 'Archived', ], ], 'ModelCardSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardSummary', ], ], 'ModelCardVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'Version', ], ], 'ModelCardVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'ModelCardVersion', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardVersionSummary', ], ], 'ModelClientConfig' => [ 'type' => 'structure', 'members' => [ 'InvocationsTimeoutInSeconds' => [ 'shape' => 'InvocationsTimeoutInSeconds', ], 'InvocationsMaxRetries' => [ 'shape' => 'InvocationsMaxRetries', ], ], ], 'ModelCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ModelConfiguration' => [ 'type' => 'structure', 'members' => [ 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameters' => [ 'shape' => 'EnvironmentParameters', ], 'CompilationJobName' => [ 'shape' => 'RecommendationJobCompilationJobName', ], ], ], 'ModelDashboardEndpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'ModelDashboardEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardEndpoint', ], ], 'ModelDashboardIndicatorAction' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'ModelDashboardModel' => [ 'type' => 'structure', 'members' => [ 'Model' => [ 'shape' => 'Model', ], 'Endpoints' => [ 'shape' => 'ModelDashboardEndpoints', ], 'LastBatchTransformJob' => [ 'shape' => 'TransformJob', ], 'MonitoringSchedules' => [ 'shape' => 'ModelDashboardMonitoringSchedules', ], 'ModelCard' => [ 'shape' => 'ModelDashboardModelCard', ], ], ], 'ModelDashboardModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], ], ], 'ModelDashboardMonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelDashboardMonitoringSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardMonitoringSchedule', ], ], 'ModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3ModelDataSource', ], ], ], 'ModelDeployConfig' => [ 'type' => 'structure', 'members' => [ 'AutoGenerateEndpointName' => [ 'shape' => 'AutoGenerateEndpointName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDeployResult' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDigests' => [ 'type' => 'structure', 'members' => [ 'ArtifactDigest' => [ 'shape' => 'ArtifactDigest', ], ], ], 'ModelExplainabilityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelExplainabilityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelExplainabilityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelInfrastructureConfig' => [ 'type' => 'structure', 'required' => [ 'InfrastructureType', 'RealTimeInferenceConfig', ], 'members' => [ 'InfrastructureType' => [ 'shape' => 'ModelInfrastructureType', ], 'RealTimeInferenceConfig' => [ 'shape' => 'RealTimeInferenceConfig', ], ], ], 'ModelInfrastructureType' => [ 'type' => 'string', 'enum' => [ 'RealTimeInference', ], ], 'ModelInput' => [ 'type' => 'structure', 'required' => [ 'DataInputConfig', ], 'members' => [ 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'ModelInsightsLocation' => [ 'type' => 'string', 'min' => 1, ], 'ModelLatencyThreshold' => [ 'type' => 'structure', 'members' => [ 'Percentile' => [ 'shape' => 'String64', ], 'ValueInMilliseconds' => [ 'shape' => 'Integer', ], ], ], 'ModelLatencyThresholds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelLatencyThreshold', ], 'max' => 1, 'min' => 1, ], 'ModelMetadataFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'ModelMetadataFilterType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ModelMetadataFilterType' => [ 'type' => 'string', 'enum' => [ 'Domain', 'Framework', 'Task', 'FrameworkVersion', ], ], 'ModelMetadataFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataFilter', ], 'max' => 4, 'min' => 1, ], 'ModelMetadataSearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ModelMetadataFilters', ], ], ], 'ModelMetadataSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataSummary', ], ], 'ModelMetadataSummary' => [ 'type' => 'structure', 'required' => [ 'Domain', 'Framework', 'Task', 'Model', 'FrameworkVersion', ], 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Model' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], ], ], 'ModelMetrics' => [ 'type' => 'structure', 'members' => [ 'ModelQuality' => [ 'shape' => 'ModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'ModelDataQuality', ], 'Bias' => [ 'shape' => 'Bias', ], 'Explainability' => [ 'shape' => 'Explainability', ], ], ], 'ModelName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'ModelPackage' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'ModelPackageArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$', ], 'ModelPackageArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageArn', ], 'max' => 100, 'min' => 1, ], 'ModelPackageContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', ], 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageDigest' => [ 'shape' => 'ImageDigest', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelInput' => [ 'shape' => 'ModelInput', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'ModelPackageFrameworkVersion', ], 'NearestModelName' => [ 'shape' => 'String', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'ModelPackageContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageContainerDefinition', ], 'max' => 15, 'min' => 1, ], 'ModelPackageFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'ModelPackageGroup' => [ 'type' => 'structure', 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ModelPackageGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$', ], 'ModelPackageGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', 'DeleteFailed', ], ], 'ModelPackageGroupSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'ModelPackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageGroupSummary', ], ], 'ModelPackageSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageSourceUri' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}', ], 'ModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'ModelPackageStatusDetails' => [ 'type' => 'structure', 'required' => [ 'ValidationStatuses', ], 'members' => [ 'ValidationStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], ], ], 'ModelPackageStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedModelPackageStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'ModelPackageStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageStatusItem', ], ], 'ModelPackageSummaries' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageSummary', ], ], 'ModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'ModelPackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageSummary', ], ], 'ModelPackageType' => [ 'type' => 'string', 'enum' => [ 'Versioned', 'Unversioned', 'Both', ], ], 'ModelPackageValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TransformJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'ModelPackageValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageValidationProfile', ], 'max' => 1, 'min' => 0, ], 'ModelPackageValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'ModelPackageValidationProfiles', ], ], ], 'ModelPackageVersion' => [ 'type' => 'integer', 'min' => 1, ], 'ModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'ProblemType' => [ 'shape' => 'MonitoringProblemType', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelQualityJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelRegisterSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'CrossAccountModelRegisterRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ModelSetupTime' => [ 'type' => 'integer', 'min' => 0, ], 'ModelSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelArn', 'CreationTime', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelSummary', ], ], 'ModelVariantAction' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Remove', 'Promote', ], ], 'ModelVariantActionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelVariantName', ], 'value' => [ 'shape' => 'ModelVariantAction', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], ], ], 'ModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfig', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfigSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', 'Status', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], 'Status' => [ 'shape' => 'ModelVariantStatus', ], ], ], 'ModelVariantConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfigSummary', ], ], 'ModelVariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelVariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'InService', 'Deleting', 'Deleted', ], ], 'MonitoringAlertActions' => [ 'type' => 'structure', 'members' => [ 'ModelDashboardIndicator' => [ 'shape' => 'ModelDashboardIndicatorAction', ], ], ], 'MonitoringAlertHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertHistorySummary', ], ], 'MonitoringAlertHistorySortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', ], ], 'MonitoringAlertHistorySummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'CreationTime', 'AlertStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'MonitoringAlertName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringAlertStatus' => [ 'type' => 'string', 'enum' => [ 'InAlert', 'OK', ], ], 'MonitoringAlertSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringAlertName', 'CreationTime', 'LastModifiedTime', 'AlertStatus', 'DatapointsToAlert', 'EvaluationPeriod', 'Actions', ], 'members' => [ 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], 'Actions' => [ 'shape' => 'MonitoringAlertActions', ], ], ], 'MonitoringAlertSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertSummary', ], 'max' => 100, 'min' => 1, ], 'MonitoringAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'MonitoringClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringConstraintsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 50, 'min' => 1, ], 'MonitoringCsvDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringDatapointsToAlert' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Csv' => [ 'shape' => 'MonitoringCsvDatasetFormat', ], 'Json' => [ 'shape' => 'MonitoringJsonDatasetFormat', ], 'Parquet' => [ 'shape' => 'MonitoringParquetDatasetFormat', ], ], ], 'MonitoringEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 50, ], 'MonitoringEvaluationPeriod' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringExecutionSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'ScheduledTime', 'Status', ], ], 'MonitoringExecutionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'ScheduledTime', 'CreationTime', 'LastModifiedTime', 'MonitoringExecutionStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringExecutionStatus' => [ 'shape' => 'ExecutionStatus', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringExecutionSummary', ], ], 'MonitoringGroundTruthS3Input' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], ], ], 'MonitoringInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'MonitoringInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringInput', ], 'max' => 1, 'min' => 1, ], 'MonitoringJobDefinition' => [ 'type' => 'structure', 'required' => [ 'MonitoringInputs', 'MonitoringOutputConfig', 'MonitoringResources', 'MonitoringAppSpecification', 'RoleArn', ], 'members' => [ 'BaselineConfig' => [ 'shape' => 'MonitoringBaselineConfig', ], 'MonitoringInputs' => [ 'shape' => 'MonitoringInputs', ], 'MonitoringOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'MonitoringResources' => [ 'shape' => 'MonitoringResources', ], 'MonitoringAppSpecification' => [ 'shape' => 'MonitoringAppSpecification', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MonitoringJobDefinitionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringJobDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringJobDefinitionSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'MonitoringJobDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringJobDefinitionName', 'MonitoringJobDefinitionArn', 'CreationTime', 'EndpointName', ], 'members' => [ 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringJobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'MonitoringJobDefinitionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringJobDefinitionSummary', ], ], 'MonitoringJsonDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Line' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'MonitoringNetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'MonitoringOutput' => [ 'type' => 'structure', 'required' => [ 'S3Output', ], 'members' => [ 'S3Output' => [ 'shape' => 'MonitoringS3Output', ], ], ], 'MonitoringOutputConfig' => [ 'type' => 'structure', 'required' => [ 'MonitoringOutputs', ], 'members' => [ 'MonitoringOutputs' => [ 'shape' => 'MonitoringOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringOutput', ], 'max' => 1, 'min' => 1, ], 'MonitoringParquetDatasetFormat' => [ 'type' => 'structure', 'members' => [], ], 'MonitoringProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'MonitoringResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'MonitoringClusterConfig', ], ], ], 'MonitoringS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', ], 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'MonitoringS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'MonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'MonitoringScheduleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringScheduleConfig' => [ 'type' => 'structure', 'members' => [ 'ScheduleConfig' => [ 'shape' => 'ScheduleConfig', ], 'MonitoringJobDefinition' => [ 'shape' => 'MonitoringJobDefinition', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringSchedule', ], ], 'MonitoringScheduleName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringScheduleSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'MonitoringScheduleSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleArn', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringScheduleSummary', ], ], 'MonitoringStatisticsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MonitoringMaxRuntimeInSeconds', ], ], ], 'MonitoringTimeOffsetString' => [ 'type' => 'string', 'max' => 15, 'min' => 1, 'pattern' => '^.?P.*', ], 'MonitoringType' => [ 'type' => 'string', 'enum' => [ 'DataQuality', 'ModelQuality', 'ModelBias', 'ModelExplainability', ], ], 'MountPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^\\/.*', ], 'MultiModelConfig' => [ 'type' => 'structure', 'members' => [ 'ModelCacheSetting' => [ 'shape' => 'ModelCacheSetting', ], ], ], 'NameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'NeoVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'NeoVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'NeoVpcSubnets', ], ], ], 'NeoVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'NeoVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'NestedFilters' => [ 'type' => 'structure', 'required' => [ 'NestedPropertyName', 'Filters', ], 'members' => [ 'NestedPropertyName' => [ 'shape' => 'ResourcePropertyName', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'NestedFiltersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NestedFilters', ], 'max' => 20, 'min' => 1, ], 'NetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'NonEmptyString256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(?!\\s*$).+', ], 'NonEmptyString64' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^(?!\\s*$).+', ], 'NotebookInstanceAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'NotebookInstanceAcceleratorTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceAcceleratorType', ], ], 'NotebookInstanceArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'NotebookInstanceLifecycleConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleHook', ], 'max' => 1, ], 'NotebookInstanceLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', 'NotebookInstanceLifecycleConfigArn', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummary', ], ], 'NotebookInstanceLifecycleHook' => [ 'type' => 'structure', 'members' => [ 'Content' => [ 'shape' => 'NotebookInstanceLifecycleConfigContent', ], ], ], 'NotebookInstanceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'NotebookInstanceSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InService', 'Stopping', 'Stopped', 'Failed', 'Deleting', 'Updating', ], ], 'NotebookInstanceSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'NotebookInstanceArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], ], ], 'NotebookInstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceSummary', ], ], 'NotebookInstanceUrl' => [ 'type' => 'string', ], 'NotebookInstanceVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'NotebookOutputOption' => [ 'type' => 'string', 'enum' => [ 'Allowed', 'Disabled', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'NotificationTopicArn' => [ 'shape' => 'NotificationTopicArn', ], ], ], 'NotificationTopicArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*', ], 'NumberOfAcceleratorDevices' => [ 'type' => 'float', 'min' => 1, ], 'NumberOfCpuCores' => [ 'type' => 'float', 'min' => 0.25, ], 'NumberOfHumanWorkersPerDataObject' => [ 'type' => 'integer', 'max' => 9, 'min' => 1, ], 'NumberOfSteps' => [ 'type' => 'integer', 'min' => 1, ], 'ObjectiveStatus' => [ 'type' => 'string', 'enum' => [ 'Succeeded', 'Pending', 'Failed', ], ], 'ObjectiveStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'ObjectiveStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Succeeded' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Pending' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Failed' => [ 'shape' => 'ObjectiveStatusCounter', ], ], ], 'OfflineStoreConfig' => [ 'type' => 'structure', 'required' => [ 'S3StorageConfig', ], 'members' => [ 'S3StorageConfig' => [ 'shape' => 'S3StorageConfig', ], 'DisableGlueTableCreation' => [ 'shape' => 'Boolean', ], 'DataCatalogConfig' => [ 'shape' => 'DataCatalogConfig', ], 'TableFormat' => [ 'shape' => 'TableFormat', ], ], ], 'OfflineStoreStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'OfflineStoreStatusValue', ], 'BlockedReason' => [ 'shape' => 'BlockedReason', ], ], ], 'OfflineStoreStatusValue' => [ 'type' => 'string', 'enum' => [ 'Active', 'Blocked', 'Disabled', ], ], 'OidcConfig' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ClientSecret', 'Issuer', 'AuthorizationEndpoint', 'TokenEndpoint', 'UserInfoEndpoint', 'LogoutEndpoint', 'JwksUri', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'ClientSecret' => [ 'shape' => 'ClientSecret', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcConfigForResponse' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcEndpoint' => [ 'type' => 'string', 'max' => 500, 'pattern' => 'https://\\S+', ], 'OidcMemberDefinition' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], ], ], 'OnlineStoreConfig' => [ 'type' => 'structure', 'members' => [ 'SecurityConfig' => [ 'shape' => 'OnlineStoreSecurityConfig', ], 'EnableOnlineStore' => [ 'shape' => 'Boolean', ], 'TtlDuration' => [ 'shape' => 'TtlDuration', ], 'StorageType' => [ 'shape' => 'StorageType', ], ], ], 'OnlineStoreConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OnlineStoreTotalSizeBytes' => [ 'type' => 'long', ], 'Operator' => [ 'type' => 'string', 'enum' => [ 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqualTo', 'LessThan', 'LessThanOrEqualTo', 'Contains', 'Exists', 'NotExists', 'In', ], ], 'OptionalDouble' => [ 'type' => 'double', ], 'OptionalInteger' => [ 'type' => 'integer', ], 'OptionalVolumeSizeInGB' => [ 'type' => 'integer', 'min' => 0, ], 'OrderKey' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'OutputCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'OutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'TargetDevice' => [ 'shape' => 'TargetDevice', ], 'TargetPlatform' => [ 'shape' => 'TargetPlatform', ], 'CompilerOptions' => [ 'shape' => 'CompilerOptions', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'OutputCompressionType', ], ], ], 'OutputParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String256', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'OutputParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputParameter', ], 'max' => 50, 'min' => 0, ], 'OwnershipSettings' => [ 'type' => 'structure', 'required' => [ 'OwnerUserProfileName', ], 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'OwnershipSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'MaxParallelExecutionSteps', ], 'members' => [ 'MaxParallelExecutionSteps' => [ 'shape' => 'MaxParallelExecutionSteps', ], ], ], 'Parameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'PipelineParameterName', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], 'max' => 200, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'ParameterRange' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRangeSpecification' => [ 'shape' => 'IntegerParameterRangeSpecification', ], 'ContinuousParameterRangeSpecification' => [ 'shape' => 'ContinuousParameterRangeSpecification', ], 'CategoricalParameterRangeSpecification' => [ 'shape' => 'CategoricalParameterRangeSpecification', ], ], ], 'ParameterRanges' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRanges' => [ 'shape' => 'IntegerParameterRanges', ], 'ContinuousParameterRanges' => [ 'shape' => 'ContinuousParameterRanges', ], 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameterRanges', ], 'AutoParameters' => [ 'shape' => 'AutoParameters', ], ], ], 'ParameterType' => [ 'type' => 'string', 'enum' => [ 'Integer', 'Continuous', 'Categorical', 'FreeText', ], ], 'ParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterValue', ], 'max' => 30, 'min' => 1, ], 'Parent' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ParentHyperParameterTuningJob' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'ParentHyperParameterTuningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParentHyperParameterTuningJob', ], 'max' => 5, 'min' => 1, ], 'Parents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parent', ], ], 'PendingDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'ShadowProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], ], ], 'PendingProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'PendingProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingProductionVariantSummary', ], 'min' => 1, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, ], 'Phase' => [ 'type' => 'structure', 'members' => [ 'InitialNumberOfUsers' => [ 'shape' => 'InitialNumberOfUsers', ], 'SpawnRate' => [ 'shape' => 'SpawnRate', ], 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], ], ], 'Phases' => [ 'type' => 'list', 'member' => [ 'shape' => 'Phase', ], 'min' => 1, ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*', ], 'PipelineDefinition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'PipelineDefinitionS3Location' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ObjectKey', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'ObjectKey' => [ 'shape' => 'Key', ], 'VersionId' => [ 'shape' => 'VersionId', ], ], ], 'PipelineDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecution' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], ], ], 'PipelineExecutionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$', ], 'PipelineExecutionDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecutionFailureReason' => [ 'type' => 'string', 'max' => 1300, 'pattern' => '.*', ], 'PipelineExecutionName' => [ 'type' => 'string', 'max' => 82, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}', ], 'PipelineExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'PipelineExecutionStep' => [ 'type' => 'structure', 'members' => [ 'StepName' => [ 'shape' => 'StepName', ], 'StepDisplayName' => [ 'shape' => 'StepDisplayName', ], 'StepDescription' => [ 'shape' => 'StepDescription', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StepStatus' => [ 'shape' => 'StepStatus', ], 'CacheHitResult' => [ 'shape' => 'CacheHitResult', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Metadata' => [ 'shape' => 'PipelineExecutionStepMetadata', ], 'AttemptCount' => [ 'shape' => 'Integer', ], 'SelectiveExecutionResult' => [ 'shape' => 'SelectiveExecutionResult', ], ], ], 'PipelineExecutionStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionStep', ], 'max' => 100, 'min' => 0, ], 'PipelineExecutionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJobStepMetadata', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJobStepMetadata', ], 'TransformJob' => [ 'shape' => 'TransformJobStepMetadata', ], 'TuningJob' => [ 'shape' => 'TuningJobStepMetaData', ], 'Model' => [ 'shape' => 'ModelStepMetadata', ], 'RegisterModel' => [ 'shape' => 'RegisterModelStepMetadata', ], 'Condition' => [ 'shape' => 'ConditionStepMetadata', ], 'Callback' => [ 'shape' => 'CallbackStepMetadata', ], 'Lambda' => [ 'shape' => 'LambdaStepMetadata', ], 'EMR' => [ 'shape' => 'EMRStepMetadata', ], 'QualityCheck' => [ 'shape' => 'QualityCheckStepMetadata', ], 'ClarifyCheck' => [ 'shape' => 'ClarifyCheckStepMetadata', ], 'Fail' => [ 'shape' => 'FailStepMetadata', ], 'AutoMLJob' => [ 'shape' => 'AutoMLJobStepMetadata', ], ], ], 'PipelineExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionFailureReason' => [ 'shape' => 'String3072', ], ], ], 'PipelineExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionSummary', ], 'max' => 100, 'min' => 0, ], 'PipelineExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}', ], 'PipelineNameOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})', ], 'PipelineParameterName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastExecutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], 'max' => 100, 'min' => 0, ], 'PlatformIdentifier' => [ 'type' => 'string', 'max' => 15, 'pattern' => '^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$', ], 'PolicyString' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '.*', ], 'PredefinedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'PredefinedMetricType' => [ 'shape' => 'String', ], ], ], 'PresignedDomainUrl' => [ 'type' => 'string', ], 'ProbabilityThresholdAttribute' => [ 'type' => 'double', ], 'ProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'ProcessingClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingEnvironmentKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'ProcessingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 100, ], 'ProcessingEnvironmentValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S\\s]*', ], 'ProcessingFeatureStoreOutput' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'ProcessingInput' => [ 'type' => 'structure', 'required' => [ 'InputName', ], 'members' => [ 'InputName' => [ 'shape' => 'String', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], 'S3Input' => [ 'shape' => 'ProcessingS3Input', ], 'DatasetDefinition' => [ 'shape' => 'DatasetDefinition', ], ], ], 'ProcessingInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingInput', ], 'max' => 10, 'min' => 0, ], 'ProcessingInstanceCount' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ProcessingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'ProcessingJob' => [ 'type' => 'structure', 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ProcessingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*', ], 'ProcessingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ProcessingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ProcessingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'ProcessingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingJobSummary', ], ], 'ProcessingJobSummary' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingJobArn', 'CreationTime', 'ProcessingJobStatus', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], ], ], 'ProcessingLocalPath' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ProcessingMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 777600, 'min' => 1, ], 'ProcessingOutput' => [ 'type' => 'structure', 'required' => [ 'OutputName', ], 'members' => [ 'OutputName' => [ 'shape' => 'String', ], 'S3Output' => [ 'shape' => 'ProcessingS3Output', ], 'FeatureStoreOutput' => [ 'shape' => 'ProcessingFeatureStoreOutput', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], ], ], 'ProcessingOutputConfig' => [ 'type' => 'structure', 'required' => [ 'Outputs', ], 'members' => [ 'Outputs' => [ 'shape' => 'ProcessingOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingOutput', ], 'max' => 10, 'min' => 0, ], 'ProcessingResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'ProcessingClusterConfig', ], ], ], 'ProcessingS3CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ProcessingS3DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'ProcessingS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', ], ], 'ProcessingS3Input' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3DataType' => [ 'shape' => 'ProcessingS3DataType', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'S3CompressionType' => [ 'shape' => 'ProcessingS3CompressionType', ], ], ], 'ProcessingS3InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'ProcessingS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', 'S3UploadMode', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'ProcessingS3UploadMode' => [ 'type' => 'string', 'enum' => [ 'Continuous', 'EndOfJob', ], ], 'ProcessingStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'ProcessingMaxRuntimeInSeconds', ], ], ], 'ProcessingVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 1, ], 'Processor' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'ProductId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ProductListings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ProductionVariant' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'InitialInstanceCount' => [ 'shape' => 'InitialTaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialVariantWeight' => [ 'shape' => 'VariantWeight', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'CoreDumpConfig' => [ 'shape' => 'ProductionVariantCoreDumpConfig', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'ProductionVariantVolumeSizeInGB', ], 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], 'EnableSSMAccess' => [ 'shape' => 'ProductionVariantSSMAccess', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantCoreDumpConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProductionVariantInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.12xlarge', 'ml.m5d.24xlarge', 'ml.c4.large', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.large', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.12xlarge', 'ml.r5.24xlarge', 'ml.r5d.large', 'ml.r5d.xlarge', 'ml.r5d.2xlarge', 'ml.r5d.4xlarge', 'ml.r5d.12xlarge', 'ml.r5d.24xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.dl1.24xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.p4d.24xlarge', 'ml.c7g.large', 'ml.c7g.xlarge', 'ml.c7g.2xlarge', 'ml.c7g.4xlarge', 'ml.c7g.8xlarge', 'ml.c7g.12xlarge', 'ml.c7g.16xlarge', 'ml.m6g.large', 'ml.m6g.xlarge', 'ml.m6g.2xlarge', 'ml.m6g.4xlarge', 'ml.m6g.8xlarge', 'ml.m6g.12xlarge', 'ml.m6g.16xlarge', 'ml.m6gd.large', 'ml.m6gd.xlarge', 'ml.m6gd.2xlarge', 'ml.m6gd.4xlarge', 'ml.m6gd.8xlarge', 'ml.m6gd.12xlarge', 'ml.m6gd.16xlarge', 'ml.c6g.large', 'ml.c6g.xlarge', 'ml.c6g.2xlarge', 'ml.c6g.4xlarge', 'ml.c6g.8xlarge', 'ml.c6g.12xlarge', 'ml.c6g.16xlarge', 'ml.c6gd.large', 'ml.c6gd.xlarge', 'ml.c6gd.2xlarge', 'ml.c6gd.4xlarge', 'ml.c6gd.8xlarge', 'ml.c6gd.12xlarge', 'ml.c6gd.16xlarge', 'ml.c6gn.large', 'ml.c6gn.xlarge', 'ml.c6gn.2xlarge', 'ml.c6gn.4xlarge', 'ml.c6gn.8xlarge', 'ml.c6gn.12xlarge', 'ml.c6gn.16xlarge', 'ml.r6g.large', 'ml.r6g.xlarge', 'ml.r6g.2xlarge', 'ml.r6g.4xlarge', 'ml.r6g.8xlarge', 'ml.r6g.12xlarge', 'ml.r6g.16xlarge', 'ml.r6gd.large', 'ml.r6gd.xlarge', 'ml.r6gd.2xlarge', 'ml.r6gd.4xlarge', 'ml.r6gd.8xlarge', 'ml.r6gd.12xlarge', 'ml.r6gd.16xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.inf2.xlarge', 'ml.inf2.8xlarge', 'ml.inf2.24xlarge', 'ml.inf2.48xlarge', 'ml.p5.48xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', ], ], 'ProductionVariantList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariant', ], 'max' => 10, 'min' => 1, ], 'ProductionVariantManagedInstanceScaling' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'ManagedInstanceScalingStatus', ], 'MinInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMinInstanceCount', ], 'MaxInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMaxInstanceCount', ], ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'RoutingStrategy', ], 'members' => [ 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'ProductionVariantSSMAccess' => [ 'type' => 'boolean', ], 'ProductionVariantServerlessConfig' => [ 'type' => 'structure', 'required' => [ 'MemorySizeInMB', 'MaxConcurrency', ], 'members' => [ 'MemorySizeInMB' => [ 'shape' => 'ServerlessMemorySizeInMB', ], 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'VariantStatus', ], 'StatusMessage' => [ 'shape' => 'VariantStatusMessage', ], 'StartTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProductionVariantStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantStatus', ], 'max' => 5, 'min' => 0, ], 'ProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantSummary', ], 'min' => 1, ], 'ProductionVariantVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 512, 'min' => 1, ], 'ProfilerConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'ProfilerRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'ProfilerRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProfilerRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'ProfilingIntervalInMilliseconds' => [ 'type' => 'long', ], 'ProfilingParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'ProfilingStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ProgrammingLang' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'Project' => [ 'type' => 'structure', 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'ProjectArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$', ], 'ProjectEntityName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'ProjectId' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ProjectSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ProjectSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ProjectStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'CreateInProgress', 'CreateCompleted', 'CreateFailed', 'DeleteInProgress', 'DeleteFailed', 'DeleteCompleted', 'UpdateInProgress', 'UpdateCompleted', 'UpdateFailed', ], ], 'ProjectSummary' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ProjectArn', 'ProjectId', 'CreationTime', 'ProjectStatus', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], ], ], 'ProjectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProjectSummary', ], ], 'PropertyNameHint' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '.*', ], 'PropertyNameQuery' => [ 'type' => 'structure', 'required' => [ 'PropertyNameHint', ], 'members' => [ 'PropertyNameHint' => [ 'shape' => 'PropertyNameHint', ], ], ], 'PropertyNameSuggestion' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'ResourcePropertyName', ], ], ], 'PropertyNameSuggestionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyNameSuggestion', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', 'pattern' => '.*', ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningParameterKey', ], 'Value' => [ 'shape' => 'ProvisioningParameterValue', ], ], ], 'ProvisioningParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'ProvisioningParameterValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'PublicWorkforceTaskPrice' => [ 'type' => 'structure', 'members' => [ 'AmountInUsd' => [ 'shape' => 'USD', ], ], ], 'PutModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ResourcePolicy', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'PutModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'QualityCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckStatistics' => [ 'shape' => 'String1024', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineStatistics' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'QueryFilters' => [ 'type' => 'structure', 'members' => [ 'Types' => [ 'shape' => 'QueryTypes', ], 'LineageTypes' => [ 'shape' => 'QueryLineageTypes', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedAfter' => [ 'shape' => 'Timestamp', ], 'Properties' => [ 'shape' => 'QueryProperties', ], ], ], 'QueryLineageMaxDepth' => [ 'type' => 'integer', 'max' => 10, ], 'QueryLineageMaxResults' => [ 'type' => 'integer', 'max' => 50, ], 'QueryLineageRequest' => [ 'type' => 'structure', 'members' => [ 'StartArns' => [ 'shape' => 'QueryLineageStartArns', ], 'Direction' => [ 'shape' => 'Direction', ], 'IncludeEdges' => [ 'shape' => 'Boolean', ], 'Filters' => [ 'shape' => 'QueryFilters', ], 'MaxDepth' => [ 'shape' => 'QueryLineageMaxDepth', ], 'MaxResults' => [ 'shape' => 'QueryLineageMaxResults', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageResponse' => [ 'type' => 'structure', 'members' => [ 'Vertices' => [ 'shape' => 'Vertices', ], 'Edges' => [ 'shape' => 'Edges', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageStartArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationEntityArn', ], 'max' => 1, 'min' => 0, ], 'QueryLineageTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageType', ], 'max' => 4, ], 'QueryProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'String256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 5, ], 'QueryTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String40', ], 'max' => 5, ], 'RSessionAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], ], ], 'RStudioServerProAccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'RStudioServerProAppSettings' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'RStudioServerProAccessStatus', ], 'UserGroup' => [ 'shape' => 'RStudioServerProUserGroup', ], ], ], 'RStudioServerProDomainSettings' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], ], ], 'RStudioServerProUserGroup' => [ 'type' => 'string', 'enum' => [ 'R_STUDIO_ADMIN', 'R_STUDIO_USER', ], ], 'RandomSeed' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'TaskCount', ], ], ], 'RealTimeInferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', 'InstanceType', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'RealTimeInferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeInferenceRecommendation', ], 'max' => 3, 'min' => 0, ], 'RealtimeInferenceInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantInstanceType', ], ], 'RecommendationFailureReason' => [ 'type' => 'string', ], 'RecommendationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*', ], 'RecommendationJobCompilationJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'RecommendationJobCompiledOutputConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputUri' => [ 'shape' => 'S3Uri', ], ], ], 'RecommendationJobContainerConfig' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'RecommendationJobFrameworkVersion', ], 'PayloadConfig' => [ 'shape' => 'RecommendationJobPayloadConfig', ], 'NearestModelName' => [ 'shape' => 'String', ], 'SupportedInstanceTypes' => [ 'shape' => 'RecommendationJobSupportedInstanceTypes', ], 'SupportedEndpointType' => [ 'shape' => 'RecommendationJobSupportedEndpointType', ], 'DataInputConfig' => [ 'shape' => 'RecommendationJobDataInputConfig', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'RecommendationJobSupportedResponseMIMETypes', ], ], ], 'RecommendationJobDataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'RecommendationJobDescription' => [ 'type' => 'string', 'max' => 128, ], 'RecommendationJobFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'RecommendationJobInferenceBenchmark' => [ 'type' => 'structure', 'required' => [ 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointMetrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'FailureReason' => [ 'shape' => 'RecommendationFailureReason', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'RecommendationJobInputConfig' => [ 'type' => 'structure', 'members' => [ 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'JobDurationInSeconds' => [ 'shape' => 'JobDurationInSeconds', ], 'TrafficPattern' => [ 'shape' => 'TrafficPattern', ], 'ResourceLimit' => [ 'shape' => 'RecommendationJobResourceLimit', ], 'EndpointConfigurations' => [ 'shape' => 'EndpointInputConfigurations', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ContainerConfig' => [ 'shape' => 'RecommendationJobContainerConfig', ], 'Endpoints' => [ 'shape' => 'Endpoints', ], 'VpcConfig' => [ 'shape' => 'RecommendationJobVpcConfig', ], ], ], 'RecommendationJobName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'RecommendationJobOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CompiledOutputConfig' => [ 'shape' => 'RecommendationJobCompiledOutputConfig', ], ], ], 'RecommendationJobPayloadConfig' => [ 'type' => 'structure', 'members' => [ 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'SupportedContentTypes' => [ 'shape' => 'RecommendationJobSupportedContentTypes', ], ], ], 'RecommendationJobResourceLimit' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTests' => [ 'shape' => 'MaxNumberOfTests', ], 'MaxParallelOfTests' => [ 'shape' => 'MaxParallelOfTests', ], ], ], 'RecommendationJobStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', 'DELETING', 'DELETED', ], ], 'RecommendationJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatencyThresholds' => [ 'shape' => 'ModelLatencyThresholds', ], 'FlatInvocations' => [ 'shape' => 'FlatInvocations', ], ], ], 'RecommendationJobSupportedContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'RecommendationJobSupportedContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedContentType', ], ], 'RecommendationJobSupportedEndpointType' => [ 'type' => 'string', 'enum' => [ 'RealTime', 'Serverless', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedResponseMIMEType', ], ], 'RecommendationJobType' => [ 'type' => 'string', 'enum' => [ 'Default', 'Advanced', ], ], 'RecommendationJobVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'RecommendationJobVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'RecommendationJobVpcSubnets', ], ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'RecommendationJobVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'RecommendationMetrics' => [ 'type' => 'structure', 'required' => [ 'CostPerHour', 'CostPerInference', 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'CostPerHour' => [ 'shape' => 'Float', ], 'CostPerInference' => [ 'shape' => 'Float', ], 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], 'CpuUtilization' => [ 'shape' => 'UtilizationMetric', ], 'MemoryUtilization' => [ 'shape' => 'UtilizationMetric', ], 'ModelSetupTime' => [ 'shape' => 'ModelSetupTime', ], ], ], 'RecommendationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'NOT_APPLICABLE', ], ], 'RecommendationStepType' => [ 'type' => 'string', 'enum' => [ 'BENCHMARK', ], ], 'RecordWrapper' => [ 'type' => 'string', 'enum' => [ 'None', 'RecordIO', ], ], 'RedshiftClusterId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatabase' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'Database', 'DbUser', 'QueryString', 'ClusterRoleArn', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'ClusterId' => [ 'shape' => 'RedshiftClusterId', ], 'Database' => [ 'shape' => 'RedshiftDatabase', ], 'DbUser' => [ 'shape' => 'RedshiftUserName', ], 'QueryString' => [ 'shape' => 'RedshiftQueryString', ], 'ClusterRoleArn' => [ 'shape' => 'RoleArn', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'RedshiftResultFormat', ], 'OutputCompression' => [ 'shape' => 'RedshiftResultCompressionType', ], ], ], 'RedshiftQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'RedshiftResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'GZIP', 'BZIP2', 'ZSTD', 'SNAPPY', ], ], 'RedshiftResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'CSV', ], ], 'RedshiftUserName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'RegisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ReleaseNotes' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'RemoteDebugConfig' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RemoteDebugConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RenderUiTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'Task', 'RoleArn', ], 'members' => [ 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Task' => [ 'shape' => 'RenderableTask', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'RenderUiTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'RenderedContent', 'Errors', ], 'members' => [ 'RenderedContent' => [ 'shape' => 'String', ], 'Errors' => [ 'shape' => 'RenderingErrorList', ], ], ], 'RenderableTask' => [ 'type' => 'structure', 'required' => [ 'Input', ], 'members' => [ 'Input' => [ 'shape' => 'TaskInput', ], ], ], 'RenderingError' => [ 'type' => 'structure', 'required' => [ 'Code', 'Message', ], 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'RenderingErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderingError', ], ], 'RepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'RepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryCredentialsProviderArn', ], 'members' => [ 'RepositoryCredentialsProviderArn' => [ 'shape' => 'RepositoryCredentialsProviderArn', ], ], ], 'RepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'RepositoryUrl' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$', ], 'ResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+', ], 'ResourceCatalog' => [ 'type' => 'structure', 'required' => [ 'ResourceCatalogArn', 'ResourceCatalogName', 'Description', 'CreationTime', ], 'members' => [ 'ResourceCatalogArn' => [ 'shape' => 'ResourceCatalogArn', ], 'ResourceCatalogName' => [ 'shape' => 'ResourceCatalogName', ], 'Description' => [ 'shape' => 'ResourceCatalogDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceCatalogArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*', ], 'ResourceCatalogDescription' => [ 'type' => 'string', 'max' => 256, ], 'ResourceCatalogList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCatalog', ], ], 'ResourceCatalogName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceCatalogSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ResourceCatalogSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ResourceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroups', ], ], ], 'ResourceConfigForUpdate' => [ 'type' => 'structure', 'required' => [ 'KeepAlivePeriodInSeconds', ], 'members' => [ 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 32, ], 'ResourceInUse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimits' => [ 'type' => 'structure', 'required' => [ 'MaxParallelTrainingJobs', ], 'members' => [ 'MaxNumberOfTrainingJobs' => [ 'shape' => 'MaxNumberOfTrainingJobs', ], 'MaxParallelTrainingJobs' => [ 'shape' => 'MaxParallelTrainingJobs', ], 'MaxRuntimeInSeconds' => [ 'shape' => 'HyperParameterTuningMaxRuntimeInSeconds', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourcePolicyString' => [ 'type' => 'string', 'max' => 20480, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'ResourcePropertyName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'ResourceSpec' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageArn' => [ 'shape' => 'ImageArn', ], 'SageMakerImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'SageMakerImageVersionAlias' => [ 'shape' => 'ImageVersionAlias', ], 'InstanceType' => [ 'shape' => 'AppInstanceType', ], 'LifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'TrainingJob', 'Experiment', 'ExperimentTrial', 'ExperimentTrialComponent', 'Endpoint', 'Model', 'ModelPackage', 'ModelPackageGroup', 'Pipeline', 'PipelineExecution', 'FeatureGroup', 'FeatureMetadata', 'Image', 'ImageVersion', 'Project', 'HyperParameterTuningJob', 'ModelCard', ], ], 'ResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'ResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResponseMIMEType', ], ], 'RetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'HomeEfsFileSystem' => [ 'shape' => 'RetentionType', ], ], ], 'RetentionType' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Delete', ], ], 'RetryPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'RetryPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'RetryStrategy' => [ 'type' => 'structure', 'required' => [ 'MaximumRetryAttempts', ], 'members' => [ 'MaximumRetryAttempts' => [ 'shape' => 'MaximumRetryAttempts', ], ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'RollingUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'MaximumBatchSize', 'WaitIntervalInSeconds', ], 'members' => [ 'MaximumBatchSize' => [ 'shape' => 'CapacitySize', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], 'RollbackMaximumBatchSize' => [ 'shape' => 'CapacitySize', ], ], ], 'RootAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'RoutingStrategy' => [ 'type' => 'string', 'enum' => [ 'LEAST_OUTSTANDING_REQUESTS', 'RANDOM', ], ], 'RuleConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'RuleEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'NoIssuesFound', 'IssuesFound', 'Error', 'Stopping', 'Stopped', ], ], 'RuleParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 100, 'min' => 0, ], 'S3DataDistribution' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'S3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'S3DataDistributionType' => [ 'shape' => 'S3DataDistribution', ], 'AttributeNames' => [ 'shape' => 'AttributeNames', ], 'InstanceGroupNames' => [ 'shape' => 'InstanceGroupNames', ], ], ], 'S3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'S3ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', 'CompressionType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3ModelUri', ], 'S3DataType' => [ 'shape' => 'S3ModelDataType', ], 'CompressionType' => [ 'shape' => 'ModelCompressionType', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'S3ModelDataType' => [ 'type' => 'string', 'enum' => [ 'S3Prefix', 'S3Object', ], ], 'S3ModelUri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3OutputPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3StorageConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ResolvedOutputS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SageMakerImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(?!^[.-])^([a-zA-Z0-9-_.]+)$', ], 'SageMakerImageVersionAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], 'SagemakerServicecatalogStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'SampleWeightAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SamplingPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ScalingPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'TargetTracking' => [ 'shape' => 'TargetTrackingScalingPolicyConfiguration', ], ], 'union' => true, ], 'ScalingPolicyMetric' => [ 'type' => 'structure', 'members' => [ 'InvocationsPerInstance' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'ScalingPolicyObjective' => [ 'type' => 'structure', 'members' => [ 'MinInvocationsPerMinute' => [ 'shape' => 'Integer', ], 'MaxInvocationsPerMinute' => [ 'shape' => 'Integer', ], ], ], 'ScheduleConfig' => [ 'type' => 'structure', 'required' => [ 'ScheduleExpression', ], 'members' => [ 'ScheduleExpression' => [ 'shape' => 'ScheduleExpression', ], 'DataAnalysisStartTime' => [ 'shape' => 'String', ], 'DataAnalysisEndTime' => [ 'shape' => 'String', ], ], ], 'ScheduleExpression' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ScheduleStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Failed', 'Scheduled', 'Stopped', ], ], 'SearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'NestedFilters' => [ 'shape' => 'NestedFiltersList', ], 'SubExpressions' => [ 'shape' => 'SearchExpressionList', ], 'Operator' => [ 'shape' => 'BooleanOperator', ], ], ], 'SearchExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchExpression', ], 'max' => 20, 'min' => 1, ], 'SearchRecord' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'Experiment' => [ 'shape' => 'Experiment', ], 'Trial' => [ 'shape' => 'Trial', ], 'TrialComponent' => [ 'shape' => 'TrialComponent', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ModelPackage' => [ 'shape' => 'ModelPackage', ], 'ModelPackageGroup' => [ 'shape' => 'ModelPackageGroup', ], 'Pipeline' => [ 'shape' => 'Pipeline', ], 'PipelineExecution' => [ 'shape' => 'PipelineExecution', ], 'FeatureGroup' => [ 'shape' => 'FeatureGroup', ], 'FeatureMetadata' => [ 'shape' => 'FeatureMetadata', ], 'Project' => [ 'shape' => 'Project', ], 'HyperParameterTuningJob' => [ 'shape' => 'HyperParameterTuningJobSearchEntity', ], 'ModelCard' => [ 'shape' => 'ModelCard', ], 'Model' => [ 'shape' => 'ModelDashboardModel', ], ], ], 'SearchRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SearchExpression' => [ 'shape' => 'SearchExpression', ], 'SortBy' => [ 'shape' => 'ResourcePropertyName', ], 'SortOrder' => [ 'shape' => 'SearchSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CrossAccountFilterOption' => [ 'shape' => 'CrossAccountFilterOption', ], 'VisibilityConditions' => [ 'shape' => 'VisibilityConditionsList', ], ], ], 'SearchResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SearchResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SearchResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchRecord', ], ], 'SearchSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'LaunchingMLInstances', 'PreparingTrainingStack', 'Downloading', 'DownloadingTrainingImage', 'Training', 'Uploading', 'Stopping', 'Stopped', 'MaxRuntimeExceeded', 'Completed', 'Failed', 'Interrupted', 'MaxWaitTimeExceeded', 'Updating', 'Restarting', 'Pending', ], ], 'SecondaryStatusTransition' => [ 'type' => 'structure', 'required' => [ 'Status', 'StartTime', ], 'members' => [ 'Status' => [ 'shape' => 'SecondaryStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'SecondaryStatusTransitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecondaryStatusTransition', ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, ], 'Seed' => [ 'type' => 'long', ], 'SelectedStep' => [ 'type' => 'structure', 'required' => [ 'StepName', ], 'members' => [ 'StepName' => [ 'shape' => 'String256', ], ], ], 'SelectedStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectedStep', ], 'max' => 50, 'min' => 1, ], 'SelectiveExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'SelectedSteps', ], 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'SelectedSteps' => [ 'shape' => 'SelectedStepList', ], ], ], 'SelectiveExecutionResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'FailureReason' => [ 'shape' => 'String256', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepFailureResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'ServerlessMaxConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServerlessMemorySizeInMB' => [ 'type' => 'integer', 'max' => 6144, 'min' => 1024, ], 'ServerlessProvisionedConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServiceCatalogEntityId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'ServiceCatalogProvisionedProductDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisionedProductStatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], ], ], 'ServiceCatalogProvisioningDetails' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'ProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'PathId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1800, ], 'ShadowModeConfig' => [ 'type' => 'structure', 'required' => [ 'SourceModelVariantName', 'ShadowModelVariants', ], 'members' => [ 'SourceModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'ShadowModelVariants' => [ 'shape' => 'ShadowModelVariantConfigList', ], ], ], 'ShadowModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ShadowModelVariantName', 'SamplingPercentage', ], 'members' => [ 'ShadowModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'SamplingPercentage' => [ 'shape' => 'Percentage', ], ], ], 'ShadowModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowModelVariantConfig', ], 'max' => 1, 'min' => 1, ], 'SharingSettings' => [ 'type' => 'structure', 'members' => [ 'NotebookOutputOption' => [ 'shape' => 'NotebookOutputOption', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'SharingType' => [ 'type' => 'string', 'enum' => [ 'Private', 'Shared', ], ], 'ShuffleConfig' => [ 'type' => 'structure', 'required' => [ 'Seed', ], 'members' => [ 'Seed' => [ 'shape' => 'Seed', ], ], ], 'SingleSignOnApplicationArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\\/[a-zA-Z0-9-_.]+\\/apl-[a-zA-Z0-9]+$', ], 'SingleSignOnUserIdentifier' => [ 'type' => 'string', 'pattern' => 'UserName', ], 'SkipModelValidation' => [ 'type' => 'string', 'enum' => [ 'All', 'None', ], ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+', ], 'SortActionsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortArtifactsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'SortAssociationsBy' => [ 'type' => 'string', 'enum' => [ 'SourceArn', 'DestinationArn', 'SourceType', 'DestinationType', 'CreationTime', ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortContextsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortInferenceExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortLineageGroupsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SortPipelineExecutionsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'PipelineExecutionArn', ], ], 'SortPipelinesBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialComponentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SourceAlgorithm' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'SourceAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAlgorithm', ], 'max' => 1, 'min' => 1, ], 'SourceAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'SourceAlgorithms', ], 'members' => [ 'SourceAlgorithms' => [ 'shape' => 'SourceAlgorithmList', ], ], ], 'SourceIpConfig' => [ 'type' => 'structure', 'required' => [ 'Cidrs', ], 'members' => [ 'Cidrs' => [ 'shape' => 'Cidrs', ], ], ], 'SourceType' => [ 'type' => 'string', 'max' => 128, ], 'SourceUri' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'SpaceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*', ], 'SpaceCodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'SpaceDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'SpaceSettingsSummary' => [ 'shape' => 'SpaceSettingsSummary', ], 'SpaceSharingSettingsSummary' => [ 'shape' => 'SpaceSharingSettingsSummary', ], 'OwnershipSettingsSummary' => [ 'shape' => 'OwnershipSettingsSummary', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'SpaceEbsVolumeSizeInGb' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'SpaceJupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'SpaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpaceDetails', ], ], 'SpaceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'SpaceSettings' => [ 'type' => 'structure', 'members' => [ 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'SpaceCodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'SpaceJupyterLabAppSettings', ], 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], 'CustomFileSystems' => [ 'shape' => 'CustomFileSystems', ], ], ], 'SpaceSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], ], ], 'SpaceSharingSettings' => [ 'type' => 'structure', 'required' => [ 'SharingType', ], 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSharingSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'SpaceStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'SpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'EbsStorageSettings' => [ 'shape' => 'EbsStorageSettings', ], ], ], 'SpawnRate' => [ 'type' => 'integer', 'min' => 0, ], 'SplitType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', 'RecordIO', 'TFRecord', ], ], 'StageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READYTODEPLOY', 'STARTING', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'Stairs' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], 'NumberOfSteps' => [ 'shape' => 'NumberOfSteps', ], 'UsersPerStep' => [ 'shape' => 'UsersPerStep', ], ], ], 'StartEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StartInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'StartInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StartMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StartNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StartPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'StartPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'Average', 'Minimum', 'Maximum', 'SampleCount', 'Sum', ], ], 'StatusDetails' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'StatusMessage' => [ 'type' => 'string', ], 'StepDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'StepDisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'StepName' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'StepStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'StopAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'StopCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'StopInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ModelVariantActions', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'ModelVariantActions' => [ 'shape' => 'ModelVariantActionMap', ], 'DesiredModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DesiredState' => [ 'shape' => 'InferenceExperimentStopDesiredState', ], 'Reason' => [ 'shape' => 'InferenceExperimentStatusReason', ], ], ], 'StopInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StopInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'StopLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'StopMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StopNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StopPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'StopPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StopProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'StopTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'StopTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'StoppingCondition' => [ 'type' => 'structure', 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MaxRuntimeInSeconds', ], 'MaxWaitTimeInSeconds' => [ 'shape' => 'MaxWaitTimeInSeconds', ], 'MaxPendingTimeInSeconds' => [ 'shape' => 'MaxPendingTimeInSeconds', ], ], ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'Standard', 'InMemory', ], ], 'String' => [ 'type' => 'string', ], 'String1024' => [ 'type' => 'string', 'max' => 1024, ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'String200' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.+', ], 'String256' => [ 'type' => 'string', 'max' => 256, ], 'String3072' => [ 'type' => 'string', 'max' => 3072, ], 'String40' => [ 'type' => 'string', 'max' => 40, ], 'String64' => [ 'type' => 'string', 'max' => 64, ], 'String8192' => [ 'type' => 'string', 'max' => 8192, ], 'StringParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'StudioLifecycleConfigAppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'CodeEditor', 'JupyterLab', ], ], 'StudioLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*', ], 'StudioLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'StudioLifecycleConfigDetails' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'StudioLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'StudioLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'StudioLifecycleConfigsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigDetails', ], ], 'StudioWebPortal' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'Subnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'SubscribedWorkteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MarketplaceTitle' => [ 'shape' => 'String200', ], 'SellerName' => [ 'shape' => 'String', ], 'MarketplaceDescription' => [ 'shape' => 'String200', ], 'ListingId' => [ 'shape' => 'String', ], ], ], 'SubscribedWorkteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscribedWorkteam', ], ], 'Success' => [ 'type' => 'boolean', ], 'SuggestionQuery' => [ 'type' => 'structure', 'members' => [ 'PropertyNameQuery' => [ 'shape' => 'PropertyNameQuery', ], ], ], 'TableFormat' => [ 'type' => 'string', 'enum' => [ 'Default', 'Glue', 'Iceberg', ], ], 'TableName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'TabularJobConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'CandidateGenerationConfig' => [ 'shape' => 'CandidateGenerationConfig', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'TabularResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'ProblemType' => [ 'shape' => 'ProblemType', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetAttributeName' => [ 'type' => 'string', 'min' => 1, ], 'TargetDevice' => [ 'type' => 'string', 'enum' => [ 'lambda', 'ml_m4', 'ml_m5', 'ml_m6g', 'ml_c4', 'ml_c5', 'ml_c6g', 'ml_p2', 'ml_p3', 'ml_g4dn', 'ml_inf1', 'ml_inf2', 'ml_trn1', 'ml_eia2', 'jetson_tx1', 'jetson_tx2', 'jetson_nano', 'jetson_xavier', 'rasp3b', 'rasp4b', 'imx8qm', 'deeplens', 'rk3399', 'rk3288', 'aisage', 'sbe_c', 'qcs605', 'qcs603', 'sitara_am57x', 'amba_cv2', 'amba_cv22', 'amba_cv25', 'x86_win32', 'x86_win64', 'coreml', 'jacinto_tda4vm', 'imx8mplus', ], ], 'TargetLabelColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetObjectiveMetricValue' => [ 'type' => 'float', ], 'TargetPlatform' => [ 'type' => 'structure', 'required' => [ 'Os', 'Arch', ], 'members' => [ 'Os' => [ 'shape' => 'TargetPlatformOs', ], 'Arch' => [ 'shape' => 'TargetPlatformArch', ], 'Accelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], ], ], 'TargetPlatformAccelerator' => [ 'type' => 'string', 'enum' => [ 'INTEL_GRAPHICS', 'MALI', 'NVIDIA', 'NNA', ], ], 'TargetPlatformArch' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'X86', 'ARM64', 'ARM_EABI', 'ARM_EABIHF', ], ], 'TargetPlatformOs' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'LINUX', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'type' => 'structure', 'members' => [ 'MetricSpecification' => [ 'shape' => 'MetricSpecification', ], 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 60, ], 'TaskCount' => [ 'type' => 'integer', 'min' => 0, ], 'TaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'TaskInput' => [ 'type' => 'string', 'max' => 128000, 'min' => 2, 'pattern' => '[\\S\\s]+', ], 'TaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'TaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskKeyword', ], 'max' => 5, 'min' => 1, ], 'TaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'TaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'TemplateContent' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'TemplateContentSha256' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, ], 'TemplateUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TensorBoardAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'TensorBoardOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'TenthFractionsOfACent' => [ 'type' => 'integer', 'max' => 9, 'min' => 0, ], 'TerminationWaitInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'TextClassificationJobConfig' => [ 'type' => 'structure', 'required' => [ 'ContentColumn', 'TargetLabelColumn', ], 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ContentColumn' => [ 'shape' => 'ContentColumn', ], 'TargetLabelColumn' => [ 'shape' => 'TargetLabelColumn', ], ], ], 'TextGenerationHyperParameterKey' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameterValue' => [ 'type' => 'string', 'max' => 16, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TextGenerationHyperParameterKey', ], 'value' => [ 'shape' => 'TextGenerationHyperParameterValue', ], 'max' => 30, 'min' => 0, ], 'TextGenerationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'BaseModelName' => [ 'shape' => 'BaseModelName', ], 'TextGenerationHyperParameters' => [ 'shape' => 'TextGenerationHyperParameters', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'TextGenerationResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'BaseModelName' => [ 'shape' => 'BaseModelName', ], ], ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'ThroughputConfig' => [ 'type' => 'structure', 'required' => [ 'ThroughputMode', ], 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputConfigDescription' => [ 'type' => 'structure', 'required' => [ 'ThroughputMode', ], 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputMode' => [ 'type' => 'string', 'enum' => [ 'OnDemand', 'Provisioned', ], ], 'TimeSeriesConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', 'TimestampAttributeName', 'ItemIdentifierAttributeName', ], 'members' => [ 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'TimestampAttributeName' => [ 'shape' => 'TimestampAttributeName', ], 'ItemIdentifierAttributeName' => [ 'shape' => 'ItemIdentifierAttributeName', ], 'GroupingAttributeNames' => [ 'shape' => 'GroupingAttributeNames', ], ], ], 'TimeSeriesForecastingJobConfig' => [ 'type' => 'structure', 'required' => [ 'ForecastFrequency', 'ForecastHorizon', 'TimeSeriesConfig', ], 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ForecastFrequency' => [ 'shape' => 'ForecastFrequency', ], 'ForecastHorizon' => [ 'shape' => 'ForecastHorizon', ], 'ForecastQuantiles' => [ 'shape' => 'ForecastQuantiles', ], 'Transformations' => [ 'shape' => 'TimeSeriesTransformations', ], 'TimeSeriesConfig' => [ 'shape' => 'TimeSeriesConfig', ], 'HolidayConfig' => [ 'shape' => 'HolidayConfig', ], ], ], 'TimeSeriesForecastingSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'AmazonForecastRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'TimeSeriesTransformations' => [ 'type' => 'structure', 'members' => [ 'Filling' => [ 'shape' => 'FillingTransformations', ], 'Aggregation' => [ 'shape' => 'AggregationTransformations', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TimestampAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TrafficDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TrafficPattern' => [ 'type' => 'structure', 'members' => [ 'TrafficType' => [ 'shape' => 'TrafficType', ], 'Phases' => [ 'shape' => 'Phases', ], 'Stairs' => [ 'shape' => 'Stairs', ], ], ], 'TrafficRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'Type', 'WaitIntervalInSeconds', ], 'members' => [ 'Type' => [ 'shape' => 'TrafficRoutingConfigType', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'CanarySize' => [ 'shape' => 'CapacitySize', ], 'LinearStepSize' => [ 'shape' => 'CapacitySize', ], ], ], 'TrafficRoutingConfigType' => [ 'type' => 'string', 'enum' => [ 'ALL_AT_ONCE', 'CANARY', 'LINEAR', ], ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'PHASES', 'STAIRS', ], ], 'TrainingContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerArgument', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'TrainingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrainingEnvironmentKey', ], 'value' => [ 'shape' => 'TrainingEnvironmentValue', ], 'max' => 100, ], 'TrainingEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'TrainingImageConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryAccessMode', ], 'members' => [ 'TrainingRepositoryAccessMode' => [ 'shape' => 'TrainingRepositoryAccessMode', ], 'TrainingRepositoryAuthConfig' => [ 'shape' => 'TrainingRepositoryAuthConfig', ], ], ], 'TrainingInputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', 'FastFile', ], ], 'TrainingInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5n.xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.8xlarge', 'ml.c6i.4xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', ], ], 'TrainingInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInstanceType', ], ], 'TrainingJob' => [ 'type' => 'structure', 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TrainingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*', ], 'TrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', 'InputDataConfig', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], ], ], 'TrainingJobEarlyStoppingType' => [ 'type' => 'string', 'enum' => [ 'Off', 'Auto', ], ], 'TrainingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TrainingJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'TrainingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrainingJobStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingJobStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Completed' => [ 'shape' => 'TrainingJobStatusCounter', ], 'InProgress' => [ 'shape' => 'TrainingJobStatusCounter', ], 'RetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'NonRetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'Stopped' => [ 'shape' => 'TrainingJobStatusCounter', ], ], ], 'TrainingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'TrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingJobSummary', ], ], 'TrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'TrainingRepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'TrainingRepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryCredentialsProviderArn', ], 'members' => [ 'TrainingRepositoryCredentialsProviderArn' => [ 'shape' => 'TrainingRepositoryCredentialsProviderArn', ], ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*', ], 'TrainingSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingImage', 'SupportedTrainingInstanceTypes', 'TrainingChannels', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'ContainerImage', ], 'TrainingImageDigest' => [ 'shape' => 'ImageDigest', ], 'SupportedHyperParameters' => [ 'shape' => 'HyperParameterSpecifications', ], 'SupportedTrainingInstanceTypes' => [ 'shape' => 'TrainingInstanceTypes', ], 'SupportsDistributedTraining' => [ 'shape' => 'Boolean', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'TrainingChannels' => [ 'shape' => 'ChannelSpecifications', ], 'SupportedTuningJobObjectiveMetrics' => [ 'shape' => 'HyperParameterTuningJobObjectives', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'TrainingTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TransformDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'TransformS3DataSource', ], ], ], 'TransformEnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]{0,1023}', ], 'TransformEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformEnvironmentKey', ], 'value' => [ 'shape' => 'TransformEnvironmentValue', ], 'max' => 16, ], 'TransformEnvironmentValue' => [ 'type' => 'string', 'max' => 10240, 'pattern' => '[\\S\\s]*', ], 'TransformInput' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'TransformDataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'SplitType' => [ 'shape' => 'SplitType', ], ], ], 'TransformInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'TransformInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'TransformInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformInstanceType', ], 'min' => 1, ], 'TransformJob' => [ 'type' => 'structure', 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TransformJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*', ], 'TransformJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], ], ], 'TransformJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TransformJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TransformJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TransformJobArn', ], ], ], 'TransformJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformJobSummary', ], ], 'TransformJobSummary' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'CreationTime', 'TransformJobStatus', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'TransformOutput' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'Accept' => [ 'shape' => 'Accept', ], 'AssembleWith' => [ 'shape' => 'AssemblyType', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformResources' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TransformInstanceType', ], 'InstanceCount' => [ 'shape' => 'TransformInstanceCount', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'TransformationAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Trial' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSimpleSummaries', ], ], ], 'TrialArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*', ], 'TrialComponent' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'SourceDetail' => [ 'shape' => 'TrialComponentSourceDetail', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Parents' => [ 'shape' => 'Parents', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'TrialComponentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*', ], 'TrialComponentArtifact' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'MediaType' => [ 'shape' => 'MediaType', ], 'Value' => [ 'shape' => 'TrialComponentArtifactValue', ], ], ], 'TrialComponentArtifactValue' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'TrialComponentArtifacts' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey128', ], 'value' => [ 'shape' => 'TrialComponentArtifact', ], 'max' => 60, ], 'TrialComponentKey128' => [ 'type' => 'string', 'max' => 128, 'pattern' => '.*', ], 'TrialComponentKey256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrialComponentKey320' => [ 'type' => 'string', 'max' => 320, 'pattern' => '.*', ], 'TrialComponentMetricSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentMetricSummary', ], ], 'TrialComponentMetricSummary' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TimeStamp' => [ 'shape' => 'Timestamp', ], 'Max' => [ 'shape' => 'OptionalDouble', ], 'Min' => [ 'shape' => 'OptionalDouble', ], 'Last' => [ 'shape' => 'OptionalDouble', ], 'Count' => [ 'shape' => 'OptionalInteger', ], 'Avg' => [ 'shape' => 'OptionalDouble', ], 'StdDev' => [ 'shape' => 'OptionalDouble', ], ], ], 'TrialComponentParameterValue' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'StringParameterValue', ], 'NumberValue' => [ 'shape' => 'DoubleParameterValue', ], ], ], 'TrialComponentParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey320', ], 'value' => [ 'shape' => 'TrialComponentParameterValue', ], 'max' => 300, ], 'TrialComponentPrimaryStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrialComponentSimpleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSimpleSummary', ], ], 'TrialComponentSimpleSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialComponentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialComponentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialComponentSourceDetail' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJob', ], 'TransformJob' => [ 'shape' => 'TransformJob', ], ], ], 'TrialComponentSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSource', ], ], 'TrialComponentStatus' => [ 'type' => 'structure', 'members' => [ 'PrimaryStatus' => [ 'shape' => 'TrialComponentPrimaryStatus', ], 'Message' => [ 'shape' => 'TrialComponentStatusMessage', ], ], ], 'TrialComponentStatusMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'TrialComponentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSummary', ], ], 'TrialComponentSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialSummary', ], ], 'TrialSummary' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialSource' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TtlDuration' => [ 'type' => 'structure', 'members' => [ 'Unit' => [ 'shape' => 'TtlDurationUnit', ], 'Value' => [ 'shape' => 'TtlDurationValue', ], ], ], 'TtlDurationUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', ], ], 'TtlDurationValue' => [ 'type' => 'integer', 'min' => 1, ], 'TuningJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'TargetObjectiveMetricValue' => [ 'shape' => 'TargetObjectiveMetricValue', ], 'BestObjectiveNotImproving' => [ 'shape' => 'BestObjectiveNotImproving', ], 'ConvergenceDetected' => [ 'shape' => 'ConvergenceDetected', ], ], ], 'TuningJobStepMetaData' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'USD' => [ 'type' => 'structure', 'members' => [ 'Dollars' => [ 'shape' => 'Dollars', ], 'Cents' => [ 'shape' => 'Cents', ], 'TenthFractionsOfACent' => [ 'shape' => 'TenthFractionsOfACent', ], ], ], 'UiConfig' => [ 'type' => 'structure', 'members' => [ 'UiTemplateS3Uri' => [ 'shape' => 'S3Uri', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'UiTemplate' => [ 'type' => 'structure', 'required' => [ 'Content', ], 'members' => [ 'Content' => [ 'shape' => 'TemplateContent', ], ], ], 'UiTemplateInfo' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'TemplateUrl', ], 'ContentSha256' => [ 'shape' => 'TemplateContentSha256', ], ], ], 'Uid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 10000, ], 'UpdateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'UpdateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'UpdateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'UpdateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'UpdateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], ], ], 'UpdateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'UpdateClusterSoftwareRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'UpdateClusterSoftwareResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'UpdateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfigForUpdate', ], ], ], 'UpdateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'UpdateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'UpdateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'UpdateDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], ], ], 'UpdateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettingsForUpdate' => [ 'shape' => 'DomainSettingsForUpdate', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], ], ], 'UpdateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], ], ], 'UpdateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'RetainAllVariantProperties' => [ 'shape' => 'Boolean', ], 'ExcludeRetainedVariantProperties' => [ 'shape' => 'VariantPropertyList', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'RetainDeploymentConfig' => [ 'shape' => 'Boolean', ], ], ], 'UpdateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'DesiredWeightsAndCapacities', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'DesiredWeightsAndCapacities' => [ 'shape' => 'DesiredWeightAndCapacityList', ], ], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], ], ], 'UpdateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'UpdateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureAdditions' => [ 'shape' => 'FeatureAdditions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfigUpdate', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfigUpdate', ], ], ], 'UpdateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'UpdateFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'ParameterAdditions' => [ 'shape' => 'FeatureParameterAdditions', ], 'ParameterRemovals' => [ 'shape' => 'FeatureParameterRemovals', ], ], ], 'UpdateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], ], ], 'UpdateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'UpdateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'DeleteProperties' => [ 'shape' => 'ImageDeletePropertyList', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'UpdateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'AliasesToAdd' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'AliasesToDelete' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'UpdateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'UpdateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'DesiredRuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'DesiredRuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], ], ], 'UpdateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'UpdateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], ], ], 'UpdateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'UpdateModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'CustomerMetadataPropertiesToRemove' => [ 'shape' => 'CustomerMetadataKeyList', ], 'AdditionalInferenceSpecificationsToAdd' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], ], ], 'UpdateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'UpdateMonitoringAlertRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'DatapointsToAlert', 'EvaluationPeriod', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], ], ], 'UpdateMonitoringAlertResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], ], ], 'UpdateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], ], ], 'UpdateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'UpdateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DisassociateLifecycleConfig' => [ 'shape' => 'DisassociateNotebookInstanceLifecycleConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DisassociateAcceleratorTypes' => [ 'shape' => 'DisassociateNotebookInstanceAcceleratorTypes', ], 'DisassociateDefaultCodeRepository' => [ 'shape' => 'DisassociateDefaultCodeRepository', ], 'DisassociateAdditionalCodeRepositories' => [ 'shape' => 'DisassociateAdditionalCodeRepositories', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'UpdateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'shape' => 'ServiceCatalogProvisioningUpdateDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], ], ], 'UpdateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'UpdateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'UpdateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfigForUpdate', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfigForUpdate', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfigForUpdate', ], ], ], 'UpdateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'UpdateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'ParametersToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'InputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], ], ], 'UpdateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'UpdateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'UpdateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'UpdateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'UpdateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'UpdateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'UpdateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'UpdateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'UpdateWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Url' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'UserContext' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'String', ], 'UserProfileName' => [ 'shape' => 'String', ], 'DomainId' => [ 'shape' => 'String', ], 'IamIdentity' => [ 'shape' => 'IamIdentity', ], ], ], 'UserProfileArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*', ], 'UserProfileDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'UserProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProfileDetails', ], ], 'UserProfileName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'UserProfileSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'UserProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'UserSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'SharingSettings' => [ 'shape' => 'SharingSettings', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'TensorBoardAppSettings' => [ 'shape' => 'TensorBoardAppSettings', ], 'RStudioServerProAppSettings' => [ 'shape' => 'RStudioServerProAppSettings', ], 'RSessionAppSettings' => [ 'shape' => 'RSessionAppSettings', ], 'CanvasAppSettings' => [ 'shape' => 'CanvasAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'CodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'JupyterLabAppSettings', ], 'SpaceStorageSettings' => [ 'shape' => 'DefaultSpaceStorageSettings', ], 'DefaultLandingUri' => [ 'shape' => 'LandingUri', ], 'StudioWebPortal' => [ 'shape' => 'StudioWebPortal', ], 'CustomPosixUserConfig' => [ 'shape' => 'CustomPosixUserConfig', ], 'CustomFileSystemConfigs' => [ 'shape' => 'CustomFileSystemConfigs', ], ], ], 'UsersPerStep' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'UtilizationMetric' => [ 'type' => 'float', 'min' => 0.0, ], 'UtilizationPercentagePerCore' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ValidationFraction' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'VariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'VariantProperty' => [ 'type' => 'structure', 'required' => [ 'VariantPropertyType', ], 'members' => [ 'VariantPropertyType' => [ 'shape' => 'VariantPropertyType', ], ], ], 'VariantPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantProperty', ], 'max' => 3, 'min' => 0, ], 'VariantPropertyType' => [ 'type' => 'string', 'enum' => [ 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig', ], ], 'VariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'Deleting', 'ActivatingTraffic', 'Baking', ], ], 'VariantStatusMessage' => [ 'type' => 'string', 'max' => 1024, ], 'VariantWeight' => [ 'type' => 'float', 'min' => 0, ], 'VectorConfig' => [ 'type' => 'structure', 'required' => [ 'Dimension', ], 'members' => [ 'Dimension' => [ 'shape' => 'Dimension', ], ], ], 'VendorGuidance' => [ 'type' => 'string', 'enum' => [ 'NOT_PROVIDED', 'STABLE', 'TO_BE_ARCHIVED', 'ARCHIVED', ], ], 'VersionId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'VersionedArnOrName' => [ 'type' => 'string', 'max' => 176, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AssociationEntityArn', ], 'Type' => [ 'shape' => 'String40', ], 'LineageType' => [ 'shape' => 'LineageType', ], ], ], 'Vertices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Vertex', ], ], 'VisibilityConditions' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'VisibilityConditionsKey', ], 'Value' => [ 'shape' => 'VisibilityConditionsValue', ], ], ], 'VisibilityConditionsKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VisibilityConditionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisibilityConditions', ], 'max' => 5, 'min' => 1, ], 'VisibilityConditionsValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VolumeSizeInGB' => [ 'type' => 'integer', 'min' => 1, ], 'VpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'Subnets', ], ], ], 'VpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'VpcOnlyTrustedAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'max' => 10, ], 'VpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WaitIntervalInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'WarmPoolResourceStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Terminated', 'Reused', 'InUse', ], ], 'WarmPoolStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'WarmPoolResourceStatus', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'shape' => 'ResourceRetainedBillableTimeInSeconds', ], 'ReusedByJob' => [ 'shape' => 'TrainingJobName', ], ], ], 'Workforce' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', 'WorkforceArn', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'SubDomain' => [ 'shape' => 'String', ], 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfigForResponse', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigResponse', ], 'Status' => [ 'shape' => 'WorkforceStatus', ], 'FailureReason' => [ 'shape' => 'WorkforceFailureReason', ], ], ], 'WorkforceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*', ], 'WorkforceFailureReason' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'WorkforceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$', ], 'WorkforceSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^sg-[0-9a-z]*$', ], 'WorkforceSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WorkforceStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Updating', 'Deleting', 'Failed', 'Active', ], ], 'WorkforceSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^subnet-[0-9a-z]*$', ], 'WorkforceSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSubnetId', ], 'max' => 16, 'min' => 1, ], 'WorkforceVpcConfigRequest' => [ 'type' => 'structure', 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], ], ], 'WorkforceVpcConfigResponse' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], 'VpcEndpointId' => [ 'shape' => 'WorkforceVpcEndpointId', ], ], ], 'WorkforceVpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'WorkforceVpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^vpc-[0-9a-z]*$', ], 'Workforces' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workforce', ], ], 'WorkspaceSettings' => [ 'type' => 'structure', 'members' => [ 'S3ArtifactPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'Workteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'WorkteamArn', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'ProductListingIds' => [ 'shape' => 'ProductListings', ], 'Description' => [ 'shape' => 'String200', ], 'SubDomain' => [ 'shape' => 'String', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'WorkteamArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*', ], 'WorkteamName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'Workteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workteam', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-07-24', 'endpointPrefix' => 'api.sagemaker', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'SageMaker', 'serviceFullName' => 'Amazon SageMaker Service', 'serviceId' => 'SageMaker', 'signatureVersion' => 'v4', 'signingName' => 'sagemaker', 'targetPrefix' => 'SageMaker', 'uid' => 'sagemaker-2017-07-24', ], 'operations' => [ 'AddAssociation' => [ 'name' => 'AddAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddAssociationRequest', ], 'output' => [ 'shape' => 'AddAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], ], 'AssociateTrialComponent' => [ 'name' => 'AssociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTrialComponentRequest', ], 'output' => [ 'shape' => 'AssociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'BatchDescribeModelPackage' => [ 'name' => 'BatchDescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDescribeModelPackageInput', ], 'output' => [ 'shape' => 'BatchDescribeModelPackageOutput', ], ], 'CreateAction' => [ 'name' => 'CreateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActionRequest', ], 'output' => [ 'shape' => 'CreateActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAlgorithm' => [ 'name' => 'CreateAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAlgorithmInput', ], 'output' => [ 'shape' => 'CreateAlgorithmOutput', ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateAppImageConfig' => [ 'name' => 'CreateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppImageConfigRequest', ], 'output' => [ 'shape' => 'CreateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateArtifact' => [ 'name' => 'CreateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateArtifactRequest', ], 'output' => [ 'shape' => 'CreateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJob' => [ 'name' => 'CreateAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobRequest', ], 'output' => [ 'shape' => 'CreateAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJobV2' => [ 'name' => 'CreateAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobV2Request', ], 'output' => [ 'shape' => 'CreateAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateCodeRepository' => [ 'name' => 'CreateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCodeRepositoryInput', ], 'output' => [ 'shape' => 'CreateCodeRepositoryOutput', ], ], 'CreateCompilationJob' => [ 'name' => 'CreateCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCompilationJobRequest', ], 'output' => [ 'shape' => 'CreateCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateContext' => [ 'name' => 'CreateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContextRequest', ], 'output' => [ 'shape' => 'CreateContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDataQualityJobDefinition' => [ 'name' => 'CreateDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateDeviceFleet' => [ 'name' => 'CreateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateEdgeDeploymentPlan' => [ 'name' => 'CreateEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'CreateEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgeDeploymentStage' => [ 'name' => 'CreateEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgePackagingJob' => [ 'name' => 'CreateEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgePackagingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpoint' => [ 'name' => 'CreateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointInput', ], 'output' => [ 'shape' => 'CreateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpointConfig' => [ 'name' => 'CreateEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointConfigInput', ], 'output' => [ 'shape' => 'CreateEndpointConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateExperiment' => [ 'name' => 'CreateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateExperimentRequest', ], 'output' => [ 'shape' => 'CreateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFeatureGroup' => [ 'name' => 'CreateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFeatureGroupRequest', ], 'output' => [ 'shape' => 'CreateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFlowDefinition' => [ 'name' => 'CreateFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFlowDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHub' => [ 'name' => 'CreateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHubRequest', ], 'output' => [ 'shape' => 'CreateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateHumanTaskUi' => [ 'name' => 'CreateHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHumanTaskUiRequest', ], 'output' => [ 'shape' => 'CreateHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHyperParameterTuningJob' => [ 'name' => 'CreateHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'CreateHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImage' => [ 'name' => 'CreateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageRequest', ], 'output' => [ 'shape' => 'CreateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImageVersion' => [ 'name' => 'CreateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageVersionRequest', ], 'output' => [ 'shape' => 'CreateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateInferenceComponent' => [ 'name' => 'CreateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceComponentInput', ], 'output' => [ 'shape' => 'CreateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceExperiment' => [ 'name' => 'CreateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'CreateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceRecommendationsJob' => [ 'name' => 'CreateInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'CreateInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateLabelingJob' => [ 'name' => 'CreateLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLabelingJobRequest', ], 'output' => [ 'shape' => 'CreateLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModel' => [ 'name' => 'CreateModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelInput', ], 'output' => [ 'shape' => 'CreateModelOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelBiasJobDefinition' => [ 'name' => 'CreateModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelCard' => [ 'name' => 'CreateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardRequest', ], 'output' => [ 'shape' => 'CreateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelCardExportJob' => [ 'name' => 'CreateModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardExportJobRequest', ], 'output' => [ 'shape' => 'CreateModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelExplainabilityJobDefinition' => [ 'name' => 'CreateModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelPackage' => [ 'name' => 'CreateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageInput', ], 'output' => [ 'shape' => 'CreateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelPackageGroup' => [ 'name' => 'CreateModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageGroupInput', ], 'output' => [ 'shape' => 'CreateModelPackageGroupOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelQualityJobDefinition' => [ 'name' => 'CreateModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateMonitoringSchedule' => [ 'name' => 'CreateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'CreateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateNotebookInstance' => [ 'name' => 'CreateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateNotebookInstanceLifecycleConfig' => [ 'name' => 'CreateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreatePresignedDomainUrl' => [ 'name' => 'CreatePresignedDomainUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedDomainUrlRequest', ], 'output' => [ 'shape' => 'CreatePresignedDomainUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'CreatePresignedNotebookInstanceUrl' => [ 'name' => 'CreatePresignedNotebookInstanceUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlInput', ], 'output' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlOutput', ], ], 'CreateProcessingJob' => [ 'name' => 'CreateProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProcessingJobRequest', ], 'output' => [ 'shape' => 'CreateProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectInput', ], 'output' => [ 'shape' => 'CreateProjectOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateSpace' => [ 'name' => 'CreateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSpaceRequest', ], 'output' => [ 'shape' => 'CreateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateStudioLifecycleConfig' => [ 'name' => 'CreateStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'CreateStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateTrainingJob' => [ 'name' => 'CreateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrainingJobRequest', ], 'output' => [ 'shape' => 'CreateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTransformJob' => [ 'name' => 'CreateTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransformJobRequest', ], 'output' => [ 'shape' => 'CreateTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTrial' => [ 'name' => 'CreateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialRequest', ], 'output' => [ 'shape' => 'CreateTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateTrialComponent' => [ 'name' => 'CreateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialComponentRequest', ], 'output' => [ 'shape' => 'CreateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateUserProfile' => [ 'name' => 'CreateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserProfileRequest', ], 'output' => [ 'shape' => 'CreateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateWorkforce' => [ 'name' => 'CreateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkforceRequest', ], 'output' => [ 'shape' => 'CreateWorkforceResponse', ], ], 'CreateWorkteam' => [ 'name' => 'CreateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkteamRequest', ], 'output' => [ 'shape' => 'CreateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeleteAction' => [ 'name' => 'DeleteAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActionRequest', ], 'output' => [ 'shape' => 'DeleteActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAlgorithm' => [ 'name' => 'DeleteAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlgorithmInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAppImageConfig' => [ 'name' => 'DeleteAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppImageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteArtifact' => [ 'name' => 'DeleteArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteArtifactRequest', ], 'output' => [ 'shape' => 'DeleteArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAssociation' => [ 'name' => 'DeleteAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAssociationRequest', ], 'output' => [ 'shape' => 'DeleteAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteCodeRepository' => [ 'name' => 'DeleteCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCodeRepositoryInput', ], ], 'DeleteCompilationJob' => [ 'name' => 'DeleteCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteContext' => [ 'name' => 'DeleteContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContextRequest', ], 'output' => [ 'shape' => 'DeleteContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDataQualityJobDefinition' => [ 'name' => 'DeleteDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDataQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDeviceFleet' => [ 'name' => 'DeleteDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteEdgeDeploymentPlan' => [ 'name' => 'DeleteEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentPlanRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEdgeDeploymentStage' => [ 'name' => 'DeleteEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEndpoint' => [ 'name' => 'DeleteEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointInput', ], ], 'DeleteEndpointConfig' => [ 'name' => 'DeleteEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointConfigInput', ], ], 'DeleteExperiment' => [ 'name' => 'DeleteExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteExperimentRequest', ], 'output' => [ 'shape' => 'DeleteExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFeatureGroup' => [ 'name' => 'DeleteFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFeatureGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFlowDefinition' => [ 'name' => 'DeleteFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHub' => [ 'name' => 'DeleteHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHubContent' => [ 'name' => 'DeleteHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubContentRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHumanTaskUi' => [ 'name' => 'DeleteHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DeleteHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHyperParameterTuningJob' => [ 'name' => 'DeleteHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHyperParameterTuningJobRequest', ], ], 'DeleteImage' => [ 'name' => 'DeleteImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageRequest', ], 'output' => [ 'shape' => 'DeleteImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImageVersion' => [ 'name' => 'DeleteImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageVersionRequest', ], 'output' => [ 'shape' => 'DeleteImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteInferenceComponent' => [ 'name' => 'DeleteInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceComponentInput', ], ], 'DeleteInferenceExperiment' => [ 'name' => 'DeleteInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DeleteInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModel' => [ 'name' => 'DeleteModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelInput', ], ], 'DeleteModelBiasJobDefinition' => [ 'name' => 'DeleteModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelBiasJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelCard' => [ 'name' => 'DeleteModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelCardRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelExplainabilityJobDefinition' => [ 'name' => 'DeleteModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelExplainabilityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelPackage' => [ 'name' => 'DeleteModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroup' => [ 'name' => 'DeleteModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroupPolicy' => [ 'name' => 'DeleteModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupPolicyInput', ], ], 'DeleteModelQualityJobDefinition' => [ 'name' => 'DeleteModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteMonitoringSchedule' => [ 'name' => 'DeleteMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteNotebookInstance' => [ 'name' => 'DeleteNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceInput', ], ], 'DeleteNotebookInstanceLifecycleConfig' => [ 'name' => 'DeleteNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceLifecycleConfigInput', ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteSpace' => [ 'name' => 'DeleteSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSpaceRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteStudioLifecycleConfig' => [ 'name' => 'DeleteStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioLifecycleConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsInput', ], 'output' => [ 'shape' => 'DeleteTagsOutput', ], ], 'DeleteTrial' => [ 'name' => 'DeleteTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialRequest', ], 'output' => [ 'shape' => 'DeleteTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteTrialComponent' => [ 'name' => 'DeleteTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialComponentRequest', ], 'output' => [ 'shape' => 'DeleteTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteUserProfile' => [ 'name' => 'DeleteUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteWorkforce' => [ 'name' => 'DeleteWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkforceRequest', ], 'output' => [ 'shape' => 'DeleteWorkforceResponse', ], ], 'DeleteWorkteam' => [ 'name' => 'DeleteWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkteamRequest', ], 'output' => [ 'shape' => 'DeleteWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeregisterDevices' => [ 'name' => 'DeregisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDevicesRequest', ], ], 'DescribeAction' => [ 'name' => 'DescribeAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActionRequest', ], 'output' => [ 'shape' => 'DescribeActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmInput', ], 'output' => [ 'shape' => 'DescribeAlgorithmOutput', ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAppImageConfig' => [ 'name' => 'DescribeAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppImageConfigRequest', ], 'output' => [ 'shape' => 'DescribeAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeArtifact' => [ 'name' => 'DescribeArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeArtifactRequest', ], 'output' => [ 'shape' => 'DescribeArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJob' => [ 'name' => 'DescribeAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobRequest', ], 'output' => [ 'shape' => 'DescribeAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJobV2' => [ 'name' => 'DescribeAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobV2Request', ], 'output' => [ 'shape' => 'DescribeAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCluster' => [ 'name' => 'DescribeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterRequest', ], 'output' => [ 'shape' => 'DescribeClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeClusterNode' => [ 'name' => 'DescribeClusterNode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterNodeRequest', ], 'output' => [ 'shape' => 'DescribeClusterNodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCodeRepository' => [ 'name' => 'DescribeCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCodeRepositoryInput', ], 'output' => [ 'shape' => 'DescribeCodeRepositoryOutput', ], ], 'DescribeCompilationJob' => [ 'name' => 'DescribeCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCompilationJobRequest', ], 'output' => [ 'shape' => 'DescribeCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeContext' => [ 'name' => 'DescribeContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContextRequest', ], 'output' => [ 'shape' => 'DescribeContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDataQualityJobDefinition' => [ 'name' => 'DescribeDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDevice' => [ 'name' => 'DescribeDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceRequest', ], 'output' => [ 'shape' => 'DescribeDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDeviceFleet' => [ 'name' => 'DescribeDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceFleetRequest', ], 'output' => [ 'shape' => 'DescribeDeviceFleetResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgeDeploymentPlan' => [ 'name' => 'DescribeEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'DescribeEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgePackagingJob' => [ 'name' => 'DescribeEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgePackagingJobRequest', ], 'output' => [ 'shape' => 'DescribeEdgePackagingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointInput', ], 'output' => [ 'shape' => 'DescribeEndpointOutput', ], ], 'DescribeEndpointConfig' => [ 'name' => 'DescribeEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointConfigInput', ], 'output' => [ 'shape' => 'DescribeEndpointConfigOutput', ], ], 'DescribeExperiment' => [ 'name' => 'DescribeExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExperimentRequest', ], 'output' => [ 'shape' => 'DescribeExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureGroup' => [ 'name' => 'DescribeFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureGroupRequest', ], 'output' => [ 'shape' => 'DescribeFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureMetadata' => [ 'name' => 'DescribeFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureMetadataRequest', ], 'output' => [ 'shape' => 'DescribeFeatureMetadataResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFlowDefinition' => [ 'name' => 'DescribeFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHub' => [ 'name' => 'DescribeHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubRequest', ], 'output' => [ 'shape' => 'DescribeHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHubContent' => [ 'name' => 'DescribeHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubContentRequest', ], 'output' => [ 'shape' => 'DescribeHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHumanTaskUi' => [ 'name' => 'DescribeHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DescribeHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHyperParameterTuningJob' => [ 'name' => 'DescribeHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'DescribeHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImage' => [ 'name' => 'DescribeImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageRequest', ], 'output' => [ 'shape' => 'DescribeImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImageVersion' => [ 'name' => 'DescribeImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageVersionRequest', ], 'output' => [ 'shape' => 'DescribeImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceComponent' => [ 'name' => 'DescribeInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceComponentInput', ], 'output' => [ 'shape' => 'DescribeInferenceComponentOutput', ], ], 'DescribeInferenceExperiment' => [ 'name' => 'DescribeInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DescribeInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceRecommendationsJob' => [ 'name' => 'DescribeInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'DescribeInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLabelingJob' => [ 'name' => 'DescribeLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLabelingJobRequest', ], 'output' => [ 'shape' => 'DescribeLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLineageGroup' => [ 'name' => 'DescribeLineageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLineageGroupRequest', ], 'output' => [ 'shape' => 'DescribeLineageGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModel' => [ 'name' => 'DescribeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelInput', ], 'output' => [ 'shape' => 'DescribeModelOutput', ], ], 'DescribeModelBiasJobDefinition' => [ 'name' => 'DescribeModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCard' => [ 'name' => 'DescribeModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardRequest', ], 'output' => [ 'shape' => 'DescribeModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCardExportJob' => [ 'name' => 'DescribeModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardExportJobRequest', ], 'output' => [ 'shape' => 'DescribeModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelExplainabilityJobDefinition' => [ 'name' => 'DescribeModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelPackage' => [ 'name' => 'DescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageInput', ], 'output' => [ 'shape' => 'DescribeModelPackageOutput', ], ], 'DescribeModelPackageGroup' => [ 'name' => 'DescribeModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageGroupInput', ], 'output' => [ 'shape' => 'DescribeModelPackageGroupOutput', ], ], 'DescribeModelQualityJobDefinition' => [ 'name' => 'DescribeModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeMonitoringSchedule' => [ 'name' => 'DescribeMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'DescribeMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeNotebookInstance' => [ 'name' => 'DescribeNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceOutput', ], ], 'DescribeNotebookInstanceLifecycleConfig' => [ 'name' => 'DescribeNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigOutput', ], ], 'DescribePipeline' => [ 'name' => 'DescribePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineRequest', ], 'output' => [ 'shape' => 'DescribePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineDefinitionForExecution' => [ 'name' => 'DescribePipelineDefinitionForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineDefinitionForExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineDefinitionForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineExecution' => [ 'name' => 'DescribePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProcessingJob' => [ 'name' => 'DescribeProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProcessingJobRequest', ], 'output' => [ 'shape' => 'DescribeProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProject' => [ 'name' => 'DescribeProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProjectInput', ], 'output' => [ 'shape' => 'DescribeProjectOutput', ], ], 'DescribeSpace' => [ 'name' => 'DescribeSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpaceRequest', ], 'output' => [ 'shape' => 'DescribeSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStudioLifecycleConfig' => [ 'name' => 'DescribeStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'DescribeStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeSubscribedWorkteam' => [ 'name' => 'DescribeSubscribedWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSubscribedWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeSubscribedWorkteamResponse', ], ], 'DescribeTrainingJob' => [ 'name' => 'DescribeTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrainingJobRequest', ], 'output' => [ 'shape' => 'DescribeTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTransformJob' => [ 'name' => 'DescribeTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTransformJobRequest', ], 'output' => [ 'shape' => 'DescribeTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrial' => [ 'name' => 'DescribeTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialRequest', ], 'output' => [ 'shape' => 'DescribeTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrialComponent' => [ 'name' => 'DescribeTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialComponentRequest', ], 'output' => [ 'shape' => 'DescribeTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeUserProfile' => [ 'name' => 'DescribeUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserProfileRequest', ], 'output' => [ 'shape' => 'DescribeUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DescribeWorkforce' => [ 'name' => 'DescribeWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkforceRequest', ], 'output' => [ 'shape' => 'DescribeWorkforceResponse', ], ], 'DescribeWorkteam' => [ 'name' => 'DescribeWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeWorkteamResponse', ], ], 'DisableSagemakerServicecatalogPortfolio' => [ 'name' => 'DisableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioOutput', ], ], 'DisassociateTrialComponent' => [ 'name' => 'DisassociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTrialComponentRequest', ], 'output' => [ 'shape' => 'DisassociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'EnableSagemakerServicecatalogPortfolio' => [ 'name' => 'EnableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioOutput', ], ], 'GetDeviceFleetReport' => [ 'name' => 'GetDeviceFleetReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceFleetReportRequest', ], 'output' => [ 'shape' => 'GetDeviceFleetReportResponse', ], ], 'GetLineageGroupPolicy' => [ 'name' => 'GetLineageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLineageGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetLineageGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetModelPackageGroupPolicy' => [ 'name' => 'GetModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'GetModelPackageGroupPolicyOutput', ], ], 'GetSagemakerServicecatalogPortfolioStatus' => [ 'name' => 'GetSagemakerServicecatalogPortfolioStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusInput', ], 'output' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusOutput', ], ], 'GetScalingConfigurationRecommendation' => [ 'name' => 'GetScalingConfigurationRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetScalingConfigurationRecommendationRequest', ], 'output' => [ 'shape' => 'GetScalingConfigurationRecommendationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetSearchSuggestions' => [ 'name' => 'GetSearchSuggestions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSearchSuggestionsRequest', ], 'output' => [ 'shape' => 'GetSearchSuggestionsResponse', ], ], 'ImportHubContent' => [ 'name' => 'ImportHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportHubContentRequest', ], 'output' => [ 'shape' => 'ImportHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListActions' => [ 'name' => 'ListActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActionsRequest', ], 'output' => [ 'shape' => 'ListActionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAlgorithms' => [ 'name' => 'ListAlgorithms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAlgorithmsInput', ], 'output' => [ 'shape' => 'ListAlgorithmsOutput', ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAppImageConfigs' => [ 'name' => 'ListAppImageConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppImageConfigsRequest', ], 'output' => [ 'shape' => 'ListAppImageConfigsResponse', ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAssociations' => [ 'name' => 'ListAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAssociationsRequest', ], 'output' => [ 'shape' => 'ListAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAutoMLJobs' => [ 'name' => 'ListAutoMLJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAutoMLJobsRequest', ], 'output' => [ 'shape' => 'ListAutoMLJobsResponse', ], ], 'ListCandidatesForAutoMLJob' => [ 'name' => 'ListCandidatesForAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCandidatesForAutoMLJobRequest', ], 'output' => [ 'shape' => 'ListCandidatesForAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusterNodes' => [ 'name' => 'ListClusterNodes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClusterNodesRequest', ], 'output' => [ 'shape' => 'ListClusterNodesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], ], 'ListCodeRepositories' => [ 'name' => 'ListCodeRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCodeRepositoriesInput', ], 'output' => [ 'shape' => 'ListCodeRepositoriesOutput', ], ], 'ListCompilationJobs' => [ 'name' => 'ListCompilationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCompilationJobsRequest', ], 'output' => [ 'shape' => 'ListCompilationJobsResponse', ], ], 'ListContexts' => [ 'name' => 'ListContexts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContextsRequest', ], 'output' => [ 'shape' => 'ListContextsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListDataQualityJobDefinitions' => [ 'name' => 'ListDataQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDataQualityJobDefinitionsResponse', ], ], 'ListDeviceFleets' => [ 'name' => 'ListDeviceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceFleetsRequest', ], 'output' => [ 'shape' => 'ListDeviceFleetsResponse', ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResponse', ], ], 'ListEdgeDeploymentPlans' => [ 'name' => 'ListEdgeDeploymentPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgeDeploymentPlansRequest', ], 'output' => [ 'shape' => 'ListEdgeDeploymentPlansResponse', ], ], 'ListEdgePackagingJobs' => [ 'name' => 'ListEdgePackagingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgePackagingJobsRequest', ], 'output' => [ 'shape' => 'ListEdgePackagingJobsResponse', ], ], 'ListEndpointConfigs' => [ 'name' => 'ListEndpointConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointConfigsInput', ], 'output' => [ 'shape' => 'ListEndpointConfigsOutput', ], ], 'ListEndpoints' => [ 'name' => 'ListEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointsInput', ], 'output' => [ 'shape' => 'ListEndpointsOutput', ], ], 'ListExperiments' => [ 'name' => 'ListExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExperimentsRequest', ], 'output' => [ 'shape' => 'ListExperimentsResponse', ], ], 'ListFeatureGroups' => [ 'name' => 'ListFeatureGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFeatureGroupsRequest', ], 'output' => [ 'shape' => 'ListFeatureGroupsResponse', ], ], 'ListFlowDefinitions' => [ 'name' => 'ListFlowDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFlowDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFlowDefinitionsResponse', ], ], 'ListHubContentVersions' => [ 'name' => 'ListHubContentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentVersionsRequest', ], 'output' => [ 'shape' => 'ListHubContentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubContents' => [ 'name' => 'ListHubContents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentsRequest', ], 'output' => [ 'shape' => 'ListHubContentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubs' => [ 'name' => 'ListHubs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubsRequest', ], 'output' => [ 'shape' => 'ListHubsResponse', ], ], 'ListHumanTaskUis' => [ 'name' => 'ListHumanTaskUis', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHumanTaskUisRequest', ], 'output' => [ 'shape' => 'ListHumanTaskUisResponse', ], ], 'ListHyperParameterTuningJobs' => [ 'name' => 'ListHyperParameterTuningJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHyperParameterTuningJobsRequest', ], 'output' => [ 'shape' => 'ListHyperParameterTuningJobsResponse', ], ], 'ListImageVersions' => [ 'name' => 'ListImageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImageVersionsRequest', ], 'output' => [ 'shape' => 'ListImageVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListImages' => [ 'name' => 'ListImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImagesRequest', ], 'output' => [ 'shape' => 'ListImagesResponse', ], ], 'ListInferenceComponents' => [ 'name' => 'ListInferenceComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceComponentsInput', ], 'output' => [ 'shape' => 'ListInferenceComponentsOutput', ], ], 'ListInferenceExperiments' => [ 'name' => 'ListInferenceExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceExperimentsRequest', ], 'output' => [ 'shape' => 'ListInferenceExperimentsResponse', ], ], 'ListInferenceRecommendationsJobSteps' => [ 'name' => 'ListInferenceRecommendationsJobSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobStepsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListInferenceRecommendationsJobs' => [ 'name' => 'ListInferenceRecommendationsJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobsResponse', ], ], 'ListLabelingJobs' => [ 'name' => 'ListLabelingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsResponse', ], ], 'ListLabelingJobsForWorkteam' => [ 'name' => 'ListLabelingJobsForWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsForWorkteamRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsForWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListLineageGroups' => [ 'name' => 'ListLineageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLineageGroupsRequest', ], 'output' => [ 'shape' => 'ListLineageGroupsResponse', ], ], 'ListModelBiasJobDefinitions' => [ 'name' => 'ListModelBiasJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelBiasJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelBiasJobDefinitionsResponse', ], ], 'ListModelCardExportJobs' => [ 'name' => 'ListModelCardExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardExportJobsRequest', ], 'output' => [ 'shape' => 'ListModelCardExportJobsResponse', ], ], 'ListModelCardVersions' => [ 'name' => 'ListModelCardVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardVersionsRequest', ], 'output' => [ 'shape' => 'ListModelCardVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListModelCards' => [ 'name' => 'ListModelCards', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardsRequest', ], 'output' => [ 'shape' => 'ListModelCardsResponse', ], ], 'ListModelExplainabilityJobDefinitions' => [ 'name' => 'ListModelExplainabilityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsResponse', ], ], 'ListModelMetadata' => [ 'name' => 'ListModelMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelMetadataRequest', ], 'output' => [ 'shape' => 'ListModelMetadataResponse', ], ], 'ListModelPackageGroups' => [ 'name' => 'ListModelPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackageGroupsInput', ], 'output' => [ 'shape' => 'ListModelPackageGroupsOutput', ], ], 'ListModelPackages' => [ 'name' => 'ListModelPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackagesInput', ], 'output' => [ 'shape' => 'ListModelPackagesOutput', ], ], 'ListModelQualityJobDefinitions' => [ 'name' => 'ListModelQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelQualityJobDefinitionsResponse', ], ], 'ListModels' => [ 'name' => 'ListModels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelsInput', ], 'output' => [ 'shape' => 'ListModelsOutput', ], ], 'ListMonitoringAlertHistory' => [ 'name' => 'ListMonitoringAlertHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertHistoryRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertHistoryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringAlerts' => [ 'name' => 'ListMonitoringAlerts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertsRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringExecutions' => [ 'name' => 'ListMonitoringExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringExecutionsRequest', ], 'output' => [ 'shape' => 'ListMonitoringExecutionsResponse', ], ], 'ListMonitoringSchedules' => [ 'name' => 'ListMonitoringSchedules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringSchedulesRequest', ], 'output' => [ 'shape' => 'ListMonitoringSchedulesResponse', ], ], 'ListNotebookInstanceLifecycleConfigs' => [ 'name' => 'ListNotebookInstanceLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsInput', ], 'output' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsOutput', ], ], 'ListNotebookInstances' => [ 'name' => 'ListNotebookInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstancesInput', ], 'output' => [ 'shape' => 'ListNotebookInstancesOutput', ], ], 'ListPipelineExecutionSteps' => [ 'name' => 'ListPipelineExecutionSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionStepsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineExecutions' => [ 'name' => 'ListPipelineExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineParametersForExecution' => [ 'name' => 'ListPipelineParametersForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineParametersForExecutionRequest', ], 'output' => [ 'shape' => 'ListPipelineParametersForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], ], 'ListProcessingJobs' => [ 'name' => 'ListProcessingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProcessingJobsRequest', ], 'output' => [ 'shape' => 'ListProcessingJobsResponse', ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsInput', ], 'output' => [ 'shape' => 'ListProjectsOutput', ], ], 'ListResourceCatalogs' => [ 'name' => 'ListResourceCatalogs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceCatalogsRequest', ], 'output' => [ 'shape' => 'ListResourceCatalogsResponse', ], ], 'ListSpaces' => [ 'name' => 'ListSpaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSpacesRequest', ], 'output' => [ 'shape' => 'ListSpacesResponse', ], ], 'ListStageDevices' => [ 'name' => 'ListStageDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStageDevicesRequest', ], 'output' => [ 'shape' => 'ListStageDevicesResponse', ], ], 'ListStudioLifecycleConfigs' => [ 'name' => 'ListStudioLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioLifecycleConfigsRequest', ], 'output' => [ 'shape' => 'ListStudioLifecycleConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'ListSubscribedWorkteams' => [ 'name' => 'ListSubscribedWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSubscribedWorkteamsRequest', ], 'output' => [ 'shape' => 'ListSubscribedWorkteamsResponse', ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsInput', ], 'output' => [ 'shape' => 'ListTagsOutput', ], ], 'ListTrainingJobs' => [ 'name' => 'ListTrainingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsResponse', ], ], 'ListTrainingJobsForHyperParameterTuningJob' => [ 'name' => 'ListTrainingJobsForHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTransformJobs' => [ 'name' => 'ListTransformJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTransformJobsRequest', ], 'output' => [ 'shape' => 'ListTransformJobsResponse', ], ], 'ListTrialComponents' => [ 'name' => 'ListTrialComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialComponentsRequest', ], 'output' => [ 'shape' => 'ListTrialComponentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTrials' => [ 'name' => 'ListTrials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialsRequest', ], 'output' => [ 'shape' => 'ListTrialsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListUserProfiles' => [ 'name' => 'ListUserProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserProfilesRequest', ], 'output' => [ 'shape' => 'ListUserProfilesResponse', ], ], 'ListWorkforces' => [ 'name' => 'ListWorkforces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkforcesRequest', ], 'output' => [ 'shape' => 'ListWorkforcesResponse', ], ], 'ListWorkteams' => [ 'name' => 'ListWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkteamsRequest', ], 'output' => [ 'shape' => 'ListWorkteamsResponse', ], ], 'PutModelPackageGroupPolicy' => [ 'name' => 'PutModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'PutModelPackageGroupPolicyOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'QueryLineage' => [ 'name' => 'QueryLineage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'QueryLineageRequest', ], 'output' => [ 'shape' => 'QueryLineageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RegisterDevices' => [ 'name' => 'RegisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDevicesRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'RenderUiTemplate' => [ 'name' => 'RenderUiTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenderUiTemplateRequest', ], 'output' => [ 'shape' => 'RenderUiTemplateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RetryPipelineExecution' => [ 'name' => 'RetryPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RetryPipelineExecutionRequest', ], 'output' => [ 'shape' => 'RetryPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'Search' => [ 'name' => 'Search', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchRequest', ], 'output' => [ 'shape' => 'SearchResponse', ], ], 'SendPipelineExecutionStepFailure' => [ 'name' => 'SendPipelineExecutionStepFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepFailureRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepFailureResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'SendPipelineExecutionStepSuccess' => [ 'name' => 'SendPipelineExecutionStepSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepSuccessRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepSuccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StartEdgeDeploymentStage' => [ 'name' => 'StartEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartEdgeDeploymentStageRequest', ], ], 'StartInferenceExperiment' => [ 'name' => 'StartInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StartInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StartMonitoringSchedule' => [ 'name' => 'StartMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StartNotebookInstance' => [ 'name' => 'StartNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookInstanceInput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartPipelineExecution' => [ 'name' => 'StartPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StartPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StopAutoMLJob' => [ 'name' => 'StopAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopAutoMLJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopCompilationJob' => [ 'name' => 'StopCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopEdgeDeploymentStage' => [ 'name' => 'StopEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgeDeploymentStageRequest', ], ], 'StopEdgePackagingJob' => [ 'name' => 'StopEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgePackagingJobRequest', ], ], 'StopHyperParameterTuningJob' => [ 'name' => 'StopHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopHyperParameterTuningJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceExperiment' => [ 'name' => 'StopInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StopInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceRecommendationsJob' => [ 'name' => 'StopInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceRecommendationsJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopLabelingJob' => [ 'name' => 'StopLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopLabelingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopMonitoringSchedule' => [ 'name' => 'StopMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopNotebookInstance' => [ 'name' => 'StopNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookInstanceInput', ], ], 'StopPipelineExecution' => [ 'name' => 'StopPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StopPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'StopProcessingJob' => [ 'name' => 'StopProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopProcessingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTrainingJob' => [ 'name' => 'StopTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTrainingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTransformJob' => [ 'name' => 'StopTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTransformJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAction' => [ 'name' => 'UpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateActionRequest', ], 'output' => [ 'shape' => 'UpdateActionResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAppImageConfig' => [ 'name' => 'UpdateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAppImageConfigRequest', ], 'output' => [ 'shape' => 'UpdateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateArtifact' => [ 'name' => 'UpdateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateArtifactRequest', ], 'output' => [ 'shape' => 'UpdateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateCluster' => [ 'name' => 'UpdateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterRequest', ], 'output' => [ 'shape' => 'UpdateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateClusterSoftware' => [ 'name' => 'UpdateClusterSoftware', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterSoftwareRequest', ], 'output' => [ 'shape' => 'UpdateClusterSoftwareResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateCodeRepository' => [ 'name' => 'UpdateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCodeRepositoryInput', ], 'output' => [ 'shape' => 'UpdateCodeRepositoryOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateContext' => [ 'name' => 'UpdateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContextRequest', ], 'output' => [ 'shape' => 'UpdateContextResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateDeviceFleet' => [ 'name' => 'UpdateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'UpdateDevices' => [ 'name' => 'UpdateDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicesRequest', ], ], 'UpdateDomain' => [ 'name' => 'UpdateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainRequest', ], 'output' => [ 'shape' => 'UpdateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateEndpoint' => [ 'name' => 'UpdateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointInput', ], 'output' => [ 'shape' => 'UpdateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateEndpointWeightsAndCapacities' => [ 'name' => 'UpdateEndpointWeightsAndCapacities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesInput', ], 'output' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateExperiment' => [ 'name' => 'UpdateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateExperimentRequest', ], 'output' => [ 'shape' => 'UpdateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureGroup' => [ 'name' => 'UpdateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureGroupRequest', ], 'output' => [ 'shape' => 'UpdateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateFeatureMetadata' => [ 'name' => 'UpdateFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureMetadataRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateHub' => [ 'name' => 'UpdateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateHubRequest', ], 'output' => [ 'shape' => 'UpdateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImage' => [ 'name' => 'UpdateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageRequest', ], 'output' => [ 'shape' => 'UpdateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImageVersion' => [ 'name' => 'UpdateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageVersionRequest', ], 'output' => [ 'shape' => 'UpdateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateInferenceComponent' => [ 'name' => 'UpdateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceComponentRuntimeConfig' => [ 'name' => 'UpdateInferenceComponentRuntimeConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceExperiment' => [ 'name' => 'UpdateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'UpdateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateModelCard' => [ 'name' => 'UpdateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelCardRequest', ], 'output' => [ 'shape' => 'UpdateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateModelPackage' => [ 'name' => 'UpdateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelPackageInput', ], 'output' => [ 'shape' => 'UpdateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateMonitoringAlert' => [ 'name' => 'UpdateMonitoringAlert', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringAlertRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringAlertResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMonitoringSchedule' => [ 'name' => 'UpdateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateNotebookInstance' => [ 'name' => 'UpdateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateNotebookInstanceLifecycleConfig' => [ 'name' => 'UpdateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdatePipelineExecution' => [ 'name' => 'UpdatePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineExecutionRequest', ], 'output' => [ 'shape' => 'UpdatePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectInput', ], 'output' => [ 'shape' => 'UpdateProjectOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateSpace' => [ 'name' => 'UpdateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSpaceRequest', ], 'output' => [ 'shape' => 'UpdateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrainingJob' => [ 'name' => 'UpdateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrainingJobRequest', ], 'output' => [ 'shape' => 'UpdateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateTrial' => [ 'name' => 'UpdateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialRequest', ], 'output' => [ 'shape' => 'UpdateTrialResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrialComponent' => [ 'name' => 'UpdateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialComponentRequest', ], 'output' => [ 'shape' => 'UpdateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateUserProfile' => [ 'name' => 'UpdateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserProfileRequest', ], 'output' => [ 'shape' => 'UpdateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateWorkforce' => [ 'name' => 'UpdateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkforceRequest', ], 'output' => [ 'shape' => 'UpdateWorkforceResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateWorkteam' => [ 'name' => 'UpdateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkteamRequest', ], 'output' => [ 'shape' => 'UpdateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], ], 'shapes' => [ 'Accept' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'AcceptEula' => [ 'type' => 'boolean', ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^\\d+$', ], 'ActionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*', ], 'ActionSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String64', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AddAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'AddAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'max' => 3, ], 'AdditionalInferenceSpecificationDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Containers', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'AdditionalInferenceSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalInferenceSpecificationDefinition', ], 'max' => 15, 'min' => 1, ], 'AdditionalS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AdditionalS3DataSourceDataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], ], ], 'AdditionalS3DataSourceDataType' => [ 'type' => 'string', 'enum' => [ 'S3Object', 'S3Prefix', ], ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'Version', 'AgentCount', ], 'members' => [ 'Version' => [ 'shape' => 'EdgeVersion', ], 'AgentCount' => [ 'shape' => 'Long', ], ], ], 'AgentVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersion', ], ], 'AggregationTransformationValue' => [ 'type' => 'string', 'enum' => [ 'sum', 'avg', 'first', 'min', 'max', ], ], 'AggregationTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'AggregationTransformationValue', ], 'max' => 50, 'min' => 1, ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'AlarmName' => [ 'shape' => 'AlarmName', ], ], ], 'AlarmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], 'max' => 10, 'min' => 1, ], 'AlarmName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?!\\s*$).+', ], 'AlgorithmArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$', ], 'AlgorithmImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'AlgorithmSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'AlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'EnableSageMakerMetricsTimeSeries' => [ 'shape' => 'Boolean', ], 'ContainerEntrypoint' => [ 'shape' => 'TrainingContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'TrainingContainerArguments', ], 'TrainingImageConfig' => [ 'shape' => 'TrainingImageConfig', ], ], ], 'AlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'AlgorithmStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ValidationStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], ], ], 'AlgorithmStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedAlgorithmStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'AlgorithmStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmStatusItem', ], ], 'AlgorithmSummary' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'AlgorithmStatus', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], ], ], 'AlgorithmSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmSummary', ], ], 'AlgorithmValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TrainingJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TrainingJobDefinition' => [ 'shape' => 'TrainingJobDefinition', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'AlgorithmValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmValidationProfile', ], 'max' => 1, 'min' => 1, ], 'AlgorithmValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'AlgorithmValidationProfiles', ], ], ], 'AnnotationConsolidationConfig' => [ 'type' => 'structure', 'required' => [ 'AnnotationConsolidationLambdaArn', ], 'members' => [ 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], ], ], 'AppArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*', ], 'AppDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'AppImageConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*', ], 'AppImageConfigDetails' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'AppImageConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppImageConfigDetails', ], ], 'AppImageConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppImageConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'AppInstanceType' => [ 'type' => 'string', 'enum' => [ 'system', 'ml.t3.micro', 'ml.t3.small', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.geospatial.interactive', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.p5.48xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r6i.large', 'ml.r6i.xlarge', 'ml.r6i.2xlarge', 'ml.r6i.4xlarge', 'ml.r6i.8xlarge', 'ml.r6i.12xlarge', 'ml.r6i.16xlarge', 'ml.r6i.24xlarge', 'ml.r6i.32xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', 'ml.m6id.large', 'ml.m6id.xlarge', 'ml.m6id.2xlarge', 'ml.m6id.4xlarge', 'ml.m6id.8xlarge', 'ml.m6id.12xlarge', 'ml.m6id.16xlarge', 'ml.m6id.24xlarge', 'ml.m6id.32xlarge', 'ml.c6id.large', 'ml.c6id.xlarge', 'ml.c6id.2xlarge', 'ml.c6id.4xlarge', 'ml.c6id.8xlarge', 'ml.c6id.12xlarge', 'ml.c6id.16xlarge', 'ml.c6id.24xlarge', 'ml.c6id.32xlarge', 'ml.r6id.large', 'ml.r6id.xlarge', 'ml.r6id.2xlarge', 'ml.r6id.4xlarge', 'ml.r6id.8xlarge', 'ml.r6id.12xlarge', 'ml.r6id.16xlarge', 'ml.r6id.24xlarge', 'ml.r6id.32xlarge', ], ], 'AppList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppDetails', ], ], 'AppManaged' => [ 'type' => 'boolean', ], 'AppName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppNetworkAccessType' => [ 'type' => 'string', 'enum' => [ 'PublicInternetOnly', 'VpcOnly', ], ], 'AppSecurityGroupManagement' => [ 'type' => 'string', 'enum' => [ 'Service', 'Customer', ], ], 'AppSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'AppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'ContainerArguments', ], ], ], 'AppStatus' => [ 'type' => 'string', 'enum' => [ 'Deleted', 'Deleting', 'Failed', 'InService', 'Pending', ], ], 'AppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'DetailedProfiler', 'TensorBoard', 'CodeEditor', 'JupyterLab', 'RStudioServerPro', 'RSessionGateway', 'Canvas', ], ], 'ApprovalDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'ArnOrName' => [ 'type' => 'string', 'max' => 170, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:artifact/.*', ], 'ArtifactDigest' => [ 'type' => 'string', 'pattern' => '^[\\w:]+$', ], 'ArtifactProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'ArtifactPropertyValue', ], 'max' => 30, ], 'ArtifactPropertyValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ArtifactSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceTypes' => [ 'shape' => 'ArtifactSourceTypes', ], ], ], 'ArtifactSourceIdType' => [ 'type' => 'string', 'enum' => [ 'MD5Hash', 'S3ETag', 'S3Version', 'Custom', ], ], 'ArtifactSourceType' => [ 'type' => 'structure', 'required' => [ 'SourceIdType', 'Value', ], 'members' => [ 'SourceIdType' => [ 'shape' => 'ArtifactSourceIdType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ArtifactSourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSourceType', ], ], 'ArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSummary', ], ], 'ArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssemblyType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', ], ], 'AssociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'AssociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'AssociationEdgeType' => [ 'type' => 'string', 'enum' => [ 'ContributedTo', 'AssociatedWith', 'DerivedFrom', 'Produced', 'SameAs', ], ], 'AssociationEntityArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*', ], 'AssociationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationSummary', ], ], 'AssociationSummary' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'SourceName' => [ 'shape' => 'ExperimentEntityName', ], 'DestinationName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'AsyncInferenceClientConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrentInvocationsPerInstance' => [ 'shape' => 'MaxConcurrentInvocationsPerInstance', ], ], ], 'AsyncInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'OutputConfig', ], 'members' => [ 'ClientConfig' => [ 'shape' => 'AsyncInferenceClientConfig', ], 'OutputConfig' => [ 'shape' => 'AsyncInferenceOutputConfig', ], ], ], 'AsyncInferenceNotificationConfig' => [ 'type' => 'structure', 'members' => [ 'SuccessTopic' => [ 'shape' => 'SnsTopicArn', ], 'ErrorTopic' => [ 'shape' => 'SnsTopicArn', ], 'IncludeInferenceResponseIn' => [ 'shape' => 'AsyncNotificationTopicTypeList', ], ], ], 'AsyncInferenceOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'DestinationS3Uri', ], 'NotificationConfig' => [ 'shape' => 'AsyncInferenceNotificationConfig', ], 'S3FailurePath' => [ 'shape' => 'DestinationS3Uri', ], ], ], 'AsyncNotificationTopicTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AsyncNotificationTopicTypes', ], 'max' => 2, 'min' => 0, ], 'AsyncNotificationTopicTypes' => [ 'type' => 'string', 'enum' => [ 'SUCCESS_NOTIFICATION_TOPIC', 'ERROR_NOTIFICATION_TOPIC', ], ], 'AthenaCatalog' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'AthenaDatabase' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'AthenaDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'Catalog', 'Database', 'QueryString', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'Catalog' => [ 'shape' => 'AthenaCatalog', ], 'Database' => [ 'shape' => 'AthenaDatabase', ], 'QueryString' => [ 'shape' => 'AthenaQueryString', ], 'WorkGroup' => [ 'shape' => 'AthenaWorkGroup', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'AthenaResultFormat', ], 'OutputCompression' => [ 'shape' => 'AthenaResultCompressionType', ], ], ], 'AthenaQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'AthenaResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'SNAPPY', 'ZLIB', ], ], 'AthenaResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'ORC', 'AVRO', 'JSON', 'TEXTFILE', ], ], 'AthenaWorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9._-]+', ], 'AttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.+', ], 'AttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeName', ], 'max' => 16, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoGenerateEndpointName' => [ 'type' => 'boolean', ], 'AutoMLAlgorithm' => [ 'type' => 'string', 'enum' => [ 'xgboost', 'linear-learner', 'mlp', 'lightgbm', 'catboost', 'randomforest', 'extra-trees', 'nn-torch', 'fastai', ], ], 'AutoMLAlgorithmConfig' => [ 'type' => 'structure', 'required' => [ 'AutoMLAlgorithms', ], 'members' => [ 'AutoMLAlgorithms' => [ 'shape' => 'AutoMLAlgorithms', ], ], ], 'AutoMLAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithm', ], 'max' => 11, ], 'AutoMLAlgorithmsConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithmConfig', ], 'max' => 1, ], 'AutoMLCandidate' => [ 'type' => 'structure', 'required' => [ 'CandidateName', 'ObjectiveStatus', 'CandidateSteps', 'CandidateStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CandidateName' => [ 'shape' => 'CandidateName', ], 'FinalAutoMLJobObjectiveMetric' => [ 'shape' => 'FinalAutoMLJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], 'CandidateSteps' => [ 'shape' => 'CandidateSteps', ], 'CandidateStatus' => [ 'shape' => 'CandidateStatus', ], 'InferenceContainers' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'CandidateProperties' => [ 'shape' => 'CandidateProperties', ], 'InferenceContainerDefinitions' => [ 'shape' => 'AutoMLInferenceContainerDefinitions', ], ], ], 'AutoMLCandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'AutoMLCandidateStep' => [ 'type' => 'structure', 'required' => [ 'CandidateStepType', 'CandidateStepArn', 'CandidateStepName', ], 'members' => [ 'CandidateStepType' => [ 'shape' => 'CandidateStepType', ], 'CandidateStepArn' => [ 'shape' => 'CandidateStepArn', ], 'CandidateStepName' => [ 'shape' => 'CandidateStepName', ], ], ], 'AutoMLCandidates' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidate', ], ], 'AutoMLChannel' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'AutoMLChannelType' => [ 'type' => 'string', 'enum' => [ 'training', 'validation', ], ], 'AutoMLContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', 'ModelDataUrl', ], 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'AutoMLContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLContainerDefinition', ], 'max' => 5, ], 'AutoMLDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'AutoMLS3DataSource', ], ], ], 'AutoMLDataSplitConfig' => [ 'type' => 'structure', 'members' => [ 'ValidationFraction' => [ 'shape' => 'ValidationFraction', ], ], ], 'AutoMLFailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'AutoMLInferenceContainerDefinitions' => [ 'type' => 'map', 'key' => [ 'shape' => 'AutoMLProcessingUnit', ], 'value' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'max' => 2, ], 'AutoMLInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*', ], 'AutoMLJobArtifacts' => [ 'type' => 'structure', 'members' => [ 'CandidateDefinitionNotebookLocation' => [ 'shape' => 'CandidateDefinitionNotebookLocation', ], 'DataExplorationNotebookLocation' => [ 'shape' => 'DataExplorationNotebookLocation', ], ], ], 'AutoMLJobChannel' => [ 'type' => 'structure', 'members' => [ 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], ], ], 'AutoMLJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'MaxCandidates' => [ 'shape' => 'MaxCandidates', ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'shape' => 'MaxRuntimePerTrainingJobInSeconds', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'shape' => 'MaxAutoMLJobRuntimeInSeconds', ], ], ], 'AutoMLJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'CandidateGenerationConfig' => [ 'shape' => 'AutoMLCandidateGenerationConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], ], ], 'AutoMLJobInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'AutoMLJobObjective' => [ 'type' => 'structure', 'required' => [ 'MetricName', ], 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'AutoMLJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'AutoMLJobSecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'MaxCandidatesReached', 'Failed', 'Stopped', 'MaxAutoMLJobRuntimeReached', 'Stopping', 'CandidateDefinitionsGenerated', 'Completed', 'ExplainabilityError', 'DeployingModel', 'ModelDeploymentError', 'GeneratingModelInsightsReport', 'ModelInsightsError', 'AnalyzingData', 'FeatureEngineering', 'ModelTuning', 'GeneratingExplainabilityReport', 'TrainingModels', 'PreTraining', ], ], 'AutoMLJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'AutoMLJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'AutoMLJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobSummary', ], ], 'AutoMLJobSummary' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], ], ], 'AutoMLMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'AutoMLMaxResultsForTrials' => [ 'type' => 'integer', 'max' => 300, 'min' => 1, ], 'AutoMLMetricEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'BalancedAccuracy', 'R2', 'Recall', 'RecallMacro', 'Precision', 'PrecisionMacro', 'MAE', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMetricExtendedEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'LogLoss', 'InferenceLatency', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', 'Rouge1', 'Rouge2', 'RougeL', 'RougeLSum', 'Perplexity', 'ValidationLoss', 'TrainingLoss', ], ], 'AutoMLMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'ENSEMBLING', 'HYPERPARAMETER_TUNING', ], ], 'AutoMLNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'AutoMLOutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLPartialFailureReason' => [ 'type' => 'structure', 'members' => [ 'PartialFailureMessage' => [ 'shape' => 'AutoMLFailureReason', ], ], ], 'AutoMLPartialFailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLPartialFailureReason', ], 'max' => 5, 'min' => 1, ], 'AutoMLProblemTypeConfig' => [ 'type' => 'structure', 'members' => [ 'ImageClassificationJobConfig' => [ 'shape' => 'ImageClassificationJobConfig', ], 'TextClassificationJobConfig' => [ 'shape' => 'TextClassificationJobConfig', ], 'TimeSeriesForecastingJobConfig' => [ 'shape' => 'TimeSeriesForecastingJobConfig', ], 'TabularJobConfig' => [ 'shape' => 'TabularJobConfig', ], 'TextGenerationJobConfig' => [ 'shape' => 'TextGenerationJobConfig', ], ], 'union' => true, ], 'AutoMLProblemTypeConfigName' => [ 'type' => 'string', 'enum' => [ 'ImageClassification', 'TextClassification', 'TimeSeriesForecasting', 'Tabular', 'TextGeneration', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'TabularResolvedAttributes' => [ 'shape' => 'TabularResolvedAttributes', ], 'TextGenerationResolvedAttributes' => [ 'shape' => 'TextGenerationResolvedAttributes', ], ], 'union' => true, ], 'AutoMLProcessingUnit' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'AutoMLResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'AutoMLProblemTypeResolvedAttributes' => [ 'shape' => 'AutoMLProblemTypeResolvedAttributes', ], ], ], 'AutoMLS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AutoMLS3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'AutoMLSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'AutoMLSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'AutoMLSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'AutoParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'ValueHint', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'ValueHint' => [ 'shape' => 'ParameterValue', ], ], ], 'AutoParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoParameter', ], 'max' => 100, 'min' => 0, ], 'AutoRollbackConfig' => [ 'type' => 'structure', 'members' => [ 'Alarms' => [ 'shape' => 'AlarmList', ], ], ], 'Autotune' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'AutotuneMode', ], ], ], 'AutotuneMode' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'type' => 'string', 'enum' => [ 'AWS/Rekognition/DetectModerationLabels/Image/V3', 'AWS/Textract/AnalyzeDocument/Forms/V1', ], ], 'BacktestResultsLocation' => [ 'type' => 'string', 'min' => 1, ], 'BaseModelName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'BatchDataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'GenerateInferenceId' => [ 'shape' => 'Boolean', ], ], ], 'BatchDescribeModelPackageError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'ErrorResponse', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorResponse' => [ 'shape' => 'String', ], ], ], 'BatchDescribeModelPackageErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageError', ], ], 'BatchDescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArnList', ], 'members' => [ 'ModelPackageArnList' => [ 'shape' => 'ModelPackageArnList', ], ], ], 'BatchDescribeModelPackageOutput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageSummaries' => [ 'shape' => 'ModelPackageSummaries', ], 'BatchDescribeModelPackageErrorMap' => [ 'shape' => 'BatchDescribeModelPackageErrorMap', ], ], ], 'BatchDescribeModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageArn', 'CreationTime', 'InferenceSpecification', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'BatchStrategy' => [ 'type' => 'string', 'enum' => [ 'MultiRecord', 'SingleRecord', ], ], 'BatchTransformInput' => [ 'type' => 'structure', 'required' => [ 'DataCapturedDestinationS3Uri', 'DatasetFormat', 'LocalPath', ], 'members' => [ 'DataCapturedDestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'DatasetFormat' => [ 'shape' => 'MonitoringDatasetFormat', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'BestObjectiveNotImproving' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTrainingJobsNotImproving' => [ 'shape' => 'MaxNumberOfTrainingJobsNotImproving', ], ], ], 'Bias' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], 'PreTrainingReport' => [ 'shape' => 'MetricsSource', ], 'PostTrainingReport' => [ 'shape' => 'MetricsSource', ], ], ], 'BillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'BlockedReason' => [ 'type' => 'string', 'max' => 1024, ], 'BlueGreenUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'TrafficRoutingConfiguration', ], 'members' => [ 'TrafficRoutingConfiguration' => [ 'shape' => 'TrafficRoutingConfig', ], 'TerminationWaitInSeconds' => [ 'shape' => 'TerminationWaitInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOperator' => [ 'type' => 'string', 'enum' => [ 'And', 'Or', ], ], 'Branch' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[^ ~^:?*\\[]+', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'CacheHitResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'CallbackStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'SqsQueueUrl' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'CallbackToken' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]+$', ], 'CandidateArtifactLocations' => [ 'type' => 'structure', 'required' => [ 'Explainability', ], 'members' => [ 'Explainability' => [ 'shape' => 'ExplainabilityLocation', ], 'ModelInsights' => [ 'shape' => 'ModelInsightsLocation', ], 'BacktestResults' => [ 'shape' => 'BacktestResultsLocation', ], ], ], 'CandidateDefinitionNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'CandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'CandidateName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateProperties' => [ 'type' => 'structure', 'members' => [ 'CandidateArtifactLocations' => [ 'shape' => 'CandidateArtifactLocations', ], 'CandidateMetrics' => [ 'shape' => 'MetricDataList', ], ], ], 'CandidateSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'CandidateStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'CandidateStepArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*', ], 'CandidateStepName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateStepType' => [ 'type' => 'string', 'enum' => [ 'AWS::SageMaker::TrainingJob', 'AWS::SageMaker::TransformJob', 'AWS::SageMaker::ProcessingJob', ], ], 'CandidateSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidateStep', ], ], 'CanvasAppSettings' => [ 'type' => 'structure', 'members' => [ 'TimeSeriesForecastingSettings' => [ 'shape' => 'TimeSeriesForecastingSettings', ], 'ModelRegisterSettings' => [ 'shape' => 'ModelRegisterSettings', ], 'WorkspaceSettings' => [ 'shape' => 'WorkspaceSettings', ], 'IdentityProviderOAuthSettings' => [ 'shape' => 'IdentityProviderOAuthSettings', ], 'DirectDeploySettings' => [ 'shape' => 'DirectDeploySettings', ], 'KendraSettings' => [ 'shape' => 'KendraSettings', ], 'GenerativeAiSettings' => [ 'shape' => 'GenerativeAiSettings', ], ], ], 'CapacitySize' => [ 'type' => 'structure', 'required' => [ 'Type', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'CapacitySizeType', ], 'Value' => [ 'shape' => 'CapacitySizeValue', ], ], ], 'CapacitySizeType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_COUNT', 'CAPACITY_PERCENT', ], ], 'CapacitySizeValue' => [ 'type' => 'integer', 'min' => 1, ], 'CapacityUnit' => [ 'type' => 'integer', 'max' => 10000000, 'min' => 0, ], 'CaptureContentTypeHeader' => [ 'type' => 'structure', 'members' => [ 'CsvContentTypes' => [ 'shape' => 'CsvContentTypes', ], 'JsonContentTypes' => [ 'shape' => 'JsonContentTypes', ], ], ], 'CaptureMode' => [ 'type' => 'string', 'enum' => [ 'Input', 'Output', 'InputAndOutput', ], ], 'CaptureOption' => [ 'type' => 'structure', 'required' => [ 'CaptureMode', ], 'members' => [ 'CaptureMode' => [ 'shape' => 'CaptureMode', ], ], ], 'CaptureOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptureOption', ], 'max' => 32, 'min' => 1, ], 'CaptureStatus' => [ 'type' => 'string', 'enum' => [ 'Started', 'Stopped', ], ], 'Catalog' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'CategoricalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String64', ], 'Value' => [ 'shape' => 'CategoricalParameterRangeValues', ], ], ], 'CategoricalParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String128', ], 'max' => 3, 'min' => 1, ], 'CategoricalParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameterRange', ], 'max' => 30, 'min' => 0, ], 'CategoricalParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameter', ], 'max' => 5, 'min' => 1, ], 'Cents' => [ 'type' => 'integer', 'max' => 99, 'min' => 0, ], 'CertifyForMarketplace' => [ 'type' => 'boolean', ], 'Channel' => [ 'type' => 'structure', 'required' => [ 'ChannelName', 'DataSource', ], 'members' => [ 'ChannelName' => [ 'shape' => 'ChannelName', ], 'DataSource' => [ 'shape' => 'DataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'RecordWrapperType' => [ 'shape' => 'RecordWrapper', ], 'InputMode' => [ 'shape' => 'TrainingInputMode', ], 'ShuffleConfig' => [ 'shape' => 'ShuffleConfig', ], ], ], 'ChannelName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9\\.\\-_]+', ], 'ChannelSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'SupportedContentTypes', 'SupportedInputModes', ], 'members' => [ 'Name' => [ 'shape' => 'ChannelName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedCompressionTypes' => [ 'shape' => 'CompressionTypes', ], 'SupportedInputModes' => [ 'shape' => 'InputModes', ], ], ], 'ChannelSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSpecification', ], 'max' => 8, 'min' => 1, ], 'CheckpointConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'Cidr' => [ 'type' => 'string', 'max' => 64, 'min' => 4, '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]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)', ], 'Cidrs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cidr', ], ], 'ClarifyCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'ClarifyContentTemplate' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyEnableExplanations' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyExplainerConfig' => [ 'type' => 'structure', 'required' => [ 'ShapConfig', ], 'members' => [ 'EnableExplanations' => [ 'shape' => 'ClarifyEnableExplanations', ], 'InferenceConfig' => [ 'shape' => 'ClarifyInferenceConfig', ], 'ShapConfig' => [ 'shape' => 'ClarifyShapConfig', ], ], ], 'ClarifyFeatureHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeatureType' => [ 'type' => 'string', 'enum' => [ 'numerical', 'categorical', 'text', ], ], 'ClarifyFeatureTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyFeatureType', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeaturesAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyHeader' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'FeaturesAttribute' => [ 'shape' => 'ClarifyFeaturesAttribute', ], 'ContentTemplate' => [ 'shape' => 'ClarifyContentTemplate', ], 'MaxRecordCount' => [ 'shape' => 'ClarifyMaxRecordCount', ], 'MaxPayloadInMB' => [ 'shape' => 'ClarifyMaxPayloadInMB', ], 'ProbabilityIndex' => [ 'shape' => 'ClarifyProbabilityIndex', ], 'LabelIndex' => [ 'shape' => 'ClarifyLabelIndex', ], 'ProbabilityAttribute' => [ 'shape' => 'ClarifyProbabilityAttribute', ], 'LabelAttribute' => [ 'shape' => 'ClarifyLabelAttribute', ], 'LabelHeaders' => [ 'shape' => 'ClarifyLabelHeaders', ], 'FeatureHeaders' => [ 'shape' => 'ClarifyFeatureHeaders', ], 'FeatureTypes' => [ 'shape' => 'ClarifyFeatureTypes', ], ], ], 'ClarifyLabelAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyLabelHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 16, 'min' => 1, ], 'ClarifyLabelIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyMaxPayloadInMB' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'ClarifyMaxRecordCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyMimeType' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*', ], 'ClarifyProbabilityAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyProbabilityIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyShapBaseline' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'ClarifyShapBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'MimeType' => [ 'shape' => 'ClarifyMimeType', ], 'ShapBaseline' => [ 'shape' => 'ClarifyShapBaseline', ], 'ShapBaselineUri' => [ 'shape' => 'Url', ], ], ], 'ClarifyShapConfig' => [ 'type' => 'structure', 'required' => [ 'ShapBaselineConfig', ], 'members' => [ 'ShapBaselineConfig' => [ 'shape' => 'ClarifyShapBaselineConfig', ], 'NumberOfSamples' => [ 'shape' => 'ClarifyShapNumberOfSamples', ], 'UseLogit' => [ 'shape' => 'ClarifyShapUseLogit', ], 'Seed' => [ 'shape' => 'ClarifyShapSeed', ], 'TextConfig' => [ 'shape' => 'ClarifyTextConfig', ], ], ], 'ClarifyShapNumberOfSamples' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyShapSeed' => [ 'type' => 'integer', ], 'ClarifyShapUseLogit' => [ 'type' => 'boolean', ], 'ClarifyTextConfig' => [ 'type' => 'structure', 'required' => [ 'Language', 'Granularity', ], 'members' => [ 'Language' => [ 'shape' => 'ClarifyTextLanguage', ], 'Granularity' => [ 'shape' => 'ClarifyTextGranularity', ], ], ], 'ClarifyTextGranularity' => [ 'type' => 'string', 'enum' => [ 'token', 'sentence', 'paragraph', ], ], 'ClarifyTextLanguage' => [ 'type' => 'string', 'enum' => [ 'af', 'sq', 'ar', 'hy', 'eu', 'bn', 'bg', 'ca', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'de', 'el', 'gu', 'he', 'hi', 'hu', 'is', 'id', 'ga', 'it', 'kn', 'ky', 'lv', 'lt', 'lb', 'mk', 'ml', 'mr', 'ne', 'nb', 'fa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sr', 'tn', 'si', 'sk', 'sl', 'es', 'sv', 'tl', 'ta', 'tt', 'te', 'tr', 'uk', 'ur', 'yo', 'lij', 'xx', ], ], 'ClientId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', ], 'ClientSecret' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', 'sensitive' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'ClusterArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$', ], 'ClusterInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClusterInstanceGroupDetails' => [ 'type' => 'structure', 'members' => [ 'CurrentCount' => [ 'shape' => 'ClusterNonNegativeInstanceCount', ], 'TargetCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupDetails', ], ], 'ClusterInstanceGroupName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterInstanceGroupSpecification' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceGroupName', 'InstanceType', 'LifeCycleConfig', 'ExecutionRole', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupSpecification', ], 'max' => 5, 'min' => 1, ], 'ClusterInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Running', 'Failure', 'Pending', 'ShuttingDown', 'SystemUpdating', ], ], 'ClusterInstanceStatusDetails' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ClusterInstanceStatus', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ClusterInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.c5n.large', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', ], ], 'ClusterLifeCycleConfig' => [ 'type' => 'structure', 'required' => [ 'SourceS3Uri', 'OnCreate', ], 'members' => [ 'SourceS3Uri' => [ 'shape' => 'S3Uri', ], 'OnCreate' => [ 'shape' => 'ClusterLifeCycleConfigFileName', ], ], ], 'ClusterLifeCycleConfigFileName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\S\\s]+$', ], 'ClusterName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterNameOrArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$', ], 'ClusterNodeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterNodeId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z][-a-zA-Z0-9]*$', ], 'ClusterNodeSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterNodeSummary', ], ], 'ClusterNodeSummary' => [ 'type' => 'structure', 'required' => [ 'InstanceGroupName', 'InstanceId', 'InstanceType', 'LaunchTime', 'InstanceStatus', ], 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], ], ], 'ClusterNonNegativeInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'ClusterSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'NAME', ], ], 'ClusterStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Deleting', 'Failed', 'InService', 'RollingBack', 'SystemUpdating', 'Updating', ], ], 'ClusterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSummary', ], ], 'ClusterSummary' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterName', 'CreationTime', 'ClusterStatus', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], ], ], 'ClusterThreadsPerCore' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'CodeEditorAppImageConfig' => [ 'type' => 'structure', 'members' => [ 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], 'ContainerConfig' => [ 'shape' => 'ContainerConfig', ], ], ], 'CodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'CodeRepositories' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepository', ], 'max' => 10, ], 'CodeRepository' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'RepositoryUrl', ], ], ], 'CodeRepositoryArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$', ], 'CodeRepositoryContains' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameOrUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'CodeRepositorySortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'CodeRepositorySortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'CodeRepositorySummary' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'CodeRepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositorySummary', ], ], 'CognitoConfig' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'UserGroup', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'UserGroup' => [ 'shape' => 'CognitoUserGroup', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoUserGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CognitoUserPool' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'CollectionConfig' => [ 'type' => 'structure', 'members' => [ 'VectorConfig' => [ 'shape' => 'VectorConfig', ], ], 'union' => true, ], 'CollectionConfiguration' => [ 'type' => 'structure', 'members' => [ 'CollectionName' => [ 'shape' => 'CollectionName', ], 'CollectionParameters' => [ 'shape' => 'CollectionParameters', ], ], ], 'CollectionConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectionConfiguration', ], 'max' => 20, 'min' => 0, ], 'CollectionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'CollectionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'CollectionType' => [ 'type' => 'string', 'enum' => [ 'List', 'Set', 'Vector', ], ], 'CompilationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*', ], 'CompilationJobStatus' => [ 'type' => 'string', 'enum' => [ 'INPROGRESS', 'COMPLETED', 'FAILED', 'STARTING', 'STOPPING', 'STOPPED', ], ], 'CompilationJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompilationJobSummary', ], ], 'CompilationJobSummary' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CreationTime', 'CompilationJobStatus', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'CompilationTargetDevice' => [ 'shape' => 'TargetDevice', ], 'CompilationTargetPlatformOs' => [ 'shape' => 'TargetPlatformOs', ], 'CompilationTargetPlatformArch' => [ 'shape' => 'TargetPlatformArch', ], 'CompilationTargetPlatformAccelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], ], ], 'CompilerOptions' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '.*', ], 'CompleteOnConvergence' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Enabled', ], ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'CompressionTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompressionType', ], ], 'ConditionOutcome' => [ 'type' => 'string', 'enum' => [ 'True', 'False', ], ], 'ConditionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Outcome' => [ 'shape' => 'ConditionOutcome', ], ], ], 'ConfigKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'ConfigValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 100, 'min' => 1, ], 'ContainerConfig' => [ 'type' => 'structure', 'members' => [ 'ContainerArguments' => [ 'shape' => 'CustomImageContainerArguments', ], 'ContainerEntrypoint' => [ 'shape' => 'CustomImageContainerEntrypoint', ], 'ContainerEnvironmentVariables' => [ 'shape' => 'CustomImageContainerEnvironmentVariables', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageConfig' => [ 'shape' => 'ImageConfig', ], 'Mode' => [ 'shape' => 'ContainerMode', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'MultiModelConfig' => [ 'shape' => 'MultiModelConfig', ], ], ], 'ContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], 'max' => 15, ], 'ContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'ContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerHostname' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ContainerImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '[\\S]+', ], 'ContainerMode' => [ 'type' => 'string', 'enum' => [ 'SingleModel', 'MultiModel', ], ], 'ContentClassifier' => [ 'type' => 'string', 'enum' => [ 'FreeOfPersonallyIdentifiableInformation', 'FreeOfAdultContent', ], ], 'ContentClassifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentClassifier', ], 'max' => 256, ], 'ContentColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContentDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentType', ], ], 'ContextArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*', ], 'ContextName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}', ], 'ContextNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})', ], 'ContextSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ContextSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextSummary', ], ], 'ContextSummary' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ContinuousParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'ContinuousParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ContinuousParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousParameterRange', ], 'max' => 30, 'min' => 0, ], 'ConvergenceDetected' => [ 'type' => 'structure', 'members' => [ 'CompleteOnConvergence' => [ 'shape' => 'CompleteOnConvergence', ], ], ], 'CountryCode' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Z]{2}', ], 'CreateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', 'Source', 'ActionType', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'CreateAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'TrainingSpecification', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmArn', ], 'members' => [ 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], ], ], 'CreateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'Tags' => [ 'shape' => 'TagList', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'CreateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], ], ], 'CreateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'Source', 'ArtifactType', ], 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'CreateAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], ], ], 'CreateAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'AutoMLProblemTypeConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], ], ], 'CreateAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterName', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'CreateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'GitConfig', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'CreateCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'RoleArn', 'OutputConfig', 'StoppingCondition', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobArn', ], 'members' => [ 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], ], ], 'CreateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', 'Source', 'ContextType', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'CreateDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'AuthMode', 'DefaultUserSettings', 'SubnetIds', 'VpcId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Tags' => [ 'shape' => 'TagList', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'CreateEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], ], ], 'CreateEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], ], ], 'CreateEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', 'CompilationJobName', 'ModelName', 'ModelVersion', 'RoleArn', 'OutputConfig', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'ProductionVariants', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigArn', ], 'members' => [ 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], ], ], 'CreateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'CreateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'CreateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'CreateFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], ], ], 'CreateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubDescription', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'CreateHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'UiTemplate', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'CreateHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobConfig', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'CreateHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobArn', ], 'members' => [ 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'CreateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'RoleArn', ], 'members' => [ 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'CreateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'BaseImage', 'ClientToken', 'ImageName', ], 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ImageName' => [ 'shape' => 'ImageName', ], 'Aliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'CreateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'CreateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'EndpointName', 'VariantName', 'Specification', 'RuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'CreateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'RoleArn', 'EndpointName', 'ModelVariants', 'ShadowModeConfig', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'CreateInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'RoleArn', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'OutputConfig' => [ 'shape' => 'RecommendationJobOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobArn', ], 'members' => [ 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], ], ], 'CreateLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelAttributeName', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobArn', ], 'members' => [ 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], ], ], 'CreateModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardExportJobName', 'OutputConfig', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], ], ], 'CreateModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'CreateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'Content', 'ModelCardStatus', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelArn', ], 'members' => [ 'ModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'CreateModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'CreateModelPackageInput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], ], ], 'CreateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'CreateModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'CreateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'InstanceType', 'RoleArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], ], ], 'CreateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], ], ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', 'RoleArn', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'CreatePresignedDomainUrlRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], 'ExpiresInSeconds' => [ 'shape' => 'ExpiresInSeconds', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'LandingUri' => [ 'shape' => 'LandingUri', ], ], ], 'CreatePresignedDomainUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'PresignedDomainUrl', ], ], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'NotebookInstanceUrl', ], ], ], 'CreateProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'RoleArn', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobArn', ], 'members' => [ 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'CreateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ServiceCatalogProvisioningDetails', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectId', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], ], ], 'CreateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'CreateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'CreateStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', 'StudioLifecycleConfigContent', 'StudioLifecycleConfigAppType', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'CreateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], 'SessionChainingConfig' => [ 'shape' => 'SessionChainingConfig', ], ], ], 'CreateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'CreateTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'ModelName', 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobArn', ], 'members' => [ 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], ], ], 'CreateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'CreateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', 'ExperimentName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'CreateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'CreateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'CreateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'CreateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'WorkforceArn', ], 'members' => [ 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], ], ], 'CreateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateWorkteamResponse' => [ 'type' => 'structure', 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', ], 'CrossAccountFilterOption' => [ 'type' => 'string', 'enum' => [ 'SameAccount', 'CrossAccount', ], ], 'CsvContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'CsvContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CsvContentType', ], 'max' => 10, 'min' => 1, ], 'CustomFileSystem' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystem' => [ 'shape' => 'EFSFileSystem', ], ], 'union' => true, ], 'CustomFileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystemConfig' => [ 'shape' => 'EFSFileSystemConfig', ], ], 'union' => true, ], 'CustomFileSystemConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystemConfig', ], 'max' => 2, ], 'CustomFileSystems' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystem', ], 'max' => 1, ], 'CustomImage' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'AppImageConfigName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageVersionNumber' => [ 'shape' => 'ImageVersionNumber', 'box' => true, ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'CustomImageContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString64', ], 'max' => 50, ], 'CustomImageContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString256', ], 'max' => 1, ], 'CustomImageContainerEnvironmentVariables' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonEmptyString256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 25, ], 'CustomImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomImage', ], 'max' => 200, ], 'CustomPosixUserConfig' => [ 'type' => 'structure', 'required' => [ 'Uid', 'Gid', ], 'members' => [ 'Uid' => [ 'shape' => 'Uid', ], 'Gid' => [ 'shape' => 'Gid', ], ], ], 'CustomerMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}', ], 'CustomerMetadataKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerMetadataKey', ], ], 'CustomerMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerMetadataKey', ], 'value' => [ 'shape' => 'CustomerMetadataValue', ], 'max' => 50, 'min' => 1, ], 'CustomerMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}', ], 'CustomizedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Statistic' => [ 'shape' => 'Statistic', ], ], ], 'DataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'InitialSamplingPercentage', 'DestinationS3Uri', 'CaptureOptions', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'InitialSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CaptureOptions' => [ 'shape' => 'CaptureOptionList', ], 'CaptureContentTypeHeader' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'DataCaptureConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EnableCapture', 'CaptureStatus', 'CurrentSamplingPercentage', 'DestinationS3Uri', 'KmsKeyId', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'CaptureStatus' => [ 'shape' => 'CaptureStatus', ], 'CurrentSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'DataCatalogConfig' => [ 'type' => 'structure', 'required' => [ 'TableName', 'Catalog', 'Database', ], 'members' => [ 'TableName' => [ 'shape' => 'TableName', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'DataExplorationNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'DataInputConfig' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DataProcessing' => [ 'type' => 'structure', 'members' => [ 'InputFilter' => [ 'shape' => 'JsonPath', ], 'OutputFilter' => [ 'shape' => 'JsonPath', ], 'JoinSource' => [ 'shape' => 'JoinSource', ], ], ], 'DataQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'DataQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'DataQualityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3DataSource', ], 'FileSystemDataSource' => [ 'shape' => 'FileSystemDataSource', ], ], ], 'DataSourceName' => [ 'type' => 'string', 'enum' => [ 'SalesforceGenie', 'Snowflake', ], ], 'Database' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'DatasetDefinition' => [ 'type' => 'structure', 'members' => [ 'AthenaDatasetDefinition' => [ 'shape' => 'AthenaDatasetDefinition', ], 'RedshiftDatasetDefinition' => [ 'shape' => 'RedshiftDatasetDefinition', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'DataDistributionType' => [ 'shape' => 'DataDistributionType', ], 'InputMode' => [ 'shape' => 'InputMode', ], ], ], 'DebugHookConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'HookParameters' => [ 'shape' => 'HookParameters', ], 'CollectionConfigurations' => [ 'shape' => 'CollectionConfigurations', ], ], ], 'DebugRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'DebugRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'DebugRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DebugRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'DefaultEbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'DefaultEbsVolumeSizeInGb', 'MaximumEbsVolumeSizeInGb', ], 'members' => [ 'DefaultEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], 'MaximumEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'DefaultGid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DefaultSpaceSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'JupyterLabAppSettings', ], 'SpaceStorageSettings' => [ 'shape' => 'DefaultSpaceStorageSettings', ], 'CustomPosixUserConfig' => [ 'shape' => 'CustomPosixUserConfig', ], 'CustomFileSystemConfigs' => [ 'shape' => 'CustomFileSystemConfigs', ], ], ], 'DefaultSpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultEbsStorageSettings' => [ 'shape' => 'DefaultEbsStorageSettings', ], ], ], 'DefaultUid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DeleteActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'DeleteAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DeleteArtifactRequest' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], ], ], 'DeleteArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DeleteAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'DeleteCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], ], ], 'DeleteContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'RetentionPolicy' => [ 'shape' => 'RetentionPolicy', ], ], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DeleteEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DeleteExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'DeleteFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'DeleteFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DeleteFlowDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', 'HubContentVersion', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DeleteHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DeleteHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DeleteHumanTaskUiResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DeleteImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DeleteImageResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DeleteImageVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DeleteInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DeleteInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DeleteModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DeleteModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DeleteNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'DeleteProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DeleteSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DeleteTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'DeleteTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'DeleteTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DeleteUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DeleteWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DeleteWorkforceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DeleteWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Success', ], 'members' => [ 'Success' => [ 'shape' => 'Success', ], ], ], 'DependencyCopyPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DependencyOriginPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DeployedImage' => [ 'type' => 'structure', 'members' => [ 'SpecifiedImage' => [ 'shape' => 'ContainerImage', ], 'ResolvedImage' => [ 'shape' => 'ContainerImage', ], 'ResolutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeployedImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeployedImage', ], ], 'DeploymentConfig' => [ 'type' => 'structure', 'members' => [ 'BlueGreenUpdatePolicy' => [ 'shape' => 'BlueGreenUpdatePolicy', ], 'RollingUpdatePolicy' => [ 'shape' => 'RollingUpdatePolicy', ], 'AutoRollbackConfiguration' => [ 'shape' => 'AutoRollbackConfig', ], ], ], 'DeploymentRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationStatus', ], 'members' => [ 'RecommendationStatus' => [ 'shape' => 'RecommendationStatus', ], 'RealTimeInferenceRecommendations' => [ 'shape' => 'RealTimeInferenceRecommendations', ], ], ], 'DeploymentStage' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], ], ], 'DeploymentStageMaxResults' => [ 'type' => 'integer', 'max' => 10, ], 'DeploymentStageStatusSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStageStatusSummary', ], ], 'DeploymentStageStatusSummary' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', 'DeploymentConfig', 'DeploymentStatus', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], 'DeploymentStatus' => [ 'shape' => 'EdgeDeploymentStatus', ], ], ], 'DeploymentStages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStage', ], ], 'DeregisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceNames', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], ], ], 'DerivedInformation' => [ 'type' => 'structure', 'members' => [ 'DerivedDataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'DescribeActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ActionArn' => [ 'shape' => 'ActionArn', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'TrainingSpecification', 'AlgorithmStatus', 'AlgorithmStatusDetails', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], 'AlgorithmStatusDetails' => [ 'shape' => 'AlgorithmStatusDetails', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], ], ], 'DescribeAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DescribeAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'LastHealthCheckTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUserActivityTimestamp' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'DescribeArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DescribeArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'ResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], ], ], 'DescribeAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'AutoMLProblemTypeConfigName' => [ 'shape' => 'AutoMLProblemTypeConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'AutoMLResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], ], ], 'DescribeClusterNodeRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'NodeId', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'NodeId' => [ 'shape' => 'ClusterNodeId', ], ], ], 'DescribeClusterNodeResponse' => [ 'type' => 'structure', 'required' => [ 'NodeDetails', ], 'members' => [ 'NodeDetails' => [ 'shape' => 'ClusterNodeDetails', ], ], ], 'DescribeClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DescribeClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterStatus', 'InstanceGroups', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureMessage' => [ 'shape' => 'String', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupDetailsList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'DescribeCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'DescribeCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CompilationJobStatus', 'StoppingCondition', 'CreationTime', 'LastModifiedTime', 'FailureReason', 'ModelArtifacts', 'RoleArn', 'InputConfig', 'OutputConfig', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'InferenceImage' => [ 'shape' => 'InferenceImage', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'ModelDigests' => [ 'shape' => 'ModelDigests', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'DerivedInformation' => [ 'shape' => 'DerivedInformation', ], ], ], 'DescribeContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextNameOrArn', ], ], ], 'DescribeContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'ContextArn' => [ 'shape' => 'ContextArn', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceFleetResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceFleetArn', 'OutputConfig', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'IotRoleAlias' => [ 'shape' => 'IotRoleAlias', ], ], ], 'DescribeDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', 'RegistrationTime', ], 'members' => [ 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModels', ], 'MaxModels' => [ 'shape' => 'Integer', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'HomeEfsFileSystemId' => [ 'shape' => 'ResourceId', ], 'SingleSignOnManagedApplicationInstanceId' => [ 'shape' => 'String256', ], 'SingleSignOnApplicationArn' => [ 'shape' => 'SingleSignOnApplicationArn', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SecurityGroupIdForDomainBoundary' => [ 'shape' => 'SecurityGroupId', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'Url' => [ 'shape' => 'String1024', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'DeploymentStageMaxResults', ], ], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'Stages' => [ 'shape' => 'DeploymentStageStatusSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeEdgePackagingJobResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'EdgePackagingJobStatusMessage' => [ 'shape' => 'String', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ModelArtifact' => [ 'shape' => 'S3Uri', ], 'ModelSignature' => [ 'shape' => 'String', ], 'PresetDeploymentOutput' => [ 'shape' => 'EdgePresetDeploymentOutput', ], ], ], 'DescribeEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DescribeEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'ProductionVariants', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'DescribeEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DescribeEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastDeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'PendingDeploymentSummary' => [ 'shape' => 'PendingDeploymentSummary', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'DescribeExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', 'CreationTime', 'NextToken', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfigDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'OnlineStoreTotalSizeBytes' => [ 'shape' => 'OnlineStoreTotalSizeBytes', ], ], ], 'DescribeFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], ], ], 'DescribeFeatureMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'FeatureName', 'FeatureType', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'DescribeFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DescribeFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', 'FlowDefinitionName', 'FlowDefinitionStatus', 'CreationTime', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DescribeHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DescribeHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubArn', 'HubContentDocument', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentDependencies' => [ 'shape' => 'HubContentDependencyList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DescribeHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DescribeHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', 'HumanTaskUiName', 'CreationTime', 'UiTemplate', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiStatus' => [ 'shape' => 'HumanTaskUiStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'UiTemplate' => [ 'shape' => 'UiTemplateInfo', ], ], ], 'DescribeHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DescribeHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobConfig', 'HyperParameterTuningJobStatus', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Autotune' => [ 'shape' => 'Autotune', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], ], ], 'DescribeImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DescribeImageResponse' => [ 'type' => 'structure', 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'DescribeImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DescribeImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ContainerImage' => [ 'shape' => 'ImageContainerImage', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'DescribeInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DescribeInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'InferenceComponentArn', 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecificationSummary', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfigSummary', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], ], ], 'DescribeInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DescribeInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Name', 'Type', 'Status', 'EndpointMetadata', 'ModelVariants', ], 'members' => [ 'Arn' => [ 'shape' => 'InferenceExperimentArn', ], 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointMetadata' => [ 'shape' => 'EndpointMetadata', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigSummaryList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], ], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'JobArn', 'RoleArn', 'Status', 'CreationTime', 'LastModifiedTime', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'InferenceRecommendations' => [ 'shape' => 'InferenceRecommendations', ], 'EndpointPerformances' => [ 'shape' => 'EndpointPerformances', ], ], ], 'DescribeLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'DescribeLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobStatus', 'LabelCounters', 'CreationTime', 'LastModifiedTime', 'JobReferenceCode', 'LabelingJobName', 'LabelingJobArn', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], ], ], 'DescribeLineageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeLineageGroupResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'DescribeModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'OutputConfig', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExportArtifacts' => [ 'shape' => 'ModelCardExportArtifacts', ], ], ], 'DescribeModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], ], ], 'DescribeModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', 'ModelCardName', 'ModelCardVersion', 'Content', 'ModelCardStatus', 'CreationTime', 'CreatedBy', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ModelCardProcessingStatus' => [ 'shape' => 'ModelCardProcessingStatus', ], ], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DescribeModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'CreationTime', 'ModelArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'DescribeModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'CreatedBy', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'DescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DescribeModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', 'ModelPackageStatusDetails', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], ], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DescribeMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', 'MonitoringScheduleName', 'MonitoringScheduleStatus', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'DescribeNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], ], ], 'DescribeNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'DescribePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], ], ], 'DescribePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'DescribeProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'DescribeProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'ProcessingJobArn', 'ProcessingJobStatus', 'CreationTime', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'DescribeProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DescribeProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectName', 'ProjectId', 'ServiceCatalogProvisioningDetails', 'ProjectStatus', 'CreationTime', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceArn' => [ 'shape' => 'SpaceArn', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DescribeStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DescribeStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'DescribeSubscribedWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'DescribeSubscribedWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteam', ], 'members' => [ 'SubscribedWorkteam' => [ 'shape' => 'SubscribedWorkteam', ], ], ], 'DescribeTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'DescribeTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'ModelArtifacts', 'TrainingJobStatus', 'SecondaryStatus', 'AlgorithmSpecification', 'ResourceConfig', 'StoppingCondition', 'CreationTime', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ProfilerRuleEvaluationStatuses' => [ 'shape' => 'ProfilerRuleEvaluationStatuses', ], 'ProfilingStatus' => [ 'shape' => 'ProfilingStatus', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'DescribeTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'DescribeTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'TransformJobStatus', 'ModelName', 'TransformInput', 'TransformResources', 'CreationTime', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'DescribeTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Sources' => [ 'shape' => 'TrialComponentSources', ], ], ], 'DescribeTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], ], ], 'DescribeUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DescribeUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'DescribeWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DescribeWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'DescribeWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DescribeWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 128, ], 'DesiredWeightAndCapacity' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'ServerlessUpdateConfig' => [ 'shape' => 'ProductionVariantServerlessUpdateConfig', ], ], ], 'DesiredWeightAndCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredWeightAndCapacity', ], 'min' => 1, ], 'DestinationS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/])/?(.*)$', ], 'DetailedAlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'DetailedModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'DeviceName', ], 'members' => [ 'DeviceName' => [ 'shape' => 'DeviceName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'IotThingName' => [ 'shape' => 'ThingName', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'READYTODEPLOY', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'DeviceDeploymentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceDeploymentSummary', ], ], 'DeviceDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'StageName', 'DeviceName', 'DeviceArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], 'DeployedStageName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceName' => [ 'shape' => 'DeviceName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceDeploymentStatus' => [ 'shape' => 'DeviceDeploymentStatus', ], 'DeviceDeploymentStatusMessage' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeploymentStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceDescription' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetArn' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceFleetDescription' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFleetSummary', ], ], 'DeviceFleetSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'DeviceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceName', ], ], 'DeviceSelectionConfig' => [ 'type' => 'structure', 'required' => [ 'DeviceSubsetType', ], 'members' => [ 'DeviceSubsetType' => [ 'shape' => 'DeviceSubsetType', ], 'Percentage' => [ 'shape' => 'Percentage', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], 'DeviceNameContains' => [ 'shape' => 'DeviceName', ], ], ], 'DeviceStats' => [ 'type' => 'structure', 'required' => [ 'ConnectedDeviceCount', 'RegisteredDeviceCount', ], 'members' => [ 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'RegisteredDeviceCount' => [ 'shape' => 'Long', ], ], ], 'DeviceSubsetType' => [ 'type' => 'string', 'enum' => [ 'PERCENTAGE', 'SELECTION', 'NAMECONTAINS', ], ], 'DeviceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceSummary', ], ], 'DeviceSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceArn', ], 'members' => [ 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModelSummaries', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'Dimension' => [ 'type' => 'integer', 'max' => 8192, 'min' => 1, ], 'DirectDeploySettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'DirectInternetAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Direction' => [ 'type' => 'string', 'enum' => [ 'Both', 'Ascendants', 'Descendants', ], ], 'DirectoryPath' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'DisableProfiler' => [ 'type' => 'boolean', ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'type' => 'boolean', ], 'DisassociateDefaultCodeRepository' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'type' => 'boolean', ], 'DisassociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DisassociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DockerSettings' => [ 'type' => 'structure', 'members' => [ 'EnableDockerAccess' => [ 'shape' => 'FeatureStatus', ], 'VpcOnlyTrustedAccounts' => [ 'shape' => 'VpcOnlyTrustedAccounts', ], ], ], 'DocumentSchemaVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'Dollars' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'DomainArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*', ], 'DomainDetails' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^d-(-*[a-z0-9]){1,61}', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'DomainSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 3, ], 'DomainSettings' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'RStudioServerProDomainSettings' => [ 'shape' => 'RStudioServerProDomainSettings', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainSettingsForUpdate' => [ 'type' => 'structure', 'members' => [ 'RStudioServerProDomainSettingsForUpdate' => [ 'shape' => 'RStudioServerProDomainSettingsForUpdate', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleParameterValue' => [ 'type' => 'double', ], 'DriftCheckBaselines' => [ 'type' => 'structure', 'members' => [ 'Bias' => [ 'shape' => 'DriftCheckBias', ], 'Explainability' => [ 'shape' => 'DriftCheckExplainability', ], 'ModelQuality' => [ 'shape' => 'DriftCheckModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'DriftCheckModelDataQuality', ], ], ], 'DriftCheckBias' => [ 'type' => 'structure', 'members' => [ 'ConfigFile' => [ 'shape' => 'FileSource', ], 'PreTrainingConstraints' => [ 'shape' => 'MetricsSource', ], 'PostTrainingConstraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckExplainability' => [ 'type' => 'structure', 'members' => [ 'Constraints' => [ 'shape' => 'MetricsSource', ], 'ConfigFile' => [ 'shape' => 'FileSource', ], ], ], 'DriftCheckModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DynamicScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], 'ScaleInCooldown' => [ 'shape' => 'Integer', ], 'ScaleOutCooldown' => [ 'shape' => 'Integer', ], 'ScalingPolicies' => [ 'shape' => 'ScalingPolicies', ], ], ], 'EFSFileSystem' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], ], ], 'EFSFileSystemConfig' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemPath' => [ 'shape' => 'FileSystemPath', ], ], ], 'EMRStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'String256', ], 'StepId' => [ 'shape' => 'String256', ], 'StepName' => [ 'shape' => 'String256', ], 'LogFilePath' => [ 'shape' => 'String1024', ], ], ], 'EbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'EbsVolumeSizeInGb', ], 'members' => [ 'EbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'Edge' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'EdgeDeploymentConfig' => [ 'type' => 'structure', 'required' => [ 'FailureHandlingPolicy', ], 'members' => [ 'FailureHandlingPolicy' => [ 'shape' => 'FailureHandlingPolicy', ], ], ], 'EdgeDeploymentModelConfig' => [ 'type' => 'structure', 'required' => [ 'ModelHandle', 'EdgePackagingJobName', ], 'members' => [ 'ModelHandle' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'EdgeDeploymentModelConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentModelConfig', ], ], 'EdgeDeploymentPlanArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgeDeploymentPlanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentPlanSummary', ], ], 'EdgeDeploymentPlanSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'DeviceFleetName', 'EdgeDeploymentSuccess', 'EdgeDeploymentPending', 'EdgeDeploymentFailed', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeDeploymentStatus' => [ 'type' => 'structure', 'required' => [ 'StageStatus', 'EdgeDeploymentSuccessInStage', 'EdgeDeploymentPendingInStage', 'EdgeDeploymentFailedInStage', ], 'members' => [ 'StageStatus' => [ 'shape' => 'StageStatus', ], 'EdgeDeploymentSuccessInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPendingInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailedInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentStatusMessage' => [ 'shape' => 'String', ], 'EdgeDeploymentStageStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModel' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'LatestSampleTime' => [ 'shape' => 'Timestamp', ], 'LatestInference' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModelStat' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', 'OfflineDeviceCount', 'ConnectedDeviceCount', 'ActiveDeviceCount', 'SamplingDeviceCount', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'OfflineDeviceCount' => [ 'shape' => 'Long', ], 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'ActiveDeviceCount' => [ 'shape' => 'Long', ], 'SamplingDeviceCount' => [ 'shape' => 'Long', ], ], ], 'EdgeModelStats' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelStat', ], ], 'EdgeModelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelSummary', ], ], 'EdgeModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'EdgeModels' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModel', ], ], 'EdgeOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'PresetDeploymentType' => [ 'shape' => 'EdgePresetDeploymentType', ], 'PresetDeploymentConfig' => [ 'shape' => 'String', ], ], ], 'EdgePackagingJobArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgePackagingJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'INPROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'EdgePackagingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgePackagingJobSummary', ], ], 'EdgePackagingJobSummary' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgePresetDeploymentArtifact' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'EdgePresetDeploymentOutput' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'EdgePresetDeploymentType', ], 'Artifact' => [ 'shape' => 'EdgePresetDeploymentArtifact', ], 'Status' => [ 'shape' => 'EdgePresetDeploymentStatus', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'EdgePresetDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', ], ], 'EdgePresetDeploymentType' => [ 'type' => 'string', 'enum' => [ 'GreengrassV2Component', ], ], 'EdgeVersion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\ \\_\\.]+', ], 'Edges' => [ 'type' => 'list', 'member' => [ 'shape' => 'Edge', ], ], 'EfsUid' => [ 'type' => 'string', 'max' => 10, 'pattern' => '\\d+', ], 'EnableCapture' => [ 'type' => 'boolean', ], 'EnableInfraCheck' => [ 'type' => 'boolean', ], 'EnableIotRoleAlias' => [ 'type' => 'boolean', ], 'EnableRemoteDebug' => [ 'type' => 'boolean', ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSessionTagChaining' => [ 'type' => 'boolean', ], 'Endpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringSchedules' => [ 'shape' => 'MonitoringScheduleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'EndpointArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*', ], 'EndpointConfigArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*', ], 'EndpointConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'EndpointConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'EndpointConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointConfigSummary', ], ], 'EndpointInfo' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'EndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'LocalPath', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'EndpointInputConfiguration' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameterRanges' => [ 'shape' => 'EnvironmentParameterRanges', ], ], ], 'EndpointInputConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInputConfiguration', ], 'max' => 10, 'min' => 1, ], 'EndpointMetadata' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'EndpointName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointOutputConfiguration' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'VariantName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'String', ], 'VariantName' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialInstanceCount' => [ 'shape' => 'InitialInstanceCount', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointPerformance' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointInfo', ], 'members' => [ 'Metrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointInfo' => [ 'shape' => 'EndpointInfo', ], ], ], 'EndpointPerformances' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointPerformance', ], 'max' => 1, ], 'EndpointSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'EndpointStatus' => [ 'type' => 'string', 'enum' => [ 'OutOfService', 'Creating', 'Updating', 'SystemUpdating', 'RollingBack', 'InService', 'Deleting', 'Failed', 'UpdateRollbackFailed', ], ], 'EndpointSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'EndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointSummary', ], ], 'Endpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInfo', ], 'max' => 1, ], 'EntityDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'EntityName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'EnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'EnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'EnvironmentKey', ], 'value' => [ 'shape' => 'EnvironmentValue', ], 'max' => 100, ], 'EnvironmentParameter' => [ 'type' => 'structure', 'required' => [ 'Key', 'ValueType', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'EnvironmentParameterRanges' => [ 'type' => 'structure', 'members' => [ 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameters', ], ], ], 'EnvironmentParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentParameter', ], 'max' => 10, 'min' => 1, ], 'EnvironmentValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'ExcludeFeaturesAttribute' => [ 'type' => 'string', 'max' => 100, ], 'ExecutionRoleIdentityConfig' => [ 'type' => 'string', 'enum' => [ 'USER_PROFILE_NAME', 'DISABLED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Completed', 'CompletedWithViolations', 'InProgress', 'Failed', 'Stopping', 'Stopped', ], ], 'ExitMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'Experiment' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*', ], 'ExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentDisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ExperimentDescription' => [ 'type' => 'string', 'max' => 3072, 'pattern' => '.*', ], 'ExperimentEntityName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'ExperimentEntityNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'ExperimentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'ExperimentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'ExperimentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'ExperimentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExperimentSummary', ], ], 'ExperimentSummary' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentSource' => [ 'shape' => 'ExperimentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ExpiresInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Explainability' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], ], ], 'ExplainabilityLocation' => [ 'type' => 'string', 'min' => 1, ], 'ExplainerConfig' => [ 'type' => 'structure', 'members' => [ 'ClarifyExplainerConfig' => [ 'shape' => 'ClarifyExplainerConfig', ], ], ], 'FailStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String3072', ], ], ], 'FailureHandlingPolicy' => [ 'type' => 'string', 'enum' => [ 'ROLLBACK_ON_FAILURE', 'DO_NOTHING', ], ], 'FailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'FeatureAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 100, 'min' => 1, ], 'FeatureDefinition' => [ 'type' => 'structure', 'required' => [ 'FeatureName', 'FeatureType', ], 'members' => [ 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CollectionType' => [ 'shape' => 'CollectionType', ], 'CollectionConfig' => [ 'shape' => 'CollectionConfig', ], ], ], 'FeatureDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 2500, 'min' => 1, ], 'FeatureDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '.*', ], 'FeatureGroup' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'FeatureGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*', ], 'FeatureGroupMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'FeatureGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}', ], 'FeatureGroupNameContains' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FeatureGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})', ], 'FeatureGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'FeatureGroupStatus', 'OfflineStoreStatus', 'CreationTime', ], ], 'FeatureGroupSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'FeatureGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'CreateFailed', 'Deleting', 'DeleteFailed', ], ], 'FeatureGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureGroupSummary', ], ], 'FeatureGroupSummary' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureGroupArn', 'CreationTime', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], ], ], 'FeatureMetadata' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'FeatureName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}', ], 'FeatureParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'FeatureParameterKey', ], 'Value' => [ 'shape' => 'FeatureParameterValue', ], ], ], 'FeatureParameterAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, ], 'FeatureParameterKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameterRemovals' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameterKey', ], 'max' => 25, ], 'FeatureParameterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, 'min' => 0, ], 'FeatureStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'FeatureType' => [ 'type' => 'string', 'enum' => [ 'Integral', 'Fractional', 'String', ], ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'FileSystemAccessMode' => [ 'type' => 'string', 'enum' => [ 'rw', 'ro', ], ], 'FileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'MountPath' => [ 'shape' => 'MountPath', ], 'DefaultUid' => [ 'shape' => 'DefaultUid', 'box' => true, ], 'DefaultGid' => [ 'shape' => 'DefaultGid', 'box' => true, ], ], ], 'FileSystemDataSource' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', 'FileSystemAccessMode', 'FileSystemType', 'DirectoryPath', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemAccessMode' => [ 'shape' => 'FileSystemAccessMode', ], 'FileSystemType' => [ 'shape' => 'FileSystemType', ], 'DirectoryPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'FileSystemId' => [ 'type' => 'string', 'max' => 21, 'min' => 11, 'pattern' => '^(fs-[0-9a-f]{8,})$', ], 'FileSystemPath' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^\\/\\S*$', ], 'FileSystemType' => [ 'type' => 'string', 'enum' => [ 'EFS', 'FSxLustre', ], ], 'FillingTransformationMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FillingType', ], 'value' => [ 'shape' => 'FillingTransformationValue', ], 'max' => 6, 'min' => 1, ], 'FillingTransformationValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-]+$', ], 'FillingTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'FillingTransformationMap', ], 'max' => 50, 'min' => 1, ], 'FillingType' => [ 'type' => 'string', 'enum' => [ 'frontfill', 'middlefill', 'backfill', 'futurefill', 'frontfill_value', 'middlefill_value', 'backfill_value', 'futurefill_value', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ResourcePropertyName', ], 'Operator' => [ 'shape' => 'Operator', ], 'Value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'FinalAutoMLJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'AutoMLJobObjectiveType', ], 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'MetricValue', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'MetricValue', ], ], ], 'FinalMetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricData', ], 'max' => 40, 'min' => 0, ], 'FlatInvocations' => [ 'type' => 'string', 'enum' => [ 'Continue', 'Stop', ], ], 'Float' => [ 'type' => 'float', ], 'FlowDefinitionArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:flow-definition/.*', ], 'FlowDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9]){0,62}', ], 'FlowDefinitionOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'FlowDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Active', 'Failed', 'Deleting', ], ], 'FlowDefinitionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionSummary', ], ], 'FlowDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'FlowDefinitionArn', 'FlowDefinitionStatus', 'CreationTime', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'FlowDefinitionTaskCount' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'FlowDefinitionTaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'FlowDefinitionTaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'FlowDefinitionTaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionTaskKeyword', ], 'max' => 5, 'min' => 1, ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'FlowDefinitionTaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'ForecastFrequency' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$', ], 'ForecastHorizon' => [ 'type' => 'integer', 'min' => 1, ], 'ForecastQuantile' => [ 'type' => 'string', 'max' => 4, 'min' => 2, 'pattern' => '(^p[1-9]\\d?$)', ], 'ForecastQuantiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastQuantile', ], 'max' => 5, 'min' => 1, ], 'Framework' => [ 'type' => 'string', 'enum' => [ 'TENSORFLOW', 'KERAS', 'MXNET', 'ONNX', 'PYTORCH', 'XGBOOST', 'TFLITE', 'DARKNET', 'SKLEARN', ], ], 'FrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.]+', ], 'GenerateCandidateDefinitionsOnly' => [ 'type' => 'boolean', ], 'GenerativeAiSettings' => [ 'type' => 'structure', 'members' => [ 'AmazonBedrockRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'GetDeviceFleetReportRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'GetDeviceFleetReportResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'ReportGenerated' => [ 'shape' => 'Timestamp', ], 'DeviceStats' => [ 'shape' => 'DeviceStats', ], 'AgentVersions' => [ 'shape' => 'AgentVersions', ], 'ModelStats' => [ 'shape' => 'EdgeModelStats', ], ], ], 'GetLineageGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'LineageGroupNameOrArn', ], ], ], 'GetLineageGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'ResourcePolicy' => [ 'shape' => 'ResourcePolicyString', ], ], ], 'GetModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'GetModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ResourcePolicy', ], 'members' => [ 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SagemakerServicecatalogStatus', ], ], ], 'GetScalingConfigurationRecommendationRequest' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobName', ], 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], ], ], 'GetScalingConfigurationRecommendationResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], 'Metric' => [ 'shape' => 'ScalingPolicyMetric', ], 'DynamicScalingConfiguration' => [ 'shape' => 'DynamicScalingConfiguration', ], ], ], 'GetSearchSuggestionsRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SuggestionQuery' => [ 'shape' => 'SuggestionQuery', ], ], ], 'GetSearchSuggestionsResponse' => [ 'type' => 'structure', 'members' => [ 'PropertyNameSuggestions' => [ 'shape' => 'PropertyNameSuggestionList', ], ], ], 'Gid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 1001, ], 'GitConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'GitConfigUrl', ], 'Branch' => [ 'shape' => 'Branch', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 11, 'pattern' => '^https://([^/]+)/?.{3,1016}$', ], 'Group' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupingAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'GroupingAttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingAttributeName', ], 'max' => 5, 'min' => 1, ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], 'max' => 10, 'min' => 1, ], 'HolidayConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'HolidayConfigAttributes', ], 'max' => 1, 'min' => 1, ], 'HolidayConfigAttributes' => [ 'type' => 'structure', 'members' => [ 'CountryCode' => [ 'shape' => 'CountryCode', ], ], ], 'HookParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'Horovod' => [ 'type' => 'boolean', ], 'HubArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDependency' => [ 'type' => 'structure', 'members' => [ 'DependencyOriginPath' => [ 'shape' => 'DependencyOriginPath', ], 'DependencyCopyPath' => [ 'shape' => 'DependencyCopyPath', ], ], ], 'HubContentDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentDependency', ], 'max' => 50, ], 'HubContentDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubContentDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDocument' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentInfo' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubContentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentInfo', ], ], 'HubContentMarkdown' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubContentSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubContentSortBy' => [ 'type' => 'string', 'enum' => [ 'HubContentName', 'CreationTime', 'HubContentStatus', ], ], 'HubContentStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Importing', 'Deleting', 'ImportFailed', 'DeleteFailed', ], ], 'HubContentType' => [ 'type' => 'string', 'enum' => [ 'Model', 'Notebook', ], ], 'HubContentVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'HubDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubInfo' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubInfo', ], ], 'HubName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubS3StorageConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3OutputPath', ], ], ], 'HubSearchKeyword' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[^A-Z]*$', ], 'HubSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubSortBy' => [ 'type' => 'string', 'enum' => [ 'HubName', 'CreationTime', 'HubStatus', 'AccountIdOwner', ], ], 'HubStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Deleting', 'CreateFailed', 'UpdateFailed', 'DeleteFailed', ], ], 'HumanLoopActivationConditions' => [ 'type' => 'string', 'max' => 10240, ], 'HumanLoopActivationConditionsConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditions', ], 'members' => [ 'HumanLoopActivationConditions' => [ 'shape' => 'HumanLoopActivationConditions', 'jsonvalue' => true, ], ], ], 'HumanLoopActivationConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditionsConfig', ], 'members' => [ 'HumanLoopActivationConditionsConfig' => [ 'shape' => 'HumanLoopActivationConditionsConfig', ], ], ], 'HumanLoopConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'HumanTaskUiArn', 'TaskTitle', 'TaskDescription', 'TaskCount', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'TaskTitle' => [ 'shape' => 'FlowDefinitionTaskTitle', ], 'TaskDescription' => [ 'shape' => 'FlowDefinitionTaskDescription', ], 'TaskCount' => [ 'shape' => 'FlowDefinitionTaskCount', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'FlowDefinitionTaskAvailabilityLifetimeInSeconds', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'FlowDefinitionTaskTimeLimitInSeconds', ], 'TaskKeywords' => [ 'shape' => 'FlowDefinitionTaskKeywords', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanLoopRequestSource' => [ 'type' => 'structure', 'required' => [ 'AwsManagedHumanLoopRequestSource', ], 'members' => [ 'AwsManagedHumanLoopRequestSource' => [ 'shape' => 'AwsManagedHumanLoopRequestSource', ], ], ], 'HumanTaskConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'UiConfig', 'PreHumanTaskLambdaArn', 'TaskTitle', 'TaskDescription', 'NumberOfHumanWorkersPerDataObject', 'TaskTimeLimitInSeconds', 'AnnotationConsolidationConfig', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'UiConfig' => [ 'shape' => 'UiConfig', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'TaskKeywords' => [ 'shape' => 'TaskKeywords', ], 'TaskTitle' => [ 'shape' => 'TaskTitle', ], 'TaskDescription' => [ 'shape' => 'TaskDescription', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'TaskTimeLimitInSeconds', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'TaskAvailabilityLifetimeInSeconds', ], 'MaxConcurrentTaskCount' => [ 'shape' => 'MaxConcurrentTaskCount', ], 'AnnotationConsolidationConfig' => [ 'shape' => 'AnnotationConsolidationConfig', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanTaskUiArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/.*', ], 'HumanTaskUiName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9])*', ], 'HumanTaskUiStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'HumanTaskUiSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HumanTaskUiSummary', ], ], 'HumanTaskUiSummary' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'HumanTaskUiArn', 'CreationTime', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], ], ], 'HyperParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'HyperParameterScalingType' => [ 'type' => 'string', 'enum' => [ 'Auto', 'Linear', 'Logarithmic', 'ReverseLogarithmic', ], ], 'HyperParameterSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Type' => [ 'shape' => 'ParameterType', ], 'Range' => [ 'shape' => 'ParameterRange', ], 'IsTunable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'DefaultValue' => [ 'shape' => 'HyperParameterValue', ], ], ], 'HyperParameterSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterSpecification', ], 'max' => 100, 'min' => 0, ], 'HyperParameterTrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'StoppingCondition', ], 'members' => [ 'DefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TuningObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'HyperParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'StaticHyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'HyperParameterAlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'HyperParameterTuningResourceConfig' => [ 'shape' => 'HyperParameterTuningResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Environment' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentMap', ], ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'HyperParameterTrainingJobDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'max' => 10, 'min' => 1, ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentKey', ], 'value' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentValue', ], 'max' => 48, ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'HyperParameterTrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], ], 'HyperParameterTrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', 'TunedHyperParameters', ], 'members' => [ 'TrainingJobDefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'TunedHyperParameters' => [ 'shape' => 'HyperParameters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'shape' => 'FinalHyperParameterTuningJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], ], ], 'HyperParameterTuningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'Prioritized', ], ], 'HyperParameterTuningInstanceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], ], ], 'HyperParameterTuningInstanceConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningInstanceConfig', ], 'max' => 6, 'min' => 1, ], 'HyperParameterTuningJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*', ], 'HyperParameterTuningJobCompletionDetails' => [ 'type' => 'structure', 'members' => [ 'NumberOfTrainingJobsObjectiveNotImproving' => [ 'shape' => 'Integer', ], 'ConvergenceDetectedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterTuningJobConfig' => [ 'type' => 'structure', 'required' => [ 'Strategy', 'ResourceLimits', ], 'members' => [ 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'StrategyConfig' => [ 'shape' => 'HyperParameterTuningJobStrategyConfig', ], 'HyperParameterTuningJobObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], 'ParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'TrainingJobEarlyStoppingType' => [ 'shape' => 'TrainingJobEarlyStoppingType', ], 'TuningJobCompletionCriteria' => [ 'shape' => 'TuningJobCompletionCriteria', ], 'RandomSeed' => [ 'shape' => 'RandomSeed', ], ], ], 'HyperParameterTuningJobConsumedResources' => [ 'type' => 'structure', 'members' => [ 'RuntimeInSeconds' => [ 'shape' => 'Integer', ], ], ], 'HyperParameterTuningJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'HyperParameterTuningJobObjective' => [ 'type' => 'structure', 'required' => [ 'Type', 'MetricName', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'HyperParameterTuningJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'HyperParameterTuningJobObjectives' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobObjective', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'HyperParameterTuningJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'Status', 'CreationTime', ], ], 'HyperParameterTuningJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', 'Deleting', 'DeleteFailed', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'HyperbandStrategyConfig' => [ 'shape' => 'HyperbandStrategyConfig', ], ], ], 'HyperParameterTuningJobStrategyType' => [ 'type' => 'string', 'enum' => [ 'Bayesian', 'Random', 'Hyperband', 'Grid', ], ], 'HyperParameterTuningJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobSummary', ], ], 'HyperParameterTuningJobSummary' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobStatus', 'Strategy', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'type' => 'structure', 'required' => [ 'ParentHyperParameterTuningJobs', 'WarmStartType', ], 'members' => [ 'ParentHyperParameterTuningJobs' => [ 'shape' => 'ParentHyperParameterTuningJobs', ], 'WarmStartType' => [ 'shape' => 'HyperParameterTuningJobWarmStartType', ], ], ], 'HyperParameterTuningJobWarmStartType' => [ 'type' => 'string', 'enum' => [ 'IdenticalDataAndAlgorithm', 'TransferLearning', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 15768000, 'min' => 120, ], 'HyperParameterTuningResourceConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AllocationStrategy' => [ 'shape' => 'HyperParameterTuningAllocationStrategy', ], 'InstanceConfigs' => [ 'shape' => 'HyperParameterTuningInstanceConfigs', ], ], ], 'HyperParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterKey', ], 'value' => [ 'shape' => 'HyperParameterValue', ], 'max' => 100, 'min' => 0, ], 'HyperbandStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'MinResource' => [ 'shape' => 'HyperbandStrategyMinResource', ], 'MaxResource' => [ 'shape' => 'HyperbandStrategyMaxResource', ], ], ], 'HyperbandStrategyMaxResource' => [ 'type' => 'integer', 'min' => 1, ], 'HyperbandStrategyMinResource' => [ 'type' => 'integer', 'min' => 1, ], 'IamIdentity' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], 'PrincipalId' => [ 'shape' => 'String', ], 'SourceIdentity' => [ 'shape' => 'String', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 32, ], 'IdentityProviderOAuthSetting' => [ 'type' => 'structure', 'members' => [ 'DataSourceName' => [ 'shape' => 'DataSourceName', ], 'Status' => [ 'shape' => 'FeatureStatus', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'IdentityProviderOAuthSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdentityProviderOAuthSetting', ], 'max' => 20, ], 'Image' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageName', 'ImageStatus', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ImageArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$', ], 'ImageBaseImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'ImageClassificationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ImageConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryAccessMode', ], 'members' => [ 'RepositoryAccessMode' => [ 'shape' => 'RepositoryAccessMode', ], 'RepositoryAuthConfig' => [ 'shape' => 'RepositoryAuthConfig', ], ], ], 'ImageContainerImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImageDeleteProperty' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '(^DisplayName$)|(^Description$)', ], 'ImageDeletePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageDeleteProperty', ], 'max' => 2, ], 'ImageDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'ImageDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ImageDisplayName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^\\S(.*\\S)?$', ], 'ImageName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$', ], 'ImageNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9\\-.]+$', ], 'ImageSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'IMAGE_NAME', ], ], 'ImageSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageUri' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'ImageVersion' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageVersionArn', 'ImageVersionStatus', 'LastModifiedTime', 'Version', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], ], ], 'ImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)', ], 'ImageVersionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$', ], 'ImageVersionNumber' => [ 'type' => 'integer', 'min' => 0, ], 'ImageVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'VERSION', ], ], 'ImageVersionSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageVersion', ], ], 'Images' => [ 'type' => 'list', 'member' => [ 'shape' => 'Image', ], ], 'ImportHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubContentDocument', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ImportHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', 'HubContentArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], ], ], 'InferenceComponentArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'InferenceComponentComputeResourceRequirements' => [ 'type' => 'structure', 'required' => [ 'MinMemoryRequiredInMb', ], 'members' => [ 'NumberOfCpuCoresRequired' => [ 'shape' => 'NumberOfCpuCores', ], 'NumberOfAcceleratorDevicesRequired' => [ 'shape' => 'NumberOfAcceleratorDevices', ], 'MinMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], 'MaxMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], ], ], 'InferenceComponentContainerSpecification' => [ 'type' => 'structure', 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'DeployedImage' => [ 'shape' => 'DeployedImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentCopyCount' => [ 'type' => 'integer', 'min' => 0, ], 'InferenceComponentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$', ], 'InferenceComponentNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'InferenceComponentRuntimeConfig' => [ 'type' => 'structure', 'required' => [ 'CopyCount', ], 'members' => [ 'CopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'type' => 'structure', 'members' => [ 'DesiredCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], 'CurrentCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'InferenceComponentSpecification' => [ 'type' => 'structure', 'required' => [ 'ComputeResourceRequirements', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecification', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecificationSummary', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentStartupParameters' => [ 'type' => 'structure', 'members' => [ 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], ], ], 'InferenceComponentStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Failed', 'Deleting', ], ], 'InferenceComponentSummary' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'InferenceComponentArn', 'InferenceComponentName', 'EndpointArn', 'EndpointName', 'VariantName', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceComponentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceComponentSummary', ], ], 'InferenceExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'InferenceExecutionMode', ], ], ], 'InferenceExecutionMode' => [ 'type' => 'string', 'enum' => [ 'Serial', 'Direct', ], ], 'InferenceExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*', ], 'InferenceExperimentDataStorageConfig' => [ 'type' => 'structure', 'required' => [ 'Destination', ], 'members' => [ 'Destination' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'ContentType' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'InferenceExperimentDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceExperimentSummary', ], ], 'InferenceExperimentName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'InferenceExperimentSchedule' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceExperimentStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'Updating', 'Running', 'Starting', 'Stopping', 'Completed', 'Cancelled', ], ], 'InferenceExperimentStatusReason' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentStopDesiredState' => [ 'type' => 'string', 'enum' => [ 'Completed', 'Cancelled', ], ], 'InferenceExperimentSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'Status', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'InferenceExperimentType' => [ 'type' => 'string', 'enum' => [ 'ShadowMode', ], ], 'InferenceImage' => [ 'type' => 'string', 'max' => 256, ], 'InferenceMetrics' => [ 'type' => 'structure', 'required' => [ 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'InferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointConfiguration', 'ModelConfiguration', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'InferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendation', ], 'max' => 10, 'min' => 1, ], 'InferenceRecommendationsJob' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobDescription', 'JobType', 'JobArn', 'Status', 'CreationTime', 'RoleArn', 'LastModifiedTime', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'InferenceRecommendationsJobStep' => [ 'type' => 'structure', 'required' => [ 'StepType', 'JobName', 'Status', ], 'members' => [ 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'InferenceBenchmark' => [ 'shape' => 'RecommendationJobInferenceBenchmark', ], ], ], 'InferenceRecommendationsJobSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJobStep', ], ], 'InferenceRecommendationsJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJob', ], ], 'InferenceSpecification' => [ 'type' => 'structure', 'required' => [ 'Containers', ], 'members' => [ 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'InferenceSpecificationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'InfraCheckConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInfraCheck' => [ 'shape' => 'EnableInfraCheck', ], ], ], 'InitialInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InitialNumberOfUsers' => [ 'type' => 'integer', 'min' => 1, ], 'InitialTaskCount' => [ 'type' => 'integer', 'min' => 1, ], 'InputConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'Framework', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], 'Framework' => [ 'shape' => 'Framework', ], 'FrameworkVersion' => [ 'shape' => 'FrameworkVersion', ], ], ], 'InputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 20, 'min' => 1, ], 'InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'InputModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInputMode', ], 'min' => 1, ], 'InstanceGroup' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'InstanceGroupName', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'InstanceGroupName', ], ], ], 'InstanceGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.+', ], 'InstanceGroupNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupName', ], 'max' => 5, ], 'InstanceGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], 'max' => 5, ], 'InstanceMetadataServiceConfiguration' => [ 'type' => 'structure', 'required' => [ 'MinimumInstanceMetadataServiceVersion', ], 'members' => [ 'MinimumInstanceMetadataServiceVersion' => [ 'shape' => 'MinimumInstanceMetadataServiceVersion', ], ], ], 'InstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r6i.large', 'ml.r6i.xlarge', 'ml.r6i.2xlarge', 'ml.r6i.4xlarge', 'ml.r6i.8xlarge', 'ml.r6i.12xlarge', 'ml.r6i.16xlarge', 'ml.r6i.24xlarge', 'ml.r6i.32xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', 'ml.m6id.large', 'ml.m6id.xlarge', 'ml.m6id.2xlarge', 'ml.m6id.4xlarge', 'ml.m6id.8xlarge', 'ml.m6id.12xlarge', 'ml.m6id.16xlarge', 'ml.m6id.24xlarge', 'ml.m6id.32xlarge', 'ml.c6id.large', 'ml.c6id.xlarge', 'ml.c6id.2xlarge', 'ml.c6id.4xlarge', 'ml.c6id.8xlarge', 'ml.c6id.12xlarge', 'ml.c6id.16xlarge', 'ml.c6id.24xlarge', 'ml.c6id.32xlarge', 'ml.r6id.large', 'ml.r6id.xlarge', 'ml.r6id.2xlarge', 'ml.r6id.4xlarge', 'ml.r6id.8xlarge', 'ml.r6id.12xlarge', 'ml.r6id.16xlarge', 'ml.r6id.24xlarge', 'ml.r6id.32xlarge', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'IntegerParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'IntegerParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameterRange', ], 'max' => 30, 'min' => 0, ], 'InvocationEndTime' => [ 'type' => 'timestamp', ], 'InvocationStartTime' => [ 'type' => 'timestamp', ], 'InvocationsMaxRetries' => [ 'type' => 'integer', 'max' => 3, 'min' => 0, ], 'InvocationsTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 1, ], 'IotRoleAlias' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'ItemIdentifierAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'JobDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'JobReferenceCode' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.+', ], 'JobReferenceCodeContains' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'JobType' => [ 'type' => 'string', 'enum' => [ 'TRAINING', 'INFERENCE', 'NOTEBOOK_KERNEL', ], ], 'JoinSource' => [ 'type' => 'string', 'enum' => [ 'Input', 'None', ], ], 'JsonContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'JsonContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonContentType', ], 'max' => 10, 'min' => 1, ], 'JsonPath' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'JupyterLabAppImageConfig' => [ 'type' => 'structure', 'members' => [ 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], 'ContainerConfig' => [ 'shape' => 'ContainerConfig', ], ], ], 'JupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'JupyterServerAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'KeepAlivePeriodInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'KendraSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'KernelDisplayName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelGatewayAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'KernelGatewayImageConfig' => [ 'type' => 'structure', 'required' => [ 'KernelSpecs', ], 'members' => [ 'KernelSpecs' => [ 'shape' => 'KernelSpecs', ], 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], ], ], 'KernelName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelSpec' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'KernelName', ], 'DisplayName' => [ 'shape' => 'KernelDisplayName', ], ], ], 'KernelSpecs' => [ 'type' => 'list', 'member' => [ 'shape' => 'KernelSpec', ], 'max' => 5, 'min' => 1, ], 'Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '^[a-zA-Z0-9:/_-]*$', ], 'LabelAttributeName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}', ], 'LabelCounter' => [ 'type' => 'integer', 'min' => 0, ], 'LabelCounters' => [ 'type' => 'structure', 'members' => [ 'TotalLabeled' => [ 'shape' => 'LabelCounter', ], 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'MachineLabeled' => [ 'shape' => 'LabelCounter', ], 'FailedNonRetryableError' => [ 'shape' => 'LabelCounter', ], 'Unlabeled' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelCountersForWorkteam' => [ 'type' => 'structure', 'members' => [ 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'PendingHuman' => [ 'shape' => 'LabelCounter', ], 'Total' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:.*', ], 'LabelingJobAlgorithmsConfig' => [ 'type' => 'structure', 'required' => [ 'LabelingJobAlgorithmSpecificationArn', ], 'members' => [ 'LabelingJobAlgorithmSpecificationArn' => [ 'shape' => 'LabelingJobAlgorithmSpecificationArn', ], 'InitialActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], 'LabelingJobResourceConfig' => [ 'shape' => 'LabelingJobResourceConfig', ], ], ], 'LabelingJobArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*', ], 'LabelingJobDataAttributes' => [ 'type' => 'structure', 'members' => [ 'ContentClassifiers' => [ 'shape' => 'ContentClassifiers', ], ], ], 'LabelingJobDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'LabelingJobS3DataSource', ], 'SnsDataSource' => [ 'shape' => 'LabelingJobSnsDataSource', ], ], ], 'LabelingJobForWorkteamSummary' => [ 'type' => 'structure', 'required' => [ 'JobReferenceCode', 'WorkRequesterAccountId', 'CreationTime', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'WorkRequesterAccountId' => [ 'shape' => 'AccountId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LabelCounters' => [ 'shape' => 'LabelCountersForWorkteam', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], ], ], 'LabelingJobForWorkteamSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobForWorkteamSummary', ], ], 'LabelingJobInputConfig' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'LabelingJobDataSource', ], 'DataAttributes' => [ 'shape' => 'LabelingJobDataAttributes', ], ], ], 'LabelingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'LabelingJobOutput' => [ 'type' => 'structure', 'required' => [ 'OutputDatasetS3Uri', ], 'members' => [ 'OutputDatasetS3Uri' => [ 'shape' => 'S3Uri', ], 'FinalActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'LabelingJobOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobResourceConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'LabelingJobS3DataSource' => [ 'type' => 'structure', 'required' => [ 'ManifestS3Uri', ], 'members' => [ 'ManifestS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'LabelingJobSnsDataSource' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'LabelingJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxHumanLabeledObjectCount' => [ 'shape' => 'MaxHumanLabeledObjectCount', ], 'MaxPercentageOfInputDatasetLabeled' => [ 'shape' => 'MaxPercentageOfInputDatasetLabeled', ], ], ], 'LabelingJobSummary' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelingJobArn', 'CreationTime', 'LastModifiedTime', 'LabelingJobStatus', 'LabelCounters', 'WorkteamArn', 'PreHumanTaskLambdaArn', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], ], ], 'LabelingJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobSummary', ], ], 'LambdaFunctionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*', ], 'LambdaStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'LandingUri' => [ 'type' => 'string', 'max' => 1023, ], 'LastModifiedTime' => [ 'type' => 'timestamp', ], 'LastUpdateStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'LastUpdateStatusValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'LastUpdateStatusValue' => [ 'type' => 'string', 'enum' => [ 'Successful', 'Failed', 'InProgress', ], ], 'LifecycleConfigArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], 'LineageEntityParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'StringParameterValue', ], 'max' => 30, ], 'LineageGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*', ], 'LineageGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'LineageGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageGroupSummary', ], ], 'LineageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'LineageType' => [ 'type' => 'string', 'enum' => [ 'TrialComponent', 'Artifact', 'Context', 'Action', ], ], 'ListActionsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ActionType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortActionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlgorithmsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'AlgorithmSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAlgorithmsOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSummaryList', ], 'members' => [ 'AlgorithmSummaryList' => [ 'shape' => 'AlgorithmSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageVersionAliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppImageConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'AppImageConfigName', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'AppImageConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAppImageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AppImageConfigs' => [ 'shape' => 'AppImageConfigList', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'AppSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameEquals' => [ 'shape' => 'UserProfileName', ], 'SpaceNameEquals' => [ 'shape' => 'SpaceName', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'members' => [ 'Apps' => [ 'shape' => 'AppList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortArtifactsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListArtifactsResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactSummaries' => [ 'shape' => 'ArtifactSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortAssociationsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationSummaries' => [ 'shape' => 'AssociationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'AutoMLNameContains', ], 'StatusEquals' => [ 'shape' => 'AutoMLJobStatus', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'AutoMLSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobSummaries', ], 'members' => [ 'AutoMLJobSummaries' => [ 'shape' => 'AutoMLJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'StatusEquals' => [ 'shape' => 'CandidateStatus', ], 'CandidateNameEquals' => [ 'shape' => 'CandidateName', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'CandidateSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResultsForTrials', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'Candidates', ], 'members' => [ 'Candidates' => [ 'shape' => 'AutoMLCandidates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListClusterNodesRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'InstanceGroupNameContains' => [ 'shape' => 'ClusterInstanceGroupName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClusterNodesResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterNodeSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterNodeSummaries' => [ 'shape' => 'ClusterNodeSummaries', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterSummaries' => [ 'shape' => 'ClusterSummaries', ], ], ], 'ListCodeRepositoriesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'CodeRepositoryNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'CodeRepositorySortBy', ], 'SortOrder' => [ 'shape' => 'CodeRepositorySortOrder', ], ], ], 'ListCodeRepositoriesOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositorySummaryList', ], 'members' => [ 'CodeRepositorySummaryList' => [ 'shape' => 'CodeRepositorySummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'CompilationJobStatus', ], 'SortBy' => [ 'shape' => 'ListCompilationJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListCompilationJobsResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobSummaries', ], 'members' => [ 'CompilationJobSummaries' => [ 'shape' => 'CompilationJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListContextsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortContextsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListContextsResponse' => [ 'type' => 'structure', 'members' => [ 'ContextSummaries' => [ 'shape' => 'ContextSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListDataQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListDeviceFleetsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListDeviceFleetsResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetSummaries', ], 'members' => [ 'DeviceFleetSummaries' => [ 'shape' => 'DeviceFleetSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'LatestHeartbeatAfter' => [ 'shape' => 'Timestamp', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceSummaries', ], 'members' => [ 'DeviceSummaries' => [ 'shape' => 'DeviceSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Domains' => [ 'shape' => 'DomainList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'DeviceFleetNameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListEdgeDeploymentPlansSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgeDeploymentPlansResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanSummaries', ], 'members' => [ 'EdgeDeploymentPlanSummaries' => [ 'shape' => 'EdgeDeploymentPlanSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DEVICE_FLEET_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListEdgePackagingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelNameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'EdgePackagingJobStatus', ], 'SortBy' => [ 'shape' => 'ListEdgePackagingJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgePackagingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobSummaries', ], 'members' => [ 'EdgePackagingJobSummaries' => [ 'shape' => 'EdgePackagingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgePackagingJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'MODEL_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'STATUS', ], ], 'ListEndpointConfigsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointConfigSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListEndpointConfigsOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigs', ], 'members' => [ 'EndpointConfigs' => [ 'shape' => 'EndpointConfigSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListEndpointsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'EndpointStatus', ], ], ], 'ListEndpointsOutput' => [ 'type' => 'structure', 'required' => [ 'Endpoints', ], 'members' => [ 'Endpoints' => [ 'shape' => 'EndpointSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentSummaries' => [ 'shape' => 'ExperimentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'FeatureGroupNameContains', ], 'FeatureGroupStatusEquals' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatusEquals' => [ 'shape' => 'OfflineStoreStatusValue', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'SortOrder' => [ 'shape' => 'FeatureGroupSortOrder', ], 'SortBy' => [ 'shape' => 'FeatureGroupSortBy', ], 'MaxResults' => [ 'shape' => 'FeatureGroupMaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupSummaries', ], 'members' => [ 'FeatureGroupSummaries' => [ 'shape' => 'FeatureGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListFlowDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionSummaries', ], 'members' => [ 'FlowDefinitionSummaries' => [ 'shape' => 'FlowDefinitionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'MinVersion' => [ 'shape' => 'HubContentVersion', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsResponse' => [ 'type' => 'structure', 'required' => [ 'HubSummaries', ], 'members' => [ 'HubSummaries' => [ 'shape' => 'HubInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHumanTaskUisRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListHumanTaskUisResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiSummaries', ], 'members' => [ 'HumanTaskUiSummaries' => [ 'shape' => 'HumanTaskUiSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHyperParameterTuningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'SortBy' => [ 'shape' => 'HyperParameterTuningJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'HyperParameterTuningJobStatus', ], ], ], 'ListHyperParameterTuningJobsResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobSummaries', ], 'members' => [ 'HyperParameterTuningJobSummaries' => [ 'shape' => 'HyperParameterTuningJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ImageVersionSortOrder', ], ], ], 'ListImageVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersions' => [ 'shape' => 'ImageVersions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImagesRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ImageNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageSortBy', ], 'SortOrder' => [ 'shape' => 'ImageSortOrder', ], ], ], 'ListImagesResponse' => [ 'type' => 'structure', 'members' => [ 'Images' => [ 'shape' => 'Images', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceComponentsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'InferenceComponentSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'InferenceComponentNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'InferenceComponentStatus', ], 'EndpointNameEquals' => [ 'shape' => 'EndpointName', ], 'VariantNameEquals' => [ 'shape' => 'VariantName', ], ], ], 'ListInferenceComponentsOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponents', ], 'members' => [ 'InferenceComponents' => [ 'shape' => 'InferenceComponentSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInferenceExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'StatusEquals' => [ 'shape' => 'InferenceExperimentStatus', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortInferenceExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListInferenceExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceExperiments' => [ 'shape' => 'InferenceExperimentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'InferenceRecommendationsJobSteps', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'RecommendationJobStatus', ], 'SortBy' => [ 'shape' => 'ListInferenceRecommendationsJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelNameEquals' => [ 'shape' => 'ModelName', ], 'ModelPackageVersionArnEquals' => [ 'shape' => 'ModelPackageArn', ], ], ], 'ListInferenceRecommendationsJobsResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobs', ], 'members' => [ 'InferenceRecommendationsJobs' => [ 'shape' => 'InferenceRecommendationsJobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'JobReferenceCodeContains' => [ 'shape' => 'JobReferenceCodeContains', ], 'SortBy' => [ 'shape' => 'ListLabelingJobsForWorkteamSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListLabelingJobsForWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobSummaryList', ], 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobForWorkteamSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ListLabelingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'StatusEquals' => [ 'shape' => 'LabelingJobStatus', ], ], ], 'ListLabelingJobsResponse' => [ 'type' => 'structure', 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLineageEntityParameterKey' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameterValue', ], ], 'ListLineageGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortLineageGroupsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListLineageGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupSummaries' => [ 'shape' => 'LineageGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'ListModelBiasJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelBiasJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModelCardExportJobNameContains' => [ 'shape' => 'EntityName', ], 'StatusEquals' => [ 'shape' => 'ModelCardExportJobStatus', ], 'SortBy' => [ 'shape' => 'ModelCardExportJobSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardExportJobSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelCardExportJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobSummaries', ], 'members' => [ 'ModelCardExportJobSummaries' => [ 'shape' => 'ModelCardExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardVersionSummaryList', ], 'members' => [ 'ModelCardVersionSummaryList' => [ 'shape' => 'ModelCardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardSummaries', ], 'members' => [ 'ModelCardSummaries' => [ 'shape' => 'ModelCardSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelMetadataRequest' => [ 'type' => 'structure', 'members' => [ 'SearchExpression' => [ 'shape' => 'ModelMetadataSearchExpression', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'ModelMetadataSummaries', ], 'members' => [ 'ModelMetadataSummaries' => [ 'shape' => 'ModelMetadataSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackageGroupsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageGroupSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackageGroupsOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupSummaryList', ], 'members' => [ 'ModelPackageGroupSummaryList' => [ 'shape' => 'ModelPackageGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackagesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageType' => [ 'shape' => 'ModelPackageType', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackagesOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageSummaryList', ], 'members' => [ 'ModelPackageSummaryList' => [ 'shape' => 'ModelPackageSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ModelSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ModelNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelsOutput' => [ 'type' => 'structure', 'required' => [ 'Models', ], 'members' => [ 'Models' => [ 'shape' => 'ModelSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListMonitoringAlertHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'SortBy' => [ 'shape' => 'MonitoringAlertHistorySortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'ListMonitoringAlertHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertHistory' => [ 'shape' => 'MonitoringAlertHistoryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringAlertsRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMonitoringAlertsResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringExecutionsRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringExecutionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ScheduledTimeBefore' => [ 'shape' => 'Timestamp', ], 'ScheduledTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ExecutionStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringExecutionsResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringExecutionSummaries', ], 'members' => [ 'MonitoringExecutionSummaries' => [ 'shape' => 'MonitoringExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringSchedulesRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringScheduleSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringSchedulesResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleSummaries', ], 'members' => [ 'MonitoringScheduleSummaries' => [ 'shape' => 'MonitoringScheduleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], ], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstanceLifecycleConfigs' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummaryList', ], ], ], 'ListNotebookInstancesInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'StatusEquals' => [ 'shape' => 'NotebookInstanceStatus', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepositoryContains' => [ 'shape' => 'CodeRepositoryContains', ], 'AdditionalCodeRepositoryEquals' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], ], ], 'ListNotebookInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstances' => [ 'shape' => 'NotebookInstanceSummaryList', ], ], ], 'ListPipelineExecutionStepsRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListPipelineExecutionStepsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSteps' => [ 'shape' => 'PipelineExecutionStepList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineExecutionsRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelineExecutionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineExecutionsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSummaries' => [ 'shape' => 'PipelineExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineParametersForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineParametersForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineNamePrefix' => [ 'shape' => 'PipelineName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelinesBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineSummaries' => [ 'shape' => 'PipelineSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProcessingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'String', ], 'StatusEquals' => [ 'shape' => 'ProcessingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListProcessingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobSummaries', ], 'members' => [ 'ProcessingJobSummaries' => [ 'shape' => 'ProcessingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProjectsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ProjectEntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ProjectSortBy', ], 'SortOrder' => [ 'shape' => 'ProjectSortOrder', ], ], ], 'ListProjectsOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectSummaryList', ], 'members' => [ 'ProjectSummaryList' => [ 'shape' => 'ProjectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'ResourceCatalogName', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'ResourceCatalogSortOrder', ], 'SortBy' => [ 'shape' => 'ResourceCatalogSortBy', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceCatalogs' => [ 'shape' => 'ResourceCatalogList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSpacesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SpaceSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'SpaceNameContains' => [ 'shape' => 'SpaceName', ], ], ], 'ListSpacesResponse' => [ 'type' => 'structure', 'members' => [ 'Spaces' => [ 'shape' => 'SpaceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStageDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ExcludeDevicesDeployedInOtherStage' => [ 'shape' => 'Boolean', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'ListStageDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceDeploymentSummaries', ], 'members' => [ 'DeviceDeploymentSummaries' => [ 'shape' => 'DeviceDeploymentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStudioLifecycleConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'StudioLifecycleConfigName', ], 'AppTypeEquals' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'StudioLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListStudioLifecycleConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'StudioLifecycleConfigs' => [ 'shape' => 'StudioLifecycleConfigsList', ], ], ], 'ListSubscribedWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListSubscribedWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteams', ], 'members' => [ 'SubscribedWorkteams' => [ 'shape' => 'SubscribedWorkteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListTagsMaxResults', ], ], ], 'ListTagsMaxResults' => [ 'type' => 'integer', 'min' => 50, ], 'ListTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'TrainingJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'HyperParameterTrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'WarmPoolStatusEquals' => [ 'shape' => 'WarmPoolResourceStatus', ], ], ], 'ListTrainingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'TrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTransformJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TransformJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListTransformJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobSummaries', ], 'members' => [ 'TransformJobSummaries' => [ 'shape' => 'TransformJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentKey256' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentKey256', ], ], 'ListTrialComponentsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'SourceArn' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialComponentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialSummaries' => [ 'shape' => 'TrialSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'UserProfileSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameContains' => [ 'shape' => 'UserProfileName', ], ], ], 'ListUserProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfiles' => [ 'shape' => 'UserProfileList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkforcesSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkforceName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkforcesResponse' => [ 'type' => 'structure', 'required' => [ 'Workforces', ], 'members' => [ 'Workforces' => [ 'shape' => 'Workforces', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'ListWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkteamsSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'Workteams', ], 'members' => [ 'Workteams' => [ 'shape' => 'Workteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkteamsSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'Long' => [ 'type' => 'long', ], 'MLFramework' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingMinInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxCandidates' => [ 'type' => 'integer', 'max' => 750, 'min' => 1, ], 'MaxConcurrentInvocationsPerInstance' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxConcurrentTaskCount' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'MaxConcurrentTransforms' => [ 'type' => 'integer', 'min' => 0, ], 'MaxHumanLabeledObjectCount' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'type' => 'integer', 'min' => 3, ], 'MaxParallelExecutionSteps' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxPayloadInMB' => [ 'type' => 'integer', 'min' => 0, ], 'MaxPendingTimeInSeconds' => [ 'type' => 'integer', 'max' => 2419200, 'min' => 7200, ], 'MaxPercentageOfInputDatasetLabeled' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxWaitTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaximumExecutionTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 600, ], 'MaximumRetryAttempts' => [ 'type' => 'integer', 'max' => 30, 'min' => 1, ], 'MediaType' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[-\\w]+\\/[-\\w+]+$', ], 'MemberDefinition' => [ 'type' => 'structure', 'members' => [ 'CognitoMemberDefinition' => [ 'shape' => 'CognitoMemberDefinition', ], 'OidcMemberDefinition' => [ 'shape' => 'OidcMemberDefinition', ], ], ], 'MemberDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberDefinition', ], 'max' => 10, 'min' => 1, ], 'MemoryInMb' => [ 'type' => 'integer', 'min' => 128, ], 'MetadataProperties' => [ 'type' => 'structure', 'members' => [ 'CommitId' => [ 'shape' => 'MetadataPropertyValue', ], 'Repository' => [ 'shape' => 'MetadataPropertyValue', ], 'GeneratedBy' => [ 'shape' => 'MetadataPropertyValue', ], 'ProjectId' => [ 'shape' => 'MetadataPropertyValue', ], ], ], 'MetadataPropertyValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'MetricData' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'Float', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatum', ], 'max' => 40, 'min' => 0, ], 'MetricDatum' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'Float', ], 'Set' => [ 'shape' => 'MetricSetSource', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricExtendedEnum', ], ], ], 'MetricDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Regex', ], 'members' => [ 'Name' => [ 'shape' => 'MetricName', ], 'Regex' => [ 'shape' => 'MetricRegex', ], ], ], 'MetricDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDefinition', ], 'max' => 40, 'min' => 0, ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'MetricRegex' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.+', ], 'MetricSetSource' => [ 'type' => 'string', 'enum' => [ 'Train', 'Validation', 'Test', ], ], 'MetricSpecification' => [ 'type' => 'structure', 'members' => [ 'Predefined' => [ 'shape' => 'PredefinedMetricSpecification', ], 'Customized' => [ 'shape' => 'CustomizedMetricSpecification', ], ], 'union' => true, ], 'MetricValue' => [ 'type' => 'float', ], 'MetricsSource' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'type' => 'string', 'max' => 1, 'pattern' => '1|2', ], 'Model' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'ModelAccessConfig' => [ 'type' => 'structure', 'required' => [ 'AcceptEula', ], 'members' => [ 'AcceptEula' => [ 'shape' => 'AcceptEula', ], ], ], 'ModelApprovalStatus' => [ 'type' => 'string', 'enum' => [ 'Approved', 'Rejected', 'PendingManualApproval', ], ], 'ModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*', ], 'ModelArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ModelArtifacts', ], 'members' => [ 'S3ModelArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelBiasAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelBiasBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelBiasJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelCacheSetting' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], 'ModelPackageGroupName' => [ 'shape' => 'String', ], ], ], 'ModelCardArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardContent' => [ 'type' => 'string', 'max' => 100000, 'min' => 0, 'pattern' => '.*', 'sensitive' => true, ], 'ModelCardExportArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ExportArtifacts', ], 'members' => [ 'S3ExportArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardExportJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardExportJobSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ModelCardExportJobSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', ], ], 'ModelCardExportJobSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardExportJobSummary', ], ], 'ModelCardExportOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})', ], 'ModelCardProcessingStatus' => [ 'type' => 'string', 'enum' => [ 'DeleteInProgress', 'DeletePending', 'ContentDeleted', 'ExportJobsDeleted', 'DeleteCompleted', 'DeleteFailed', ], ], 'ModelCardSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ModelCardSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelCardSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardStatus' => [ 'type' => 'string', 'enum' => [ 'Draft', 'PendingReview', 'Approved', 'Archived', ], ], 'ModelCardSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardSummary', ], ], 'ModelCardVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'Version', ], ], 'ModelCardVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'ModelCardVersion', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardVersionSummary', ], ], 'ModelClientConfig' => [ 'type' => 'structure', 'members' => [ 'InvocationsTimeoutInSeconds' => [ 'shape' => 'InvocationsTimeoutInSeconds', ], 'InvocationsMaxRetries' => [ 'shape' => 'InvocationsMaxRetries', ], ], ], 'ModelCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ModelConfiguration' => [ 'type' => 'structure', 'members' => [ 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameters' => [ 'shape' => 'EnvironmentParameters', ], 'CompilationJobName' => [ 'shape' => 'RecommendationJobCompilationJobName', ], ], ], 'ModelDashboardEndpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'ModelDashboardEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardEndpoint', ], ], 'ModelDashboardIndicatorAction' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'ModelDashboardModel' => [ 'type' => 'structure', 'members' => [ 'Model' => [ 'shape' => 'Model', ], 'Endpoints' => [ 'shape' => 'ModelDashboardEndpoints', ], 'LastBatchTransformJob' => [ 'shape' => 'TransformJob', ], 'MonitoringSchedules' => [ 'shape' => 'ModelDashboardMonitoringSchedules', ], 'ModelCard' => [ 'shape' => 'ModelDashboardModelCard', ], ], ], 'ModelDashboardModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], ], ], 'ModelDashboardMonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelDashboardMonitoringSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardMonitoringSchedule', ], ], 'ModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3ModelDataSource', ], ], ], 'ModelDeployConfig' => [ 'type' => 'structure', 'members' => [ 'AutoGenerateEndpointName' => [ 'shape' => 'AutoGenerateEndpointName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDeployResult' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDigests' => [ 'type' => 'structure', 'members' => [ 'ArtifactDigest' => [ 'shape' => 'ArtifactDigest', ], ], ], 'ModelExplainabilityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelExplainabilityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelExplainabilityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelInfrastructureConfig' => [ 'type' => 'structure', 'required' => [ 'InfrastructureType', 'RealTimeInferenceConfig', ], 'members' => [ 'InfrastructureType' => [ 'shape' => 'ModelInfrastructureType', ], 'RealTimeInferenceConfig' => [ 'shape' => 'RealTimeInferenceConfig', ], ], ], 'ModelInfrastructureType' => [ 'type' => 'string', 'enum' => [ 'RealTimeInference', ], ], 'ModelInput' => [ 'type' => 'structure', 'required' => [ 'DataInputConfig', ], 'members' => [ 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'ModelInsightsLocation' => [ 'type' => 'string', 'min' => 1, ], 'ModelLatencyThreshold' => [ 'type' => 'structure', 'members' => [ 'Percentile' => [ 'shape' => 'String64', ], 'ValueInMilliseconds' => [ 'shape' => 'Integer', ], ], ], 'ModelLatencyThresholds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelLatencyThreshold', ], 'max' => 1, 'min' => 1, ], 'ModelMetadataFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'ModelMetadataFilterType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ModelMetadataFilterType' => [ 'type' => 'string', 'enum' => [ 'Domain', 'Framework', 'Task', 'FrameworkVersion', ], ], 'ModelMetadataFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataFilter', ], 'max' => 4, 'min' => 1, ], 'ModelMetadataSearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ModelMetadataFilters', ], ], ], 'ModelMetadataSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataSummary', ], ], 'ModelMetadataSummary' => [ 'type' => 'structure', 'required' => [ 'Domain', 'Framework', 'Task', 'Model', 'FrameworkVersion', ], 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Model' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], ], ], 'ModelMetrics' => [ 'type' => 'structure', 'members' => [ 'ModelQuality' => [ 'shape' => 'ModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'ModelDataQuality', ], 'Bias' => [ 'shape' => 'Bias', ], 'Explainability' => [ 'shape' => 'Explainability', ], ], ], 'ModelName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'ModelPackage' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'ModelPackageArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$', ], 'ModelPackageArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageArn', ], 'max' => 100, 'min' => 1, ], 'ModelPackageContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', ], 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageDigest' => [ 'shape' => 'ImageDigest', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelInput' => [ 'shape' => 'ModelInput', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'ModelPackageFrameworkVersion', ], 'NearestModelName' => [ 'shape' => 'String', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'ModelPackageContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageContainerDefinition', ], 'max' => 15, 'min' => 1, ], 'ModelPackageFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'ModelPackageGroup' => [ 'type' => 'structure', 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ModelPackageGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$', ], 'ModelPackageGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', 'DeleteFailed', ], ], 'ModelPackageGroupSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'ModelPackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageGroupSummary', ], ], 'ModelPackageSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageSourceUri' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}', ], 'ModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'ModelPackageStatusDetails' => [ 'type' => 'structure', 'required' => [ 'ValidationStatuses', ], 'members' => [ 'ValidationStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], ], ], 'ModelPackageStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedModelPackageStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'ModelPackageStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageStatusItem', ], ], 'ModelPackageSummaries' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageSummary', ], ], 'ModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'ModelPackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageSummary', ], ], 'ModelPackageType' => [ 'type' => 'string', 'enum' => [ 'Versioned', 'Unversioned', 'Both', ], ], 'ModelPackageValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TransformJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'ModelPackageValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageValidationProfile', ], 'max' => 1, 'min' => 0, ], 'ModelPackageValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'ModelPackageValidationProfiles', ], ], ], 'ModelPackageVersion' => [ 'type' => 'integer', 'min' => 1, ], 'ModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'ProblemType' => [ 'shape' => 'MonitoringProblemType', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelQualityJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelRegisterSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'CrossAccountModelRegisterRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ModelSetupTime' => [ 'type' => 'integer', 'min' => 0, ], 'ModelSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelArn', 'CreationTime', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelSummary', ], ], 'ModelVariantAction' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Remove', 'Promote', ], ], 'ModelVariantActionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelVariantName', ], 'value' => [ 'shape' => 'ModelVariantAction', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], ], ], 'ModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfig', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfigSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', 'Status', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], 'Status' => [ 'shape' => 'ModelVariantStatus', ], ], ], 'ModelVariantConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfigSummary', ], ], 'ModelVariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelVariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'InService', 'Deleting', 'Deleted', ], ], 'MonitoringAlertActions' => [ 'type' => 'structure', 'members' => [ 'ModelDashboardIndicator' => [ 'shape' => 'ModelDashboardIndicatorAction', ], ], ], 'MonitoringAlertHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertHistorySummary', ], ], 'MonitoringAlertHistorySortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', ], ], 'MonitoringAlertHistorySummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'CreationTime', 'AlertStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'MonitoringAlertName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringAlertStatus' => [ 'type' => 'string', 'enum' => [ 'InAlert', 'OK', ], ], 'MonitoringAlertSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringAlertName', 'CreationTime', 'LastModifiedTime', 'AlertStatus', 'DatapointsToAlert', 'EvaluationPeriod', 'Actions', ], 'members' => [ 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], 'Actions' => [ 'shape' => 'MonitoringAlertActions', ], ], ], 'MonitoringAlertSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertSummary', ], 'max' => 100, 'min' => 1, ], 'MonitoringAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'MonitoringClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringConstraintsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 50, 'min' => 1, ], 'MonitoringCsvDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringDatapointsToAlert' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Csv' => [ 'shape' => 'MonitoringCsvDatasetFormat', ], 'Json' => [ 'shape' => 'MonitoringJsonDatasetFormat', ], 'Parquet' => [ 'shape' => 'MonitoringParquetDatasetFormat', ], ], ], 'MonitoringEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 50, ], 'MonitoringEvaluationPeriod' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringExecutionSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'ScheduledTime', 'Status', ], ], 'MonitoringExecutionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'ScheduledTime', 'CreationTime', 'LastModifiedTime', 'MonitoringExecutionStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringExecutionStatus' => [ 'shape' => 'ExecutionStatus', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringExecutionSummary', ], ], 'MonitoringGroundTruthS3Input' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], ], ], 'MonitoringInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'MonitoringInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringInput', ], 'max' => 1, 'min' => 1, ], 'MonitoringJobDefinition' => [ 'type' => 'structure', 'required' => [ 'MonitoringInputs', 'MonitoringOutputConfig', 'MonitoringResources', 'MonitoringAppSpecification', 'RoleArn', ], 'members' => [ 'BaselineConfig' => [ 'shape' => 'MonitoringBaselineConfig', ], 'MonitoringInputs' => [ 'shape' => 'MonitoringInputs', ], 'MonitoringOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'MonitoringResources' => [ 'shape' => 'MonitoringResources', ], 'MonitoringAppSpecification' => [ 'shape' => 'MonitoringAppSpecification', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MonitoringJobDefinitionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringJobDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringJobDefinitionSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'MonitoringJobDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringJobDefinitionName', 'MonitoringJobDefinitionArn', 'CreationTime', 'EndpointName', ], 'members' => [ 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringJobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'MonitoringJobDefinitionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringJobDefinitionSummary', ], ], 'MonitoringJsonDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Line' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'MonitoringNetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'MonitoringOutput' => [ 'type' => 'structure', 'required' => [ 'S3Output', ], 'members' => [ 'S3Output' => [ 'shape' => 'MonitoringS3Output', ], ], ], 'MonitoringOutputConfig' => [ 'type' => 'structure', 'required' => [ 'MonitoringOutputs', ], 'members' => [ 'MonitoringOutputs' => [ 'shape' => 'MonitoringOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringOutput', ], 'max' => 1, 'min' => 1, ], 'MonitoringParquetDatasetFormat' => [ 'type' => 'structure', 'members' => [], ], 'MonitoringProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'MonitoringResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'MonitoringClusterConfig', ], ], ], 'MonitoringS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', ], 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'MonitoringS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'MonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'MonitoringScheduleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringScheduleConfig' => [ 'type' => 'structure', 'members' => [ 'ScheduleConfig' => [ 'shape' => 'ScheduleConfig', ], 'MonitoringJobDefinition' => [ 'shape' => 'MonitoringJobDefinition', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringSchedule', ], ], 'MonitoringScheduleName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringScheduleSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'MonitoringScheduleSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleArn', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringScheduleSummary', ], ], 'MonitoringStatisticsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MonitoringMaxRuntimeInSeconds', ], ], ], 'MonitoringTimeOffsetString' => [ 'type' => 'string', 'max' => 15, 'min' => 1, 'pattern' => '^.?P.*', ], 'MonitoringType' => [ 'type' => 'string', 'enum' => [ 'DataQuality', 'ModelQuality', 'ModelBias', 'ModelExplainability', ], ], 'MountPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^\\/.*', ], 'MultiModelConfig' => [ 'type' => 'structure', 'members' => [ 'ModelCacheSetting' => [ 'shape' => 'ModelCacheSetting', ], ], ], 'NameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'NeoVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'NeoVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'NeoVpcSubnets', ], ], ], 'NeoVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'NeoVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'NestedFilters' => [ 'type' => 'structure', 'required' => [ 'NestedPropertyName', 'Filters', ], 'members' => [ 'NestedPropertyName' => [ 'shape' => 'ResourcePropertyName', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'NestedFiltersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NestedFilters', ], 'max' => 20, 'min' => 1, ], 'NetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'NonEmptyString256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(?!\\s*$).+', ], 'NonEmptyString64' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^(?!\\s*$).+', ], 'NotebookInstanceAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'NotebookInstanceAcceleratorTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceAcceleratorType', ], ], 'NotebookInstanceArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'NotebookInstanceLifecycleConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleHook', ], 'max' => 1, ], 'NotebookInstanceLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', 'NotebookInstanceLifecycleConfigArn', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummary', ], ], 'NotebookInstanceLifecycleHook' => [ 'type' => 'structure', 'members' => [ 'Content' => [ 'shape' => 'NotebookInstanceLifecycleConfigContent', ], ], ], 'NotebookInstanceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'NotebookInstanceSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InService', 'Stopping', 'Stopped', 'Failed', 'Deleting', 'Updating', ], ], 'NotebookInstanceSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'NotebookInstanceArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], ], ], 'NotebookInstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceSummary', ], ], 'NotebookInstanceUrl' => [ 'type' => 'string', ], 'NotebookInstanceVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'NotebookOutputOption' => [ 'type' => 'string', 'enum' => [ 'Allowed', 'Disabled', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'NotificationTopicArn' => [ 'shape' => 'NotificationTopicArn', ], ], ], 'NotificationTopicArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*', ], 'NumberOfAcceleratorDevices' => [ 'type' => 'float', 'min' => 1, ], 'NumberOfCpuCores' => [ 'type' => 'float', 'min' => 0.25, ], 'NumberOfHumanWorkersPerDataObject' => [ 'type' => 'integer', 'max' => 9, 'min' => 1, ], 'NumberOfSteps' => [ 'type' => 'integer', 'min' => 1, ], 'ObjectiveStatus' => [ 'type' => 'string', 'enum' => [ 'Succeeded', 'Pending', 'Failed', ], ], 'ObjectiveStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'ObjectiveStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Succeeded' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Pending' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Failed' => [ 'shape' => 'ObjectiveStatusCounter', ], ], ], 'OfflineStoreConfig' => [ 'type' => 'structure', 'required' => [ 'S3StorageConfig', ], 'members' => [ 'S3StorageConfig' => [ 'shape' => 'S3StorageConfig', ], 'DisableGlueTableCreation' => [ 'shape' => 'Boolean', ], 'DataCatalogConfig' => [ 'shape' => 'DataCatalogConfig', ], 'TableFormat' => [ 'shape' => 'TableFormat', ], ], ], 'OfflineStoreStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'OfflineStoreStatusValue', ], 'BlockedReason' => [ 'shape' => 'BlockedReason', ], ], ], 'OfflineStoreStatusValue' => [ 'type' => 'string', 'enum' => [ 'Active', 'Blocked', 'Disabled', ], ], 'OidcConfig' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ClientSecret', 'Issuer', 'AuthorizationEndpoint', 'TokenEndpoint', 'UserInfoEndpoint', 'LogoutEndpoint', 'JwksUri', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'ClientSecret' => [ 'shape' => 'ClientSecret', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcConfigForResponse' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcEndpoint' => [ 'type' => 'string', 'max' => 500, 'pattern' => 'https://\\S+', ], 'OidcMemberDefinition' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], ], ], 'OnlineStoreConfig' => [ 'type' => 'structure', 'members' => [ 'SecurityConfig' => [ 'shape' => 'OnlineStoreSecurityConfig', ], 'EnableOnlineStore' => [ 'shape' => 'Boolean', ], 'TtlDuration' => [ 'shape' => 'TtlDuration', ], 'StorageType' => [ 'shape' => 'StorageType', ], ], ], 'OnlineStoreConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OnlineStoreTotalSizeBytes' => [ 'type' => 'long', ], 'Operator' => [ 'type' => 'string', 'enum' => [ 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqualTo', 'LessThan', 'LessThanOrEqualTo', 'Contains', 'Exists', 'NotExists', 'In', ], ], 'OptionalDouble' => [ 'type' => 'double', ], 'OptionalInteger' => [ 'type' => 'integer', ], 'OptionalVolumeSizeInGB' => [ 'type' => 'integer', 'min' => 0, ], 'OrderKey' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'OutputCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'OutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'TargetDevice' => [ 'shape' => 'TargetDevice', ], 'TargetPlatform' => [ 'shape' => 'TargetPlatform', ], 'CompilerOptions' => [ 'shape' => 'CompilerOptions', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'OutputCompressionType', ], ], ], 'OutputParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String256', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'OutputParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputParameter', ], 'max' => 50, 'min' => 0, ], 'OwnershipSettings' => [ 'type' => 'structure', 'required' => [ 'OwnerUserProfileName', ], 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'OwnershipSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'MaxParallelExecutionSteps', ], 'members' => [ 'MaxParallelExecutionSteps' => [ 'shape' => 'MaxParallelExecutionSteps', ], ], ], 'Parameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'PipelineParameterName', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], 'max' => 200, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'ParameterRange' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRangeSpecification' => [ 'shape' => 'IntegerParameterRangeSpecification', ], 'ContinuousParameterRangeSpecification' => [ 'shape' => 'ContinuousParameterRangeSpecification', ], 'CategoricalParameterRangeSpecification' => [ 'shape' => 'CategoricalParameterRangeSpecification', ], ], ], 'ParameterRanges' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRanges' => [ 'shape' => 'IntegerParameterRanges', ], 'ContinuousParameterRanges' => [ 'shape' => 'ContinuousParameterRanges', ], 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameterRanges', ], 'AutoParameters' => [ 'shape' => 'AutoParameters', ], ], ], 'ParameterType' => [ 'type' => 'string', 'enum' => [ 'Integer', 'Continuous', 'Categorical', 'FreeText', ], ], 'ParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterValue', ], 'max' => 30, 'min' => 1, ], 'Parent' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ParentHyperParameterTuningJob' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'ParentHyperParameterTuningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParentHyperParameterTuningJob', ], 'max' => 5, 'min' => 1, ], 'Parents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parent', ], ], 'PendingDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'ShadowProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], ], ], 'PendingProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'PendingProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingProductionVariantSummary', ], 'min' => 1, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, ], 'Phase' => [ 'type' => 'structure', 'members' => [ 'InitialNumberOfUsers' => [ 'shape' => 'InitialNumberOfUsers', ], 'SpawnRate' => [ 'shape' => 'SpawnRate', ], 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], ], ], 'Phases' => [ 'type' => 'list', 'member' => [ 'shape' => 'Phase', ], 'min' => 1, ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*', ], 'PipelineDefinition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'PipelineDefinitionS3Location' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ObjectKey', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'ObjectKey' => [ 'shape' => 'Key', ], 'VersionId' => [ 'shape' => 'VersionId', ], ], ], 'PipelineDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecution' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], ], ], 'PipelineExecutionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$', ], 'PipelineExecutionDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecutionFailureReason' => [ 'type' => 'string', 'max' => 1300, 'pattern' => '.*', ], 'PipelineExecutionName' => [ 'type' => 'string', 'max' => 82, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}', ], 'PipelineExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'PipelineExecutionStep' => [ 'type' => 'structure', 'members' => [ 'StepName' => [ 'shape' => 'StepName', ], 'StepDisplayName' => [ 'shape' => 'StepDisplayName', ], 'StepDescription' => [ 'shape' => 'StepDescription', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StepStatus' => [ 'shape' => 'StepStatus', ], 'CacheHitResult' => [ 'shape' => 'CacheHitResult', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Metadata' => [ 'shape' => 'PipelineExecutionStepMetadata', ], 'AttemptCount' => [ 'shape' => 'Integer', ], 'SelectiveExecutionResult' => [ 'shape' => 'SelectiveExecutionResult', ], ], ], 'PipelineExecutionStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionStep', ], 'max' => 100, 'min' => 0, ], 'PipelineExecutionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJobStepMetadata', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJobStepMetadata', ], 'TransformJob' => [ 'shape' => 'TransformJobStepMetadata', ], 'TuningJob' => [ 'shape' => 'TuningJobStepMetaData', ], 'Model' => [ 'shape' => 'ModelStepMetadata', ], 'RegisterModel' => [ 'shape' => 'RegisterModelStepMetadata', ], 'Condition' => [ 'shape' => 'ConditionStepMetadata', ], 'Callback' => [ 'shape' => 'CallbackStepMetadata', ], 'Lambda' => [ 'shape' => 'LambdaStepMetadata', ], 'EMR' => [ 'shape' => 'EMRStepMetadata', ], 'QualityCheck' => [ 'shape' => 'QualityCheckStepMetadata', ], 'ClarifyCheck' => [ 'shape' => 'ClarifyCheckStepMetadata', ], 'Fail' => [ 'shape' => 'FailStepMetadata', ], 'AutoMLJob' => [ 'shape' => 'AutoMLJobStepMetadata', ], ], ], 'PipelineExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionFailureReason' => [ 'shape' => 'String3072', ], ], ], 'PipelineExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionSummary', ], 'max' => 100, 'min' => 0, ], 'PipelineExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}', ], 'PipelineNameOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})', ], 'PipelineParameterName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastExecutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], 'max' => 100, 'min' => 0, ], 'PlatformIdentifier' => [ 'type' => 'string', 'max' => 15, 'pattern' => '^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$', ], 'PolicyString' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '.*', ], 'PredefinedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'PredefinedMetricType' => [ 'shape' => 'String', ], ], ], 'PresignedDomainUrl' => [ 'type' => 'string', ], 'ProbabilityThresholdAttribute' => [ 'type' => 'double', ], 'ProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'ProcessingClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingEnvironmentKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'ProcessingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 100, ], 'ProcessingEnvironmentValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S\\s]*', ], 'ProcessingFeatureStoreOutput' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'ProcessingInput' => [ 'type' => 'structure', 'required' => [ 'InputName', ], 'members' => [ 'InputName' => [ 'shape' => 'String', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], 'S3Input' => [ 'shape' => 'ProcessingS3Input', ], 'DatasetDefinition' => [ 'shape' => 'DatasetDefinition', ], ], ], 'ProcessingInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingInput', ], 'max' => 10, 'min' => 0, ], 'ProcessingInstanceCount' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ProcessingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'ProcessingJob' => [ 'type' => 'structure', 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ProcessingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*', ], 'ProcessingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ProcessingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ProcessingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'ProcessingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingJobSummary', ], ], 'ProcessingJobSummary' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingJobArn', 'CreationTime', 'ProcessingJobStatus', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], ], ], 'ProcessingLocalPath' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ProcessingMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 777600, 'min' => 1, ], 'ProcessingOutput' => [ 'type' => 'structure', 'required' => [ 'OutputName', ], 'members' => [ 'OutputName' => [ 'shape' => 'String', ], 'S3Output' => [ 'shape' => 'ProcessingS3Output', ], 'FeatureStoreOutput' => [ 'shape' => 'ProcessingFeatureStoreOutput', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], ], ], 'ProcessingOutputConfig' => [ 'type' => 'structure', 'required' => [ 'Outputs', ], 'members' => [ 'Outputs' => [ 'shape' => 'ProcessingOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingOutput', ], 'max' => 10, 'min' => 0, ], 'ProcessingResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'ProcessingClusterConfig', ], ], ], 'ProcessingS3CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ProcessingS3DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'ProcessingS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', ], ], 'ProcessingS3Input' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3DataType' => [ 'shape' => 'ProcessingS3DataType', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'S3CompressionType' => [ 'shape' => 'ProcessingS3CompressionType', ], ], ], 'ProcessingS3InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'ProcessingS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', 'S3UploadMode', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'ProcessingS3UploadMode' => [ 'type' => 'string', 'enum' => [ 'Continuous', 'EndOfJob', ], ], 'ProcessingStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'ProcessingMaxRuntimeInSeconds', ], ], ], 'ProcessingVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 1, ], 'Processor' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'ProductId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ProductListings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ProductionVariant' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'InitialInstanceCount' => [ 'shape' => 'InitialTaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialVariantWeight' => [ 'shape' => 'VariantWeight', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'CoreDumpConfig' => [ 'shape' => 'ProductionVariantCoreDumpConfig', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'ProductionVariantVolumeSizeInGB', ], 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], 'EnableSSMAccess' => [ 'shape' => 'ProductionVariantSSMAccess', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantCoreDumpConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProductionVariantInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.12xlarge', 'ml.m5d.24xlarge', 'ml.c4.large', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.large', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.12xlarge', 'ml.r5.24xlarge', 'ml.r5d.large', 'ml.r5d.xlarge', 'ml.r5d.2xlarge', 'ml.r5d.4xlarge', 'ml.r5d.12xlarge', 'ml.r5d.24xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.dl1.24xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.g6.xlarge', 'ml.g6.2xlarge', 'ml.g6.4xlarge', 'ml.g6.8xlarge', 'ml.g6.12xlarge', 'ml.g6.16xlarge', 'ml.g6.24xlarge', 'ml.g6.48xlarge', 'ml.p4d.24xlarge', 'ml.c7g.large', 'ml.c7g.xlarge', 'ml.c7g.2xlarge', 'ml.c7g.4xlarge', 'ml.c7g.8xlarge', 'ml.c7g.12xlarge', 'ml.c7g.16xlarge', 'ml.m6g.large', 'ml.m6g.xlarge', 'ml.m6g.2xlarge', 'ml.m6g.4xlarge', 'ml.m6g.8xlarge', 'ml.m6g.12xlarge', 'ml.m6g.16xlarge', 'ml.m6gd.large', 'ml.m6gd.xlarge', 'ml.m6gd.2xlarge', 'ml.m6gd.4xlarge', 'ml.m6gd.8xlarge', 'ml.m6gd.12xlarge', 'ml.m6gd.16xlarge', 'ml.c6g.large', 'ml.c6g.xlarge', 'ml.c6g.2xlarge', 'ml.c6g.4xlarge', 'ml.c6g.8xlarge', 'ml.c6g.12xlarge', 'ml.c6g.16xlarge', 'ml.c6gd.large', 'ml.c6gd.xlarge', 'ml.c6gd.2xlarge', 'ml.c6gd.4xlarge', 'ml.c6gd.8xlarge', 'ml.c6gd.12xlarge', 'ml.c6gd.16xlarge', 'ml.c6gn.large', 'ml.c6gn.xlarge', 'ml.c6gn.2xlarge', 'ml.c6gn.4xlarge', 'ml.c6gn.8xlarge', 'ml.c6gn.12xlarge', 'ml.c6gn.16xlarge', 'ml.r6g.large', 'ml.r6g.xlarge', 'ml.r6g.2xlarge', 'ml.r6g.4xlarge', 'ml.r6g.8xlarge', 'ml.r6g.12xlarge', 'ml.r6g.16xlarge', 'ml.r6gd.large', 'ml.r6gd.xlarge', 'ml.r6gd.2xlarge', 'ml.r6gd.4xlarge', 'ml.r6gd.8xlarge', 'ml.r6gd.12xlarge', 'ml.r6gd.16xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.inf2.xlarge', 'ml.inf2.8xlarge', 'ml.inf2.24xlarge', 'ml.inf2.48xlarge', 'ml.p5.48xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', ], ], 'ProductionVariantList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariant', ], 'max' => 10, 'min' => 1, ], 'ProductionVariantManagedInstanceScaling' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'ManagedInstanceScalingStatus', ], 'MinInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMinInstanceCount', ], 'MaxInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMaxInstanceCount', ], ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'RoutingStrategy', ], 'members' => [ 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'ProductionVariantSSMAccess' => [ 'type' => 'boolean', ], 'ProductionVariantServerlessConfig' => [ 'type' => 'structure', 'required' => [ 'MemorySizeInMB', 'MaxConcurrency', ], 'members' => [ 'MemorySizeInMB' => [ 'shape' => 'ServerlessMemorySizeInMB', ], 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'VariantStatus', ], 'StatusMessage' => [ 'shape' => 'VariantStatusMessage', ], 'StartTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProductionVariantStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantStatus', ], 'max' => 5, 'min' => 0, ], 'ProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantSummary', ], 'min' => 1, ], 'ProductionVariantVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 512, 'min' => 1, ], 'ProfilerConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'ProfilerRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'ProfilerRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProfilerRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'ProfilingIntervalInMilliseconds' => [ 'type' => 'long', ], 'ProfilingParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'ProfilingStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ProgrammingLang' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'Project' => [ 'type' => 'structure', 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'ProjectArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$', ], 'ProjectEntityName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'ProjectId' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ProjectSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ProjectSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ProjectStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'CreateInProgress', 'CreateCompleted', 'CreateFailed', 'DeleteInProgress', 'DeleteFailed', 'DeleteCompleted', 'UpdateInProgress', 'UpdateCompleted', 'UpdateFailed', ], ], 'ProjectSummary' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ProjectArn', 'ProjectId', 'CreationTime', 'ProjectStatus', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], ], ], 'ProjectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProjectSummary', ], ], 'PropertyNameHint' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '.*', ], 'PropertyNameQuery' => [ 'type' => 'structure', 'required' => [ 'PropertyNameHint', ], 'members' => [ 'PropertyNameHint' => [ 'shape' => 'PropertyNameHint', ], ], ], 'PropertyNameSuggestion' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'ResourcePropertyName', ], ], ], 'PropertyNameSuggestionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyNameSuggestion', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', 'pattern' => '.*', ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningParameterKey', ], 'Value' => [ 'shape' => 'ProvisioningParameterValue', ], ], ], 'ProvisioningParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'ProvisioningParameterValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'PublicWorkforceTaskPrice' => [ 'type' => 'structure', 'members' => [ 'AmountInUsd' => [ 'shape' => 'USD', ], ], ], 'PutModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ResourcePolicy', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'PutModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'QualityCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckStatistics' => [ 'shape' => 'String1024', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineStatistics' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'QueryFilters' => [ 'type' => 'structure', 'members' => [ 'Types' => [ 'shape' => 'QueryTypes', ], 'LineageTypes' => [ 'shape' => 'QueryLineageTypes', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedAfter' => [ 'shape' => 'Timestamp', ], 'Properties' => [ 'shape' => 'QueryProperties', ], ], ], 'QueryLineageMaxDepth' => [ 'type' => 'integer', 'max' => 10, ], 'QueryLineageMaxResults' => [ 'type' => 'integer', 'max' => 50, ], 'QueryLineageRequest' => [ 'type' => 'structure', 'members' => [ 'StartArns' => [ 'shape' => 'QueryLineageStartArns', ], 'Direction' => [ 'shape' => 'Direction', ], 'IncludeEdges' => [ 'shape' => 'Boolean', ], 'Filters' => [ 'shape' => 'QueryFilters', ], 'MaxDepth' => [ 'shape' => 'QueryLineageMaxDepth', ], 'MaxResults' => [ 'shape' => 'QueryLineageMaxResults', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageResponse' => [ 'type' => 'structure', 'members' => [ 'Vertices' => [ 'shape' => 'Vertices', ], 'Edges' => [ 'shape' => 'Edges', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageStartArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationEntityArn', ], 'max' => 1, 'min' => 0, ], 'QueryLineageTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageType', ], 'max' => 4, ], 'QueryProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'String256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 5, ], 'QueryTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String40', ], 'max' => 5, ], 'RSessionAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], ], ], 'RStudioServerProAccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'RStudioServerProAppSettings' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'RStudioServerProAccessStatus', ], 'UserGroup' => [ 'shape' => 'RStudioServerProUserGroup', ], ], ], 'RStudioServerProDomainSettings' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], ], ], 'RStudioServerProUserGroup' => [ 'type' => 'string', 'enum' => [ 'R_STUDIO_ADMIN', 'R_STUDIO_USER', ], ], 'RandomSeed' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'TaskCount', ], ], ], 'RealTimeInferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', 'InstanceType', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'RealTimeInferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeInferenceRecommendation', ], 'max' => 3, 'min' => 0, ], 'RealtimeInferenceInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantInstanceType', ], ], 'RecommendationFailureReason' => [ 'type' => 'string', ], 'RecommendationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*', ], 'RecommendationJobCompilationJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'RecommendationJobCompiledOutputConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputUri' => [ 'shape' => 'S3Uri', ], ], ], 'RecommendationJobContainerConfig' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'RecommendationJobFrameworkVersion', ], 'PayloadConfig' => [ 'shape' => 'RecommendationJobPayloadConfig', ], 'NearestModelName' => [ 'shape' => 'String', ], 'SupportedInstanceTypes' => [ 'shape' => 'RecommendationJobSupportedInstanceTypes', ], 'SupportedEndpointType' => [ 'shape' => 'RecommendationJobSupportedEndpointType', ], 'DataInputConfig' => [ 'shape' => 'RecommendationJobDataInputConfig', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'RecommendationJobSupportedResponseMIMETypes', ], ], ], 'RecommendationJobDataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'RecommendationJobDescription' => [ 'type' => 'string', 'max' => 128, ], 'RecommendationJobFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'RecommendationJobInferenceBenchmark' => [ 'type' => 'structure', 'required' => [ 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointMetrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'FailureReason' => [ 'shape' => 'RecommendationFailureReason', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'RecommendationJobInputConfig' => [ 'type' => 'structure', 'members' => [ 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'JobDurationInSeconds' => [ 'shape' => 'JobDurationInSeconds', ], 'TrafficPattern' => [ 'shape' => 'TrafficPattern', ], 'ResourceLimit' => [ 'shape' => 'RecommendationJobResourceLimit', ], 'EndpointConfigurations' => [ 'shape' => 'EndpointInputConfigurations', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ContainerConfig' => [ 'shape' => 'RecommendationJobContainerConfig', ], 'Endpoints' => [ 'shape' => 'Endpoints', ], 'VpcConfig' => [ 'shape' => 'RecommendationJobVpcConfig', ], ], ], 'RecommendationJobName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'RecommendationJobOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CompiledOutputConfig' => [ 'shape' => 'RecommendationJobCompiledOutputConfig', ], ], ], 'RecommendationJobPayloadConfig' => [ 'type' => 'structure', 'members' => [ 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'SupportedContentTypes' => [ 'shape' => 'RecommendationJobSupportedContentTypes', ], ], ], 'RecommendationJobResourceLimit' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTests' => [ 'shape' => 'MaxNumberOfTests', ], 'MaxParallelOfTests' => [ 'shape' => 'MaxParallelOfTests', ], ], ], 'RecommendationJobStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', 'DELETING', 'DELETED', ], ], 'RecommendationJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatencyThresholds' => [ 'shape' => 'ModelLatencyThresholds', ], 'FlatInvocations' => [ 'shape' => 'FlatInvocations', ], ], ], 'RecommendationJobSupportedContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'RecommendationJobSupportedContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedContentType', ], ], 'RecommendationJobSupportedEndpointType' => [ 'type' => 'string', 'enum' => [ 'RealTime', 'Serverless', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedResponseMIMEType', ], ], 'RecommendationJobType' => [ 'type' => 'string', 'enum' => [ 'Default', 'Advanced', ], ], 'RecommendationJobVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'RecommendationJobVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'RecommendationJobVpcSubnets', ], ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'RecommendationJobVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'RecommendationMetrics' => [ 'type' => 'structure', 'required' => [ 'CostPerHour', 'CostPerInference', 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'CostPerHour' => [ 'shape' => 'Float', ], 'CostPerInference' => [ 'shape' => 'Float', ], 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], 'CpuUtilization' => [ 'shape' => 'UtilizationMetric', ], 'MemoryUtilization' => [ 'shape' => 'UtilizationMetric', ], 'ModelSetupTime' => [ 'shape' => 'ModelSetupTime', ], ], ], 'RecommendationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'NOT_APPLICABLE', ], ], 'RecommendationStepType' => [ 'type' => 'string', 'enum' => [ 'BENCHMARK', ], ], 'RecordWrapper' => [ 'type' => 'string', 'enum' => [ 'None', 'RecordIO', ], ], 'RedshiftClusterId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatabase' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'Database', 'DbUser', 'QueryString', 'ClusterRoleArn', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'ClusterId' => [ 'shape' => 'RedshiftClusterId', ], 'Database' => [ 'shape' => 'RedshiftDatabase', ], 'DbUser' => [ 'shape' => 'RedshiftUserName', ], 'QueryString' => [ 'shape' => 'RedshiftQueryString', ], 'ClusterRoleArn' => [ 'shape' => 'RoleArn', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'RedshiftResultFormat', ], 'OutputCompression' => [ 'shape' => 'RedshiftResultCompressionType', ], ], ], 'RedshiftQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'RedshiftResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'GZIP', 'BZIP2', 'ZSTD', 'SNAPPY', ], ], 'RedshiftResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'CSV', ], ], 'RedshiftUserName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'RegisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ReleaseNotes' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'RemoteDebugConfig' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RemoteDebugConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RenderUiTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'Task', 'RoleArn', ], 'members' => [ 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Task' => [ 'shape' => 'RenderableTask', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'RenderUiTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'RenderedContent', 'Errors', ], 'members' => [ 'RenderedContent' => [ 'shape' => 'String', ], 'Errors' => [ 'shape' => 'RenderingErrorList', ], ], ], 'RenderableTask' => [ 'type' => 'structure', 'required' => [ 'Input', ], 'members' => [ 'Input' => [ 'shape' => 'TaskInput', ], ], ], 'RenderingError' => [ 'type' => 'structure', 'required' => [ 'Code', 'Message', ], 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'RenderingErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderingError', ], ], 'RepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'RepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryCredentialsProviderArn', ], 'members' => [ 'RepositoryCredentialsProviderArn' => [ 'shape' => 'RepositoryCredentialsProviderArn', ], ], ], 'RepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'RepositoryUrl' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$', ], 'ResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+', ], 'ResourceCatalog' => [ 'type' => 'structure', 'required' => [ 'ResourceCatalogArn', 'ResourceCatalogName', 'Description', 'CreationTime', ], 'members' => [ 'ResourceCatalogArn' => [ 'shape' => 'ResourceCatalogArn', ], 'ResourceCatalogName' => [ 'shape' => 'ResourceCatalogName', ], 'Description' => [ 'shape' => 'ResourceCatalogDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceCatalogArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*', ], 'ResourceCatalogDescription' => [ 'type' => 'string', 'max' => 256, ], 'ResourceCatalogList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCatalog', ], ], 'ResourceCatalogName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceCatalogSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ResourceCatalogSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ResourceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroups', ], ], ], 'ResourceConfigForUpdate' => [ 'type' => 'structure', 'required' => [ 'KeepAlivePeriodInSeconds', ], 'members' => [ 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 32, ], 'ResourceInUse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimits' => [ 'type' => 'structure', 'required' => [ 'MaxParallelTrainingJobs', ], 'members' => [ 'MaxNumberOfTrainingJobs' => [ 'shape' => 'MaxNumberOfTrainingJobs', ], 'MaxParallelTrainingJobs' => [ 'shape' => 'MaxParallelTrainingJobs', ], 'MaxRuntimeInSeconds' => [ 'shape' => 'HyperParameterTuningMaxRuntimeInSeconds', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourcePolicyString' => [ 'type' => 'string', 'max' => 20480, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'ResourcePropertyName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'ResourceSpec' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageArn' => [ 'shape' => 'ImageArn', ], 'SageMakerImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'SageMakerImageVersionAlias' => [ 'shape' => 'ImageVersionAlias', ], 'InstanceType' => [ 'shape' => 'AppInstanceType', ], 'LifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'TrainingJob', 'Experiment', 'ExperimentTrial', 'ExperimentTrialComponent', 'Endpoint', 'Model', 'ModelPackage', 'ModelPackageGroup', 'Pipeline', 'PipelineExecution', 'FeatureGroup', 'FeatureMetadata', 'Image', 'ImageVersion', 'Project', 'HyperParameterTuningJob', 'ModelCard', ], ], 'ResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'ResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResponseMIMEType', ], ], 'RetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'HomeEfsFileSystem' => [ 'shape' => 'RetentionType', ], ], ], 'RetentionType' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Delete', ], ], 'RetryPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'RetryPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'RetryStrategy' => [ 'type' => 'structure', 'required' => [ 'MaximumRetryAttempts', ], 'members' => [ 'MaximumRetryAttempts' => [ 'shape' => 'MaximumRetryAttempts', ], ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'RollingUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'MaximumBatchSize', 'WaitIntervalInSeconds', ], 'members' => [ 'MaximumBatchSize' => [ 'shape' => 'CapacitySize', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], 'RollbackMaximumBatchSize' => [ 'shape' => 'CapacitySize', ], ], ], 'RootAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'RoutingStrategy' => [ 'type' => 'string', 'enum' => [ 'LEAST_OUTSTANDING_REQUESTS', 'RANDOM', ], ], 'RuleConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'RuleEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'NoIssuesFound', 'IssuesFound', 'Error', 'Stopping', 'Stopped', ], ], 'RuleParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 100, 'min' => 0, ], 'S3DataDistribution' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'S3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'S3DataDistributionType' => [ 'shape' => 'S3DataDistribution', ], 'AttributeNames' => [ 'shape' => 'AttributeNames', ], 'InstanceGroupNames' => [ 'shape' => 'InstanceGroupNames', ], ], ], 'S3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'S3ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', 'CompressionType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3ModelUri', ], 'S3DataType' => [ 'shape' => 'S3ModelDataType', ], 'CompressionType' => [ 'shape' => 'ModelCompressionType', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'S3ModelDataType' => [ 'type' => 'string', 'enum' => [ 'S3Prefix', 'S3Object', ], ], 'S3ModelUri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3OutputPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3StorageConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ResolvedOutputS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SageMakerImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(?!^[.-])^([a-zA-Z0-9-_.]+)$', ], 'SageMakerImageVersionAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], 'SagemakerServicecatalogStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'SampleWeightAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SamplingPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ScalingPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'TargetTracking' => [ 'shape' => 'TargetTrackingScalingPolicyConfiguration', ], ], 'union' => true, ], 'ScalingPolicyMetric' => [ 'type' => 'structure', 'members' => [ 'InvocationsPerInstance' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'ScalingPolicyObjective' => [ 'type' => 'structure', 'members' => [ 'MinInvocationsPerMinute' => [ 'shape' => 'Integer', ], 'MaxInvocationsPerMinute' => [ 'shape' => 'Integer', ], ], ], 'ScheduleConfig' => [ 'type' => 'structure', 'required' => [ 'ScheduleExpression', ], 'members' => [ 'ScheduleExpression' => [ 'shape' => 'ScheduleExpression', ], 'DataAnalysisStartTime' => [ 'shape' => 'String', ], 'DataAnalysisEndTime' => [ 'shape' => 'String', ], ], ], 'ScheduleExpression' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ScheduleStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Failed', 'Scheduled', 'Stopped', ], ], 'SearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'NestedFilters' => [ 'shape' => 'NestedFiltersList', ], 'SubExpressions' => [ 'shape' => 'SearchExpressionList', ], 'Operator' => [ 'shape' => 'BooleanOperator', ], ], ], 'SearchExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchExpression', ], 'max' => 20, 'min' => 1, ], 'SearchRecord' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'Experiment' => [ 'shape' => 'Experiment', ], 'Trial' => [ 'shape' => 'Trial', ], 'TrialComponent' => [ 'shape' => 'TrialComponent', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ModelPackage' => [ 'shape' => 'ModelPackage', ], 'ModelPackageGroup' => [ 'shape' => 'ModelPackageGroup', ], 'Pipeline' => [ 'shape' => 'Pipeline', ], 'PipelineExecution' => [ 'shape' => 'PipelineExecution', ], 'FeatureGroup' => [ 'shape' => 'FeatureGroup', ], 'FeatureMetadata' => [ 'shape' => 'FeatureMetadata', ], 'Project' => [ 'shape' => 'Project', ], 'HyperParameterTuningJob' => [ 'shape' => 'HyperParameterTuningJobSearchEntity', ], 'ModelCard' => [ 'shape' => 'ModelCard', ], 'Model' => [ 'shape' => 'ModelDashboardModel', ], ], ], 'SearchRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SearchExpression' => [ 'shape' => 'SearchExpression', ], 'SortBy' => [ 'shape' => 'ResourcePropertyName', ], 'SortOrder' => [ 'shape' => 'SearchSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CrossAccountFilterOption' => [ 'shape' => 'CrossAccountFilterOption', ], 'VisibilityConditions' => [ 'shape' => 'VisibilityConditionsList', ], ], ], 'SearchResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SearchResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SearchResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchRecord', ], ], 'SearchSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'LaunchingMLInstances', 'PreparingTrainingStack', 'Downloading', 'DownloadingTrainingImage', 'Training', 'Uploading', 'Stopping', 'Stopped', 'MaxRuntimeExceeded', 'Completed', 'Failed', 'Interrupted', 'MaxWaitTimeExceeded', 'Updating', 'Restarting', 'Pending', ], ], 'SecondaryStatusTransition' => [ 'type' => 'structure', 'required' => [ 'Status', 'StartTime', ], 'members' => [ 'Status' => [ 'shape' => 'SecondaryStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'SecondaryStatusTransitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecondaryStatusTransition', ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, ], 'Seed' => [ 'type' => 'long', ], 'SelectedStep' => [ 'type' => 'structure', 'required' => [ 'StepName', ], 'members' => [ 'StepName' => [ 'shape' => 'String256', ], ], ], 'SelectedStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectedStep', ], 'max' => 50, 'min' => 1, ], 'SelectiveExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'SelectedSteps', ], 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'SelectedSteps' => [ 'shape' => 'SelectedStepList', ], ], ], 'SelectiveExecutionResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'FailureReason' => [ 'shape' => 'String256', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepFailureResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'ServerlessMaxConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServerlessMemorySizeInMB' => [ 'type' => 'integer', 'max' => 6144, 'min' => 1024, ], 'ServerlessProvisionedConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServiceCatalogEntityId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'ServiceCatalogProvisionedProductDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisionedProductStatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], ], ], 'ServiceCatalogProvisioningDetails' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'ProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'PathId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'SessionChainingConfig' => [ 'type' => 'structure', 'members' => [ 'EnableSessionTagChaining' => [ 'shape' => 'EnableSessionTagChaining', ], ], ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1800, ], 'ShadowModeConfig' => [ 'type' => 'structure', 'required' => [ 'SourceModelVariantName', 'ShadowModelVariants', ], 'members' => [ 'SourceModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'ShadowModelVariants' => [ 'shape' => 'ShadowModelVariantConfigList', ], ], ], 'ShadowModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ShadowModelVariantName', 'SamplingPercentage', ], 'members' => [ 'ShadowModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'SamplingPercentage' => [ 'shape' => 'Percentage', ], ], ], 'ShadowModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowModelVariantConfig', ], 'max' => 1, 'min' => 1, ], 'SharingSettings' => [ 'type' => 'structure', 'members' => [ 'NotebookOutputOption' => [ 'shape' => 'NotebookOutputOption', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'SharingType' => [ 'type' => 'string', 'enum' => [ 'Private', 'Shared', ], ], 'ShuffleConfig' => [ 'type' => 'structure', 'required' => [ 'Seed', ], 'members' => [ 'Seed' => [ 'shape' => 'Seed', ], ], ], 'SingleSignOnApplicationArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\\/[a-zA-Z0-9-_.]+\\/apl-[a-zA-Z0-9]+$', ], 'SingleSignOnUserIdentifier' => [ 'type' => 'string', 'pattern' => 'UserName', ], 'SkipModelValidation' => [ 'type' => 'string', 'enum' => [ 'All', 'None', ], ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+', ], 'SortActionsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortArtifactsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'SortAssociationsBy' => [ 'type' => 'string', 'enum' => [ 'SourceArn', 'DestinationArn', 'SourceType', 'DestinationType', 'CreationTime', ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortContextsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortInferenceExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortLineageGroupsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SortPipelineExecutionsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'PipelineExecutionArn', ], ], 'SortPipelinesBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialComponentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SourceAlgorithm' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'SourceAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAlgorithm', ], 'max' => 1, 'min' => 1, ], 'SourceAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'SourceAlgorithms', ], 'members' => [ 'SourceAlgorithms' => [ 'shape' => 'SourceAlgorithmList', ], ], ], 'SourceIpConfig' => [ 'type' => 'structure', 'required' => [ 'Cidrs', ], 'members' => [ 'Cidrs' => [ 'shape' => 'Cidrs', ], ], ], 'SourceType' => [ 'type' => 'string', 'max' => 128, ], 'SourceUri' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'SpaceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*', ], 'SpaceCodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'SpaceDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'SpaceSettingsSummary' => [ 'shape' => 'SpaceSettingsSummary', ], 'SpaceSharingSettingsSummary' => [ 'shape' => 'SpaceSharingSettingsSummary', ], 'OwnershipSettingsSummary' => [ 'shape' => 'OwnershipSettingsSummary', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'SpaceEbsVolumeSizeInGb' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'SpaceJupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'SpaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpaceDetails', ], ], 'SpaceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'SpaceSettings' => [ 'type' => 'structure', 'members' => [ 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'SpaceCodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'SpaceJupyterLabAppSettings', ], 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], 'CustomFileSystems' => [ 'shape' => 'CustomFileSystems', ], ], ], 'SpaceSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], ], ], 'SpaceSharingSettings' => [ 'type' => 'structure', 'required' => [ 'SharingType', ], 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSharingSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'SpaceStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'SpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'EbsStorageSettings' => [ 'shape' => 'EbsStorageSettings', ], ], ], 'SpawnRate' => [ 'type' => 'integer', 'min' => 0, ], 'SplitType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', 'RecordIO', 'TFRecord', ], ], 'StageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READYTODEPLOY', 'STARTING', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'Stairs' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], 'NumberOfSteps' => [ 'shape' => 'NumberOfSteps', ], 'UsersPerStep' => [ 'shape' => 'UsersPerStep', ], ], ], 'StartEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StartInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'StartInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StartMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StartNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StartPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'StartPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'Average', 'Minimum', 'Maximum', 'SampleCount', 'Sum', ], ], 'StatusDetails' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'StatusMessage' => [ 'type' => 'string', ], 'StepDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'StepDisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'StepName' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'StepStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'StopAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'StopCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'StopInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ModelVariantActions', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'ModelVariantActions' => [ 'shape' => 'ModelVariantActionMap', ], 'DesiredModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DesiredState' => [ 'shape' => 'InferenceExperimentStopDesiredState', ], 'Reason' => [ 'shape' => 'InferenceExperimentStatusReason', ], ], ], 'StopInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StopInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'StopLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'StopMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StopNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StopPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'StopPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StopProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'StopTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'StopTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'StoppingCondition' => [ 'type' => 'structure', 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MaxRuntimeInSeconds', ], 'MaxWaitTimeInSeconds' => [ 'shape' => 'MaxWaitTimeInSeconds', ], 'MaxPendingTimeInSeconds' => [ 'shape' => 'MaxPendingTimeInSeconds', ], ], ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'Standard', 'InMemory', ], ], 'String' => [ 'type' => 'string', ], 'String1024' => [ 'type' => 'string', 'max' => 1024, ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'String200' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.+', ], 'String256' => [ 'type' => 'string', 'max' => 256, ], 'String3072' => [ 'type' => 'string', 'max' => 3072, ], 'String40' => [ 'type' => 'string', 'max' => 40, ], 'String64' => [ 'type' => 'string', 'max' => 64, ], 'String8192' => [ 'type' => 'string', 'max' => 8192, ], 'StringParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'StudioLifecycleConfigAppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'CodeEditor', 'JupyterLab', ], ], 'StudioLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*', ], 'StudioLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'StudioLifecycleConfigDetails' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'StudioLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'StudioLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'StudioLifecycleConfigsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigDetails', ], ], 'StudioWebPortal' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'Subnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'SubscribedWorkteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MarketplaceTitle' => [ 'shape' => 'String200', ], 'SellerName' => [ 'shape' => 'String', ], 'MarketplaceDescription' => [ 'shape' => 'String200', ], 'ListingId' => [ 'shape' => 'String', ], ], ], 'SubscribedWorkteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscribedWorkteam', ], ], 'Success' => [ 'type' => 'boolean', ], 'SuggestionQuery' => [ 'type' => 'structure', 'members' => [ 'PropertyNameQuery' => [ 'shape' => 'PropertyNameQuery', ], ], ], 'TableFormat' => [ 'type' => 'string', 'enum' => [ 'Default', 'Glue', 'Iceberg', ], ], 'TableName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'TabularJobConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'CandidateGenerationConfig' => [ 'shape' => 'CandidateGenerationConfig', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'TabularResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'ProblemType' => [ 'shape' => 'ProblemType', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetAttributeName' => [ 'type' => 'string', 'min' => 1, ], 'TargetDevice' => [ 'type' => 'string', 'enum' => [ 'lambda', 'ml_m4', 'ml_m5', 'ml_m6g', 'ml_c4', 'ml_c5', 'ml_c6g', 'ml_p2', 'ml_p3', 'ml_g4dn', 'ml_inf1', 'ml_inf2', 'ml_trn1', 'ml_eia2', 'jetson_tx1', 'jetson_tx2', 'jetson_nano', 'jetson_xavier', 'rasp3b', 'rasp4b', 'imx8qm', 'deeplens', 'rk3399', 'rk3288', 'aisage', 'sbe_c', 'qcs605', 'qcs603', 'sitara_am57x', 'amba_cv2', 'amba_cv22', 'amba_cv25', 'x86_win32', 'x86_win64', 'coreml', 'jacinto_tda4vm', 'imx8mplus', ], ], 'TargetLabelColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetObjectiveMetricValue' => [ 'type' => 'float', ], 'TargetPlatform' => [ 'type' => 'structure', 'required' => [ 'Os', 'Arch', ], 'members' => [ 'Os' => [ 'shape' => 'TargetPlatformOs', ], 'Arch' => [ 'shape' => 'TargetPlatformArch', ], 'Accelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], ], ], 'TargetPlatformAccelerator' => [ 'type' => 'string', 'enum' => [ 'INTEL_GRAPHICS', 'MALI', 'NVIDIA', 'NNA', ], ], 'TargetPlatformArch' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'X86', 'ARM64', 'ARM_EABI', 'ARM_EABIHF', ], ], 'TargetPlatformOs' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'LINUX', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'type' => 'structure', 'members' => [ 'MetricSpecification' => [ 'shape' => 'MetricSpecification', ], 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 60, ], 'TaskCount' => [ 'type' => 'integer', 'min' => 0, ], 'TaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'TaskInput' => [ 'type' => 'string', 'max' => 128000, 'min' => 2, 'pattern' => '[\\S\\s]+', ], 'TaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'TaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskKeyword', ], 'max' => 5, 'min' => 1, ], 'TaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'TaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'TemplateContent' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'TemplateContentSha256' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, ], 'TemplateUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TensorBoardAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'TensorBoardOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'TenthFractionsOfACent' => [ 'type' => 'integer', 'max' => 9, 'min' => 0, ], 'TerminationWaitInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'TextClassificationJobConfig' => [ 'type' => 'structure', 'required' => [ 'ContentColumn', 'TargetLabelColumn', ], 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ContentColumn' => [ 'shape' => 'ContentColumn', ], 'TargetLabelColumn' => [ 'shape' => 'TargetLabelColumn', ], ], ], 'TextGenerationHyperParameterKey' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameterValue' => [ 'type' => 'string', 'max' => 16, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TextGenerationHyperParameterKey', ], 'value' => [ 'shape' => 'TextGenerationHyperParameterValue', ], 'max' => 30, 'min' => 0, ], 'TextGenerationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'BaseModelName' => [ 'shape' => 'BaseModelName', ], 'TextGenerationHyperParameters' => [ 'shape' => 'TextGenerationHyperParameters', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'TextGenerationResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'BaseModelName' => [ 'shape' => 'BaseModelName', ], ], ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'ThroughputConfig' => [ 'type' => 'structure', 'required' => [ 'ThroughputMode', ], 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputConfigDescription' => [ 'type' => 'structure', 'required' => [ 'ThroughputMode', ], 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputMode' => [ 'type' => 'string', 'enum' => [ 'OnDemand', 'Provisioned', ], ], 'TimeSeriesConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', 'TimestampAttributeName', 'ItemIdentifierAttributeName', ], 'members' => [ 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'TimestampAttributeName' => [ 'shape' => 'TimestampAttributeName', ], 'ItemIdentifierAttributeName' => [ 'shape' => 'ItemIdentifierAttributeName', ], 'GroupingAttributeNames' => [ 'shape' => 'GroupingAttributeNames', ], ], ], 'TimeSeriesForecastingJobConfig' => [ 'type' => 'structure', 'required' => [ 'ForecastFrequency', 'ForecastHorizon', 'TimeSeriesConfig', ], 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ForecastFrequency' => [ 'shape' => 'ForecastFrequency', ], 'ForecastHorizon' => [ 'shape' => 'ForecastHorizon', ], 'ForecastQuantiles' => [ 'shape' => 'ForecastQuantiles', ], 'Transformations' => [ 'shape' => 'TimeSeriesTransformations', ], 'TimeSeriesConfig' => [ 'shape' => 'TimeSeriesConfig', ], 'HolidayConfig' => [ 'shape' => 'HolidayConfig', ], ], ], 'TimeSeriesForecastingSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'AmazonForecastRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'TimeSeriesTransformations' => [ 'type' => 'structure', 'members' => [ 'Filling' => [ 'shape' => 'FillingTransformations', ], 'Aggregation' => [ 'shape' => 'AggregationTransformations', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TimestampAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TrafficDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TrafficPattern' => [ 'type' => 'structure', 'members' => [ 'TrafficType' => [ 'shape' => 'TrafficType', ], 'Phases' => [ 'shape' => 'Phases', ], 'Stairs' => [ 'shape' => 'Stairs', ], ], ], 'TrafficRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'Type', 'WaitIntervalInSeconds', ], 'members' => [ 'Type' => [ 'shape' => 'TrafficRoutingConfigType', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'CanarySize' => [ 'shape' => 'CapacitySize', ], 'LinearStepSize' => [ 'shape' => 'CapacitySize', ], ], ], 'TrafficRoutingConfigType' => [ 'type' => 'string', 'enum' => [ 'ALL_AT_ONCE', 'CANARY', 'LINEAR', ], ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'PHASES', 'STAIRS', ], ], 'TrainingContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerArgument', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'TrainingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrainingEnvironmentKey', ], 'value' => [ 'shape' => 'TrainingEnvironmentValue', ], 'max' => 100, ], 'TrainingEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'TrainingImageConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryAccessMode', ], 'members' => [ 'TrainingRepositoryAccessMode' => [ 'shape' => 'TrainingRepositoryAccessMode', ], 'TrainingRepositoryAuthConfig' => [ 'shape' => 'TrainingRepositoryAuthConfig', ], ], ], 'TrainingInputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', 'FastFile', ], ], 'TrainingInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5n.xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.8xlarge', 'ml.c6i.4xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', ], ], 'TrainingInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInstanceType', ], ], 'TrainingJob' => [ 'type' => 'structure', 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TrainingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*', ], 'TrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', 'InputDataConfig', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], ], ], 'TrainingJobEarlyStoppingType' => [ 'type' => 'string', 'enum' => [ 'Off', 'Auto', ], ], 'TrainingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TrainingJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'TrainingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrainingJobStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingJobStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Completed' => [ 'shape' => 'TrainingJobStatusCounter', ], 'InProgress' => [ 'shape' => 'TrainingJobStatusCounter', ], 'RetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'NonRetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'Stopped' => [ 'shape' => 'TrainingJobStatusCounter', ], ], ], 'TrainingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'TrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingJobSummary', ], ], 'TrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'TrainingRepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'TrainingRepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryCredentialsProviderArn', ], 'members' => [ 'TrainingRepositoryCredentialsProviderArn' => [ 'shape' => 'TrainingRepositoryCredentialsProviderArn', ], ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*', ], 'TrainingSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingImage', 'SupportedTrainingInstanceTypes', 'TrainingChannels', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'ContainerImage', ], 'TrainingImageDigest' => [ 'shape' => 'ImageDigest', ], 'SupportedHyperParameters' => [ 'shape' => 'HyperParameterSpecifications', ], 'SupportedTrainingInstanceTypes' => [ 'shape' => 'TrainingInstanceTypes', ], 'SupportsDistributedTraining' => [ 'shape' => 'Boolean', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'TrainingChannels' => [ 'shape' => 'ChannelSpecifications', ], 'SupportedTuningJobObjectiveMetrics' => [ 'shape' => 'HyperParameterTuningJobObjectives', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'TrainingTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TransformDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'TransformS3DataSource', ], ], ], 'TransformEnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]{0,1023}', ], 'TransformEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformEnvironmentKey', ], 'value' => [ 'shape' => 'TransformEnvironmentValue', ], 'max' => 16, ], 'TransformEnvironmentValue' => [ 'type' => 'string', 'max' => 10240, 'pattern' => '[\\S\\s]*', ], 'TransformInput' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'TransformDataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'SplitType' => [ 'shape' => 'SplitType', ], ], ], 'TransformInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'TransformInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'TransformInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformInstanceType', ], 'min' => 1, ], 'TransformJob' => [ 'type' => 'structure', 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TransformJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*', ], 'TransformJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], ], ], 'TransformJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TransformJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TransformJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TransformJobArn', ], ], ], 'TransformJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformJobSummary', ], ], 'TransformJobSummary' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'CreationTime', 'TransformJobStatus', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'TransformOutput' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'Accept' => [ 'shape' => 'Accept', ], 'AssembleWith' => [ 'shape' => 'AssemblyType', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformResources' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TransformInstanceType', ], 'InstanceCount' => [ 'shape' => 'TransformInstanceCount', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'TransformationAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Trial' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSimpleSummaries', ], ], ], 'TrialArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*', ], 'TrialComponent' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'SourceDetail' => [ 'shape' => 'TrialComponentSourceDetail', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Parents' => [ 'shape' => 'Parents', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'TrialComponentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*', ], 'TrialComponentArtifact' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'MediaType' => [ 'shape' => 'MediaType', ], 'Value' => [ 'shape' => 'TrialComponentArtifactValue', ], ], ], 'TrialComponentArtifactValue' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'TrialComponentArtifacts' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey128', ], 'value' => [ 'shape' => 'TrialComponentArtifact', ], 'max' => 60, ], 'TrialComponentKey128' => [ 'type' => 'string', 'max' => 128, 'pattern' => '.*', ], 'TrialComponentKey256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrialComponentKey320' => [ 'type' => 'string', 'max' => 320, 'pattern' => '.*', ], 'TrialComponentMetricSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentMetricSummary', ], ], 'TrialComponentMetricSummary' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TimeStamp' => [ 'shape' => 'Timestamp', ], 'Max' => [ 'shape' => 'OptionalDouble', ], 'Min' => [ 'shape' => 'OptionalDouble', ], 'Last' => [ 'shape' => 'OptionalDouble', ], 'Count' => [ 'shape' => 'OptionalInteger', ], 'Avg' => [ 'shape' => 'OptionalDouble', ], 'StdDev' => [ 'shape' => 'OptionalDouble', ], ], ], 'TrialComponentParameterValue' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'StringParameterValue', ], 'NumberValue' => [ 'shape' => 'DoubleParameterValue', ], ], ], 'TrialComponentParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey320', ], 'value' => [ 'shape' => 'TrialComponentParameterValue', ], 'max' => 300, ], 'TrialComponentPrimaryStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrialComponentSimpleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSimpleSummary', ], ], 'TrialComponentSimpleSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialComponentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialComponentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialComponentSourceDetail' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJob', ], 'TransformJob' => [ 'shape' => 'TransformJob', ], ], ], 'TrialComponentSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSource', ], ], 'TrialComponentStatus' => [ 'type' => 'structure', 'members' => [ 'PrimaryStatus' => [ 'shape' => 'TrialComponentPrimaryStatus', ], 'Message' => [ 'shape' => 'TrialComponentStatusMessage', ], ], ], 'TrialComponentStatusMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'TrialComponentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSummary', ], ], 'TrialComponentSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialSummary', ], ], 'TrialSummary' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialSource' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TtlDuration' => [ 'type' => 'structure', 'members' => [ 'Unit' => [ 'shape' => 'TtlDurationUnit', ], 'Value' => [ 'shape' => 'TtlDurationValue', ], ], ], 'TtlDurationUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', ], ], 'TtlDurationValue' => [ 'type' => 'integer', 'min' => 1, ], 'TuningJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'TargetObjectiveMetricValue' => [ 'shape' => 'TargetObjectiveMetricValue', ], 'BestObjectiveNotImproving' => [ 'shape' => 'BestObjectiveNotImproving', ], 'ConvergenceDetected' => [ 'shape' => 'ConvergenceDetected', ], ], ], 'TuningJobStepMetaData' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'USD' => [ 'type' => 'structure', 'members' => [ 'Dollars' => [ 'shape' => 'Dollars', ], 'Cents' => [ 'shape' => 'Cents', ], 'TenthFractionsOfACent' => [ 'shape' => 'TenthFractionsOfACent', ], ], ], 'UiConfig' => [ 'type' => 'structure', 'members' => [ 'UiTemplateS3Uri' => [ 'shape' => 'S3Uri', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'UiTemplate' => [ 'type' => 'structure', 'required' => [ 'Content', ], 'members' => [ 'Content' => [ 'shape' => 'TemplateContent', ], ], ], 'UiTemplateInfo' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'TemplateUrl', ], 'ContentSha256' => [ 'shape' => 'TemplateContentSha256', ], ], ], 'Uid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 10000, ], 'UpdateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'UpdateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], 'CodeEditorAppImageConfig' => [ 'shape' => 'CodeEditorAppImageConfig', ], ], ], 'UpdateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'UpdateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'UpdateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], ], ], 'UpdateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'UpdateClusterSoftwareRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'UpdateClusterSoftwareResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'UpdateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfigForUpdate', ], ], ], 'UpdateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'UpdateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'UpdateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'UpdateDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], ], ], 'UpdateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettingsForUpdate' => [ 'shape' => 'DomainSettingsForUpdate', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], ], ], 'UpdateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], ], ], 'UpdateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'RetainAllVariantProperties' => [ 'shape' => 'Boolean', ], 'ExcludeRetainedVariantProperties' => [ 'shape' => 'VariantPropertyList', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'RetainDeploymentConfig' => [ 'shape' => 'Boolean', ], ], ], 'UpdateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'DesiredWeightsAndCapacities', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'DesiredWeightsAndCapacities' => [ 'shape' => 'DesiredWeightAndCapacityList', ], ], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], ], ], 'UpdateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'UpdateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureAdditions' => [ 'shape' => 'FeatureAdditions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfigUpdate', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfigUpdate', ], ], ], 'UpdateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'UpdateFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'ParameterAdditions' => [ 'shape' => 'FeatureParameterAdditions', ], 'ParameterRemovals' => [ 'shape' => 'FeatureParameterRemovals', ], ], ], 'UpdateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], ], ], 'UpdateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'UpdateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'DeleteProperties' => [ 'shape' => 'ImageDeletePropertyList', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'UpdateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'AliasesToAdd' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'AliasesToDelete' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'UpdateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'UpdateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'DesiredRuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'DesiredRuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], ], ], 'UpdateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'UpdateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], ], ], 'UpdateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'UpdateModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'CustomerMetadataPropertiesToRemove' => [ 'shape' => 'CustomerMetadataKeyList', ], 'AdditionalInferenceSpecificationsToAdd' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceUri' => [ 'shape' => 'ModelPackageSourceUri', ], ], ], 'UpdateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'UpdateMonitoringAlertRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'DatapointsToAlert', 'EvaluationPeriod', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], ], ], 'UpdateMonitoringAlertResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], ], ], 'UpdateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], ], ], 'UpdateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'UpdateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DisassociateLifecycleConfig' => [ 'shape' => 'DisassociateNotebookInstanceLifecycleConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DisassociateAcceleratorTypes' => [ 'shape' => 'DisassociateNotebookInstanceAcceleratorTypes', ], 'DisassociateDefaultCodeRepository' => [ 'shape' => 'DisassociateDefaultCodeRepository', ], 'DisassociateAdditionalCodeRepositories' => [ 'shape' => 'DisassociateAdditionalCodeRepositories', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'UpdateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'shape' => 'ServiceCatalogProvisioningUpdateDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], ], ], 'UpdateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'UpdateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'UpdateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfigForUpdate', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfigForUpdate', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfigForUpdate', ], ], ], 'UpdateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'UpdateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'ParametersToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'InputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], ], ], 'UpdateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'UpdateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'UpdateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'UpdateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'UpdateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'UpdateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'UpdateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'UpdateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'UpdateWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Url' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'UserContext' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'String', ], 'UserProfileName' => [ 'shape' => 'String', ], 'DomainId' => [ 'shape' => 'String', ], 'IamIdentity' => [ 'shape' => 'IamIdentity', ], ], ], 'UserProfileArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*', ], 'UserProfileDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'UserProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProfileDetails', ], ], 'UserProfileName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'UserProfileSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'UserProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'UserSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'SharingSettings' => [ 'shape' => 'SharingSettings', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'TensorBoardAppSettings' => [ 'shape' => 'TensorBoardAppSettings', ], 'RStudioServerProAppSettings' => [ 'shape' => 'RStudioServerProAppSettings', ], 'RSessionAppSettings' => [ 'shape' => 'RSessionAppSettings', ], 'CanvasAppSettings' => [ 'shape' => 'CanvasAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'CodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'JupyterLabAppSettings', ], 'SpaceStorageSettings' => [ 'shape' => 'DefaultSpaceStorageSettings', ], 'DefaultLandingUri' => [ 'shape' => 'LandingUri', ], 'StudioWebPortal' => [ 'shape' => 'StudioWebPortal', ], 'CustomPosixUserConfig' => [ 'shape' => 'CustomPosixUserConfig', ], 'CustomFileSystemConfigs' => [ 'shape' => 'CustomFileSystemConfigs', ], ], ], 'UsersPerStep' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'UtilizationMetric' => [ 'type' => 'float', 'min' => 0.0, ], 'UtilizationPercentagePerCore' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ValidationFraction' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'VariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'VariantProperty' => [ 'type' => 'structure', 'required' => [ 'VariantPropertyType', ], 'members' => [ 'VariantPropertyType' => [ 'shape' => 'VariantPropertyType', ], ], ], 'VariantPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantProperty', ], 'max' => 3, 'min' => 0, ], 'VariantPropertyType' => [ 'type' => 'string', 'enum' => [ 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig', ], ], 'VariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'Deleting', 'ActivatingTraffic', 'Baking', ], ], 'VariantStatusMessage' => [ 'type' => 'string', 'max' => 1024, ], 'VariantWeight' => [ 'type' => 'float', 'min' => 0, ], 'VectorConfig' => [ 'type' => 'structure', 'required' => [ 'Dimension', ], 'members' => [ 'Dimension' => [ 'shape' => 'Dimension', ], ], ], 'VendorGuidance' => [ 'type' => 'string', 'enum' => [ 'NOT_PROVIDED', 'STABLE', 'TO_BE_ARCHIVED', 'ARCHIVED', ], ], 'VersionId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'VersionedArnOrName' => [ 'type' => 'string', 'max' => 176, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AssociationEntityArn', ], 'Type' => [ 'shape' => 'String40', ], 'LineageType' => [ 'shape' => 'LineageType', ], ], ], 'Vertices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Vertex', ], ], 'VisibilityConditions' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'VisibilityConditionsKey', ], 'Value' => [ 'shape' => 'VisibilityConditionsValue', ], ], ], 'VisibilityConditionsKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VisibilityConditionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisibilityConditions', ], 'max' => 5, 'min' => 1, ], 'VisibilityConditionsValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VolumeSizeInGB' => [ 'type' => 'integer', 'min' => 1, ], 'VpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'Subnets', ], ], ], 'VpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'VpcOnlyTrustedAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'max' => 10, ], 'VpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WaitIntervalInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'WarmPoolResourceStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Terminated', 'Reused', 'InUse', ], ], 'WarmPoolStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'WarmPoolResourceStatus', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'shape' => 'ResourceRetainedBillableTimeInSeconds', ], 'ReusedByJob' => [ 'shape' => 'TrainingJobName', ], ], ], 'Workforce' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', 'WorkforceArn', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'SubDomain' => [ 'shape' => 'String', ], 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfigForResponse', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigResponse', ], 'Status' => [ 'shape' => 'WorkforceStatus', ], 'FailureReason' => [ 'shape' => 'WorkforceFailureReason', ], ], ], 'WorkforceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*', ], 'WorkforceFailureReason' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'WorkforceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$', ], 'WorkforceSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^sg-[0-9a-z]*$', ], 'WorkforceSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WorkforceStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Updating', 'Deleting', 'Failed', 'Active', ], ], 'WorkforceSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^subnet-[0-9a-z]*$', ], 'WorkforceSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSubnetId', ], 'max' => 16, 'min' => 1, ], 'WorkforceVpcConfigRequest' => [ 'type' => 'structure', 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], ], ], 'WorkforceVpcConfigResponse' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], 'VpcEndpointId' => [ 'shape' => 'WorkforceVpcEndpointId', ], ], ], 'WorkforceVpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'WorkforceVpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^vpc-[0-9a-z]*$', ], 'Workforces' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workforce', ], ], 'WorkspaceSettings' => [ 'type' => 'structure', 'members' => [ 'S3ArtifactPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'Workteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'WorkteamArn', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'ProductListingIds' => [ 'shape' => 'ProductListings', ], 'Description' => [ 'shape' => 'String200', ], 'SubDomain' => [ 'shape' => 'String', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'WorkteamArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*', ], 'WorkteamName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'Workteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workteam', ], ], ],]; diff --git a/src/data/sagemaker/2017-07-24/docs-2.json b/src/data/sagemaker/2017-07-24/docs-2.json index 09ee096959..6240ca51b4 100644 --- a/src/data/sagemaker/2017-07-24/docs-2.json +++ b/src/data/sagemaker/2017-07-24/docs-2.json @@ -5136,6 +5136,12 @@ "refs": { } }, + "EnableSessionTagChaining": { + "base": null, + "refs": { + "SessionChainingConfig$EnableSessionTagChaining": "

Set to True to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.

" + } + }, "Endpoint": { "base": "

A hosted endpoint for real-time inference.

", "refs": { @@ -13413,6 +13419,12 @@ "UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails": "

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

" } }, + "SessionChainingConfig": { + "base": "

Contains information about attribute-based access control (ABAC) for a training job.

", + "refs": { + "CreateTrainingJobRequest$SessionChainingConfig": "

Contains information about attribute-based access control (ABAC) for the training job.

" + } + }, "SessionExpirationDurationInSeconds": { "base": null, "refs": { diff --git a/src/data/sagemaker/2017-07-24/docs-2.json.php b/src/data/sagemaker/2017-07-24/docs-2.json.php index 93c52ec6a8..946c9e732c 100644 --- a/src/data/sagemaker/2017-07-24/docs-2.json.php +++ b/src/data/sagemaker/2017-07-24/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Provides APIs for creating and managing SageMaker resources.

Other Resources:

', 'operations' => [ 'AddAssociation' => '

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'AddTags' => '

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

', 'AssociateTrialComponent' => '

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'BatchDescribeModelPackage' => '

This action batch describes a list of versioned model packages

', 'CreateAction' => '

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAlgorithm' => '

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

', 'CreateApp' => '

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

', 'CreateAppImageConfig' => '

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

', 'CreateArtifact' => '

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAutoMLJob' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

', 'CreateAutoMLJobV2' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

', 'CreateCluster' => '

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

', 'CreateCodeRepository' => '

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

', 'CreateCompilationJob' => '

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

You can also provide a Tag to track the model compilation job\'s resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'CreateContext' => '

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateDataQualityJobDefinition' => '

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateDeviceFleet' => '

Creates a device fleet.

', 'CreateDomain' => '

Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

', 'CreateEdgeDeploymentPlan' => '

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

', 'CreateEdgeDeploymentStage' => '

Creates a new stage in an existing edge deployment plan.

', 'CreateEdgePackagingJob' => '

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

', 'CreateEndpoint' => '

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

', 'CreateEndpointConfig' => '

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

', 'CreateExperiment' => '

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment\'s properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

', 'CreateFeatureGroup' => '

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

', 'CreateFlowDefinition' => '

Creates a flow definition.

', 'CreateHub' => '

Create a hub.

Hub APIs are only callable through SageMaker Studio.

', 'CreateHumanTaskUi' => '

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

', 'CreateHyperParameterTuningJob' => '

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'CreateImage' => '

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.

', 'CreateImageVersion' => '

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

', 'CreateInferenceComponent' => '

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

', 'CreateInferenceExperiment' => '

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint\'s model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

', 'CreateInferenceRecommendationsJob' => '

Starts a recommendation job. You can create either an instance recommendation or load test job.

', 'CreateLabelingJob' => '

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

', 'CreateModel' => '

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

', 'CreateModelBiasJobDefinition' => '

Creates the definition for a model bias job.

', 'CreateModelCard' => '

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

', 'CreateModelCardExportJob' => '

Creates an Amazon SageMaker Model Card export job.

', 'CreateModelExplainabilityJobDefinition' => '

Creates the definition for a model explainability job.

', 'CreateModelPackage' => '

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

', 'CreateModelPackageGroup' => '

Creates a model group. A model group contains a group of model versions.

', 'CreateModelQualityJobDefinition' => '

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateMonitoringSchedule' => '

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.

', 'CreateNotebookInstance' => '

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker does the following:

  1. Creates a network interface in the SageMaker VPC.

  2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can\'t change the name of a notebook instance after you create it.

After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

', 'CreateNotebookInstanceLifecycleConfig' => '

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreatePipeline' => '

Creates a pipeline using a JSON pipeline definition.

', 'CreatePresignedDomainUrl' => '

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain\'s Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreatePresignedNotebookInstanceUrl' => '

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreateProcessingJob' => '

Creates a processing job.

', 'CreateProject' => '

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

', 'CreateSpace' => '

Creates a space used for real time collaboration in a domain.

', 'CreateStudioLifecycleConfig' => '

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

', 'CreateTrainingJob' => '

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

For more information about SageMaker, see How It Works.

', 'CreateTransformJob' => '

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

For more information about how batch transformation works, see Batch Transform.

', 'CreateTrial' => '

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial\'s properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

', 'CreateTrialComponent' => '

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

', 'CreateUserProfile' => '

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user\'s private Amazon Elastic File System home directory.

', 'CreateWorkforce' => '

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

', 'CreateWorkteam' => '

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

', 'DeleteAction' => '

Deletes an action.

', 'DeleteAlgorithm' => '

Removes the specified algorithm from your account.

', 'DeleteApp' => '

Used to stop and delete an app.

', 'DeleteAppImageConfig' => '

Deletes an AppImageConfig.

', 'DeleteArtifact' => '

Deletes an artifact. Either ArtifactArn or Source must be specified.

', 'DeleteAssociation' => '

Deletes an association.

', 'DeleteCluster' => '

Delete a SageMaker HyperPod cluster.

', 'DeleteCodeRepository' => '

Deletes the specified Git repository from your account.

', 'DeleteCompilationJob' => '

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn\'t delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

', 'DeleteContext' => '

Deletes an context.

', 'DeleteDataQualityJobDefinition' => '

Deletes a data quality monitoring job definition.

', 'DeleteDeviceFleet' => '

Deletes a fleet.

', 'DeleteDomain' => '

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteEdgeDeploymentPlan' => '

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

', 'DeleteEdgeDeploymentStage' => '

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

', 'DeleteEndpoint' => '

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don\'t need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

', 'DeleteEndpointConfig' => '

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'DeleteExperiment' => '

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

', 'DeleteFeatureGroup' => '

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

', 'DeleteFlowDefinition' => '

Deletes the specified flow definition.

', 'DeleteHub' => '

Delete a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHubContent' => '

Delete the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHumanTaskUi' => '

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

', 'DeleteHyperParameterTuningJob' => '

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

', 'DeleteImage' => '

Deletes a SageMaker image and all versions of the image. The container images aren\'t deleted.

', 'DeleteImageVersion' => '

Deletes a version of a SageMaker image. The container image the version represents isn\'t deleted.

', 'DeleteInferenceComponent' => '

Deletes an inference component.

', 'DeleteInferenceExperiment' => '

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

', 'DeleteModel' => '

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

', 'DeleteModelBiasJobDefinition' => '

Deletes an Amazon SageMaker model bias job definition.

', 'DeleteModelCard' => '

Deletes an Amazon SageMaker Model Card.

', 'DeleteModelExplainabilityJobDefinition' => '

Deletes an Amazon SageMaker model explainability job definition.

', 'DeleteModelPackage' => '

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

', 'DeleteModelPackageGroup' => '

Deletes the specified model group.

', 'DeleteModelPackageGroupPolicy' => '

Deletes a model group resource policy.

', 'DeleteModelQualityJobDefinition' => '

Deletes the secified model quality monitoring job definition.

', 'DeleteMonitoringSchedule' => '

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

', 'DeleteNotebookInstance' => '

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

', 'DeleteNotebookInstanceLifecycleConfig' => '

Deletes a notebook instance lifecycle configuration.

', 'DeletePipeline' => '

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

', 'DeleteProject' => '

Delete the specified project.

', 'DeleteSpace' => '

Used to delete a space.

', 'DeleteStudioLifecycleConfig' => '

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

', 'DeleteTags' => '

Deletes the specified tags from an SageMaker resource.

To list a resource\'s tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

', 'DeleteTrial' => '

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

', 'DeleteTrialComponent' => '

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'DeleteUserProfile' => '

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteWorkforce' => '

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

', 'DeleteWorkteam' => '

Deletes an existing work team. This operation can\'t be undone.

', 'DeregisterDevices' => '

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

', 'DescribeAction' => '

Describes an action.

', 'DescribeAlgorithm' => '

Returns a description of the specified algorithm that is in your account.

', 'DescribeApp' => '

Describes the app.

', 'DescribeAppImageConfig' => '

Describes an AppImageConfig.

', 'DescribeArtifact' => '

Describes an artifact.

', 'DescribeAutoMLJob' => '

Returns information about an AutoML job created by calling CreateAutoMLJob.

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

', 'DescribeAutoMLJobV2' => '

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

', 'DescribeCluster' => '

Retrieves information of a SageMaker HyperPod cluster.

', 'DescribeClusterNode' => '

Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'DescribeCodeRepository' => '

Gets details about the specified Git repository.

', 'DescribeCompilationJob' => '

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'DescribeContext' => '

Describes a context.

', 'DescribeDataQualityJobDefinition' => '

Gets the details of a data quality monitoring job definition.

', 'DescribeDevice' => '

Describes the device.

', 'DescribeDeviceFleet' => '

A description of the fleet the device belongs to.

', 'DescribeDomain' => '

The description of the domain.

', 'DescribeEdgeDeploymentPlan' => '

Describes an edge deployment plan with deployment status per stage.

', 'DescribeEdgePackagingJob' => '

A description of edge packaging jobs.

', 'DescribeEndpoint' => '

Returns the description of an endpoint.

', 'DescribeEndpointConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeExperiment' => '

Provides a list of an experiment\'s properties.

', 'DescribeFeatureGroup' => '

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

', 'DescribeFeatureMetadata' => '

Shows the metadata for a feature within a feature group.

', 'DescribeFlowDefinition' => '

Returns information about the specified flow definition.

', 'DescribeHub' => '

Describe a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHubContent' => '

Describe the content of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHumanTaskUi' => '

Returns information about the requested human task user interface (worker task template).

', 'DescribeHyperParameterTuningJob' => '

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

', 'DescribeImage' => '

Describes a SageMaker image.

', 'DescribeImageVersion' => '

Describes a version of a SageMaker image.

', 'DescribeInferenceComponent' => '

Returns information about an inference component.

', 'DescribeInferenceExperiment' => '

Returns details about an inference experiment.

', 'DescribeInferenceRecommendationsJob' => '

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

', 'DescribeLabelingJob' => '

Gets information about a labeling job.

', 'DescribeLineageGroup' => '

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'DescribeModel' => '

Describes a model that you created using the CreateModel API.

', 'DescribeModelBiasJobDefinition' => '

Returns a description of a model bias job definition.

', 'DescribeModelCard' => '

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

', 'DescribeModelCardExportJob' => '

Describes an Amazon SageMaker Model Card export job.

', 'DescribeModelExplainabilityJobDefinition' => '

Returns a description of a model explainability job definition.

', 'DescribeModelPackage' => '

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

', 'DescribeModelPackageGroup' => '

Gets a description for the specified model group.

', 'DescribeModelQualityJobDefinition' => '

Returns a description of a model quality job definition.

', 'DescribeMonitoringSchedule' => '

Describes the schedule for a monitoring job.

', 'DescribeNotebookInstance' => '

Returns information about a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfig' => '

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'DescribePipeline' => '

Describes the details of a pipeline.

', 'DescribePipelineDefinitionForExecution' => '

Describes the details of an execution\'s pipeline definition.

', 'DescribePipelineExecution' => '

Describes the details of a pipeline execution.

', 'DescribeProcessingJob' => '

Returns a description of a processing job.

', 'DescribeProject' => '

Describes the details of a project.

', 'DescribeSpace' => '

Describes the space.

', 'DescribeStudioLifecycleConfig' => '

Describes the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeSubscribedWorkteam' => '

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

', 'DescribeTrainingJob' => '

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

', 'DescribeTransformJob' => '

Returns information about a transform job.

', 'DescribeTrial' => '

Provides a list of a trial\'s properties.

', 'DescribeTrialComponent' => '

Provides a list of a trials component\'s properties.

', 'DescribeUserProfile' => '

Describes a user profile. For more information, see CreateUserProfile.

', 'DescribeWorkforce' => '

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

', 'DescribeWorkteam' => '

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team\'s Amazon Resource Name (ARN).

', 'DisableSagemakerServicecatalogPortfolio' => '

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'DisassociateTrialComponent' => '

Disassociates a trial component from a trial. This doesn\'t effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

', 'EnableSagemakerServicecatalogPortfolio' => '

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetDeviceFleetReport' => '

Describes a fleet.

', 'GetLineageGroupPolicy' => '

The resource policy for the lineage group.

', 'GetModelPackageGroupPolicy' => '

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'GetSagemakerServicecatalogPortfolioStatus' => '

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetScalingConfigurationRecommendation' => '

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

', 'GetSearchSuggestions' => '

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

', 'ImportHubContent' => '

Import hub content.

Hub APIs are only callable through SageMaker Studio.

', 'ListActions' => '

Lists the actions in your account and their properties.

', 'ListAlgorithms' => '

Lists the machine learning algorithms that have been created.

', 'ListAliases' => '

Lists the aliases of a specified image or image version.

', 'ListAppImageConfigs' => '

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

', 'ListApps' => '

Lists apps.

', 'ListArtifacts' => '

Lists the artifacts in your account and their properties.

', 'ListAssociations' => '

Lists the associations in your account and their properties.

', 'ListAutoMLJobs' => '

Request a list of jobs.

', 'ListCandidatesForAutoMLJob' => '

List the candidates created for the job.

', 'ListClusterNodes' => '

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

', 'ListClusters' => '

Retrieves the list of SageMaker HyperPod clusters.

', 'ListCodeRepositories' => '

Gets a list of the Git repositories in your account.

', 'ListCompilationJobs' => '

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

', 'ListContexts' => '

Lists the contexts in your account and their properties.

', 'ListDataQualityJobDefinitions' => '

Lists the data quality job definitions in your account.

', 'ListDeviceFleets' => '

Returns a list of devices in the fleet.

', 'ListDevices' => '

A list of devices.

', 'ListDomains' => '

Lists the domains.

', 'ListEdgeDeploymentPlans' => '

Lists all edge deployment plans.

', 'ListEdgePackagingJobs' => '

Returns a list of edge packaging jobs.

', 'ListEndpointConfigs' => '

Lists endpoint configurations.

', 'ListEndpoints' => '

Lists endpoints.

', 'ListExperiments' => '

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

', 'ListFeatureGroups' => '

List FeatureGroups based on given filter and order.

', 'ListFlowDefinitions' => '

Returns information about the flow definitions in your account.

', 'ListHubContentVersions' => '

List hub content versions.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubContents' => '

List the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubs' => '

List all existing hubs.

Hub APIs are only callable through SageMaker Studio.

', 'ListHumanTaskUis' => '

Returns information about the human task user interfaces in your account.

', 'ListHyperParameterTuningJobs' => '

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

', 'ListImageVersions' => '

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

', 'ListImages' => '

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

', 'ListInferenceComponents' => '

Lists the inference components in your account and their properties.

', 'ListInferenceExperiments' => '

Returns the list of all inference experiments.

', 'ListInferenceRecommendationsJobSteps' => '

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobs' => '

Lists recommendation jobs that satisfy various filters.

', 'ListLabelingJobs' => '

Gets a list of labeling jobs.

', 'ListLabelingJobsForWorkteam' => '

Gets a list of labeling jobs assigned to a specified work team.

', 'ListLineageGroups' => '

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'ListModelBiasJobDefinitions' => '

Lists model bias jobs definitions that satisfy various filters.

', 'ListModelCardExportJobs' => '

List the export jobs for the Amazon SageMaker Model Card.

', 'ListModelCardVersions' => '

List existing versions of an Amazon SageMaker Model Card.

', 'ListModelCards' => '

List existing model cards.

', 'ListModelExplainabilityJobDefinitions' => '

Lists model explainability job definitions that satisfy various filters.

', 'ListModelMetadata' => '

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

', 'ListModelPackageGroups' => '

Gets a list of the model groups in your Amazon Web Services account.

', 'ListModelPackages' => '

Lists the model packages that have been created.

', 'ListModelQualityJobDefinitions' => '

Gets a list of model quality monitoring job definitions in your account.

', 'ListModels' => '

Lists models created with the CreateModel API.

', 'ListMonitoringAlertHistory' => '

Gets a list of past alerts in a model monitoring schedule.

', 'ListMonitoringAlerts' => '

Gets the alerts for a single monitoring schedule.

', 'ListMonitoringExecutions' => '

Returns list of all monitoring job executions.

', 'ListMonitoringSchedules' => '

Returns list of all monitoring schedules.

', 'ListNotebookInstanceLifecycleConfigs' => '

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

', 'ListNotebookInstances' => '

Returns a list of the SageMaker notebook instances in the requester\'s account in an Amazon Web Services Region.

', 'ListPipelineExecutionSteps' => '

Gets a list of PipeLineExecutionStep objects.

', 'ListPipelineExecutions' => '

Gets a list of the pipeline executions.

', 'ListPipelineParametersForExecution' => '

Gets a list of parameters for a pipeline execution.

', 'ListPipelines' => '

Gets a list of pipelines.

', 'ListProcessingJobs' => '

Lists processing jobs that satisfy various filters.

', 'ListProjects' => '

Gets a list of the projects in an Amazon Web Services account.

', 'ListResourceCatalogs' => '

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

', 'ListSpaces' => '

Lists spaces.

', 'ListStageDevices' => '

Lists devices allocated to the stage, containing detailed device information and deployment status.

', 'ListStudioLifecycleConfigs' => '

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

', 'ListSubscribedWorkteams' => '

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'ListTags' => '

Returns the tags for the specified SageMaker resource.

', 'ListTrainingJobs' => '

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

', 'ListTrainingJobsForHyperParameterTuningJob' => '

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

', 'ListTransformJobs' => '

Lists transform jobs.

', 'ListTrialComponents' => '

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

', 'ListTrials' => '

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

', 'ListUserProfiles' => '

Lists user profiles.

', 'ListWorkforces' => '

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

', 'ListWorkteams' => '

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'PutModelPackageGroupPolicy' => '

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'QueryLineage' => '

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

', 'RegisterDevices' => '

Register devices.

', 'RenderUiTemplate' => '

Renders the UI template so that you can preview the worker\'s experience.

', 'RetryPipelineExecution' => '

Retry the execution of the pipeline.

', 'Search' => '

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

', 'SendPipelineExecutionStepFailure' => '

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'SendPipelineExecutionStepSuccess' => '

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step\'s output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'StartEdgeDeploymentStage' => '

Starts a stage in an edge deployment plan.

', 'StartInferenceExperiment' => '

Starts an inference experiment.

', 'StartMonitoringSchedule' => '

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

', 'StartNotebookInstance' => '

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance\'s status must be InService before you can connect to your Jupyter notebook.

', 'StartPipelineExecution' => '

Starts a pipeline execution.

', 'StopAutoMLJob' => '

A method for forcing a running job to shut down.

', 'StopCompilationJob' => '

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn\'t stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

', 'StopEdgeDeploymentStage' => '

Stops a stage in an edge deployment plan.

', 'StopEdgePackagingJob' => '

Request to stop an edge packaging job.

', 'StopHyperParameterTuningJob' => '

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

', 'StopInferenceExperiment' => '

Stops an inference experiment.

', 'StopInferenceRecommendationsJob' => '

Stops an Inference Recommender job.

', 'StopLabelingJob' => '

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

', 'StopMonitoringSchedule' => '

Stops a previously started monitoring schedule.

', 'StopNotebookInstance' => '

Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

', 'StopPipelineExecution' => '

Stops a pipeline execution.

Callback Step

A pipeline execution won\'t stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can\'t be stopped while a lambda step is running because the Lambda function invoked by the lambda step can\'t be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

', 'StopProcessingJob' => '

Stops a processing job.

', 'StopTrainingJob' => '

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

', 'StopTransformJob' => '

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn\'t store the job\'s output in Amazon S3.

', 'UpdateAction' => '

Updates an action.

', 'UpdateAppImageConfig' => '

Updates the properties of an AppImageConfig.

', 'UpdateArtifact' => '

Updates an artifact.

', 'UpdateCluster' => '

Updates a SageMaker HyperPod cluster.

', 'UpdateClusterSoftware' => '

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

', 'UpdateCodeRepository' => '

Updates the specified Git repository with the specified values.

', 'UpdateContext' => '

Updates a context.

', 'UpdateDeviceFleet' => '

Updates a fleet of devices.

', 'UpdateDevices' => '

Updates one or more devices in a fleet.

', 'UpdateDomain' => '

Updates the default settings for new user profiles in the domain.

', 'UpdateEndpoint' => '

Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'UpdateEndpointWeightsAndCapacities' => '

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

', 'UpdateExperiment' => '

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

', 'UpdateFeatureGroup' => '

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.

', 'UpdateFeatureMetadata' => '

Updates the description and parameters of the feature group.

', 'UpdateHub' => '

Update a hub.

Hub APIs are only callable through SageMaker Studio.

', 'UpdateImage' => '

Updates the properties of a SageMaker image. To change the image\'s tags, use the AddTags and DeleteTags APIs.

', 'UpdateImageVersion' => '

Updates the properties of a SageMaker image version.

', 'UpdateInferenceComponent' => '

Updates an inference component.

', 'UpdateInferenceComponentRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceExperiment' => '

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

', 'UpdateModelCard' => '

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

', 'UpdateModelPackage' => '

Updates a versioned model.

', 'UpdateMonitoringAlert' => '

Update the parameters of a model monitor alert.

', 'UpdateMonitoringSchedule' => '

Updates a previously created schedule.

', 'UpdateNotebookInstance' => '

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

', 'UpdateNotebookInstanceLifecycleConfig' => '

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

', 'UpdatePipeline' => '

Updates a pipeline.

', 'UpdatePipelineExecution' => '

Updates a pipeline execution.

', 'UpdateProject' => '

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

', 'UpdateSpace' => '

Updates the settings of a space.

', 'UpdateTrainingJob' => '

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

', 'UpdateTrial' => '

Updates the display name of a trial.

', 'UpdateTrialComponent' => '

Updates one or more properties of a trial component.

', 'UpdateUserProfile' => '

Updates a user profile.

', 'UpdateWorkforce' => '

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn\'t restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

', 'UpdateWorkteam' => '

Updates an existing work team with new member definitions or description.

', ], 'shapes' => [ 'Accept' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$Accept' => '

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

', ], ], 'AcceptEula' => [ 'base' => NULL, 'refs' => [ 'ModelAccessConfig$AcceptEula' => '

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LabelingJobForWorkteamSummary$WorkRequesterAccountId' => '

The Amazon Web Services account ID of the account used to start the labeling job.

', 'VpcOnlyTrustedAccounts$member' => NULL, ], ], 'ActionArn' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'CreateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DeleteActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DescribeActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'UpdateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', ], ], 'ActionSource' => [ 'base' => '

A structure describing the source of an action.

', 'refs' => [ 'ActionSummary$Source' => '

The source of the action.

', 'CreateActionRequest$Source' => '

The source type, ID, and URI.

', 'DescribeActionResponse$Source' => '

The source of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$Status' => '

The status of the action.

', 'CreateActionRequest$Status' => '

The status of the action.

', 'DescribeActionResponse$Status' => '

The status of the action.

', 'UpdateActionRequest$Status' => '

The new status for the action.

', ], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListActionsResponse$ActionSummaries' => '

A list of actions and their properties.

', ], ], 'ActionSummary' => [ 'base' => '

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'AddAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'NotebookInstanceSummary$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'AdditionalInferenceSpecificationDefinition' => [ 'base' => '

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

', 'refs' => [ 'AdditionalInferenceSpecifications$member' => NULL, ], ], 'AdditionalInferenceSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'DescribeModelPackageOutput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'ModelPackage$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects.

', 'UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd' => '

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', ], ], 'AdditionalS3DataSource' => [ 'base' => '

A data source used for training or inference that is in addition to the input dataset or model data.

', 'refs' => [ 'ModelPackageContainerDefinition$AdditionalS3DataSource' => '

The additional data source that is used during inference in the Docker container for your model package.

', 'TrainingSpecification$AdditionalS3DataSource' => '

The additional data source used during the training job.

', ], ], 'AdditionalS3DataSourceDataType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3DataType' => '

The data type of the additional data source that you specify for use in inference or training.

', ], ], 'AgentVersion' => [ 'base' => '

Edge Manager agent version.

', 'refs' => [ 'AgentVersions$member' => NULL, ], ], 'AgentVersions' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$AgentVersions' => '

The versions of Edge Manager agent deployed on the fleet.

', ], ], 'AggregationTransformationValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$value' => NULL, ], ], 'AggregationTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Aggregation' => '

A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

The supported aggregation methods are sum (default), avg, first, min, max.

Aggregation is only supported for the target column.

', ], ], 'Alarm' => [ 'base' => '

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

', 'refs' => [ 'AlarmList$member' => NULL, ], ], 'AlarmList' => [ 'base' => NULL, 'refs' => [ 'AutoRollbackConfig$Alarms' => '

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

', ], ], 'AlarmName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmName' => '

The name of a CloudWatch alarm in your account.

', ], ], 'AlgorithmArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', 'CreateAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the new algorithm.

', 'DescribeAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', ], ], 'AlgorithmImage' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

', 'DebugRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

', 'HyperParameterAlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'ProfilerRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container Registry Image for the managed rule evaluation.

', ], ], 'AlgorithmSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AlgorithmSpecification' => [ 'base' => '

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'refs' => [ 'CreateTrainingJobRequest$AlgorithmSpecification' => '

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'DescribeTrainingJobResponse$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', 'TrainingJob$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', ], ], 'AlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmStatus' => '

The overall status of the algorithm.

', 'DescribeAlgorithmOutput$AlgorithmStatus' => '

The current status of the algorithm.

', ], ], 'AlgorithmStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the algorithm.

', 'refs' => [ 'DescribeAlgorithmOutput$AlgorithmStatusDetails' => '

Details about the current status of the algorithm.

', ], ], 'AlgorithmStatusItem' => [ 'base' => '

Represents the overall status of an algorithm.

', 'refs' => [ 'AlgorithmStatusItemList$member' => NULL, ], ], 'AlgorithmStatusItemList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusDetails$ValidationStatuses' => '

The status of algorithm validation.

', 'AlgorithmStatusDetails$ImageScanStatuses' => '

The status of the scan of the algorithm\'s Docker image container.

', ], ], 'AlgorithmSummary' => [ 'base' => '

Provides summary information about an algorithm.

', 'refs' => [ 'AlgorithmSummaryList$member' => NULL, ], ], 'AlgorithmSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsOutput$AlgorithmSummaryList' => '

>An array of AlgorithmSummary objects, each of which lists an algorithm.

', ], ], 'AlgorithmValidationProfile' => [ 'base' => '

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'AlgorithmValidationProfiles$member' => NULL, ], ], 'AlgorithmValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationProfiles' => '

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

', ], ], 'AlgorithmValidationSpecification' => [ 'base' => '

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

', 'refs' => [ 'CreateAlgorithmInput$ValidationSpecification' => '

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm\'s training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm\'s inference code.

', 'DescribeAlgorithmOutput$ValidationSpecification' => '

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

', ], ], 'AnnotationConsolidationConfig' => [ 'base' => '

Configures how labels are consolidated across human workers and processes output data.

', 'refs' => [ 'HumanTaskConfig$AnnotationConsolidationConfig' => '

Configures how labels are consolidated across human workers.

', ], ], 'AppArn' => [ 'base' => NULL, 'refs' => [ 'CreateAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', 'DescribeAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', ], ], 'AppDetails' => [ 'base' => '

Details about an Amazon SageMaker app.

', 'refs' => [ 'AppList$member' => NULL, ], ], 'AppImageConfigArn' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigArn' => '

The ARN of the AppImageConfig.

', 'CreateAppImageConfigResponse$AppImageConfigArn' => '

The ARN of the AppImageConfig.

', 'DescribeAppImageConfigResponse$AppImageConfigArn' => '

The ARN of the AppImageConfig.

', 'UpdateAppImageConfigResponse$AppImageConfigArn' => '

The ARN for the AppImageConfig.

', ], ], 'AppImageConfigDetails' => [ 'base' => '

The configuration for running a SageMaker image as a KernelGateway app.

', 'refs' => [ 'AppImageConfigList$member' => NULL, ], ], 'AppImageConfigList' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsResponse$AppImageConfigs' => '

A list of AppImageConfigs and their properties.

', ], ], 'AppImageConfigName' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CreateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CustomImage$AppImageConfigName' => '

The name of the AppImageConfig.

', 'DeleteAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to delete.

', 'DescribeAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to describe.

', 'DescribeAppImageConfigResponse$AppImageConfigName' => '

The name of the AppImageConfig.

', 'ListAppImageConfigsRequest$NameContains' => '

A filter that returns only AppImageConfigs whose name contains the specified string.

', 'UpdateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to update.

', ], ], 'AppImageConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'AppInstanceType' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$InstanceType' => '

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

', ], ], 'AppList' => [ 'base' => NULL, 'refs' => [ 'ListAppsResponse$Apps' => '

The list of apps.

', ], ], 'AppManaged' => [ 'base' => NULL, 'refs' => [ 'ProcessingInput$AppManaged' => '

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

', 'ProcessingOutput$AppManaged' => '

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

', ], ], 'AppName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppName' => '

The name of the app.

', 'CreateAppRequest$AppName' => '

The name of the app.

', 'DeleteAppRequest$AppName' => '

The name of the app.

', 'DescribeAppRequest$AppName' => '

The name of the app.

', 'DescribeAppResponse$AppName' => '

The name of the app.

', ], ], 'AppNetworkAccessType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

', 'DescribeDomainResponse$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

', 'UpdateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

', ], ], 'AppSecurityGroupManagement' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', 'DescribeDomainResponse$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

', 'UpdateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', ], ], 'AppSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AppSpecification' => [ 'base' => '

Configuration to run a processing job in a specified container image.

', 'refs' => [ 'CreateProcessingJobRequest$AppSpecification' => '

Configures the processing job to run a specified Docker container image.

', 'DescribeProcessingJobResponse$AppSpecification' => '

Configures the processing job to run a specified container image.

', 'ProcessingJob$AppSpecification' => NULL, ], ], 'AppStatus' => [ 'base' => NULL, 'refs' => [ 'AppDetails$Status' => '

The status.

', 'DescribeAppResponse$Status' => '

The status.

', ], ], 'AppType' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppType' => '

The type of app.

', 'CreateAppRequest$AppType' => '

The type of app.

', 'DeleteAppRequest$AppType' => '

The type of app.

', 'DescribeAppRequest$AppType' => '

The type of app.

', 'DescribeAppResponse$AppType' => '

The type of app.

', 'SpaceSettings$AppType' => '

The type of app created within the space.

', 'SpaceSettingsSummary$AppType' => '

The type of app created within the space.

', ], ], 'ApprovalDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageOutput$ApprovalDescription' => '

A description provided for the model approval.

', 'ModelPackage$ApprovalDescription' => '

A description provided when the model approval is set.

', 'UpdateModelPackageInput$ApprovalDescription' => '

A description for the approval status of the model.

', ], ], 'ArnOrName' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$AlgorithmName' => '

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can\'t specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don\'t specify any value for both parameters, the training job might raise a null error.

', 'CreateModelPackageInput$ModelPackageGroupName' => '

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

', 'DeleteModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group to delete.

', 'DescribeAlgorithmInput$AlgorithmName' => '

The name of the algorithm to describe.

', 'DescribeModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group to describe.

', 'HyperParameterAlgorithmSpecification$AlgorithmName' => '

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

', 'ListModelPackagesInput$ModelPackageGroupName' => '

A filter that returns only model versions that belong to the specified model group.

', 'SourceAlgorithm$AlgorithmName' => '

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', ], ], 'ArtifactArn' => [ 'base' => NULL, 'refs' => [ 'ArtifactSummary$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'CreateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DeleteArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to delete.

', 'DeleteArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DescribeArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to describe.

', 'DescribeArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'UpdateArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to update.

', 'UpdateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', ], ], 'ArtifactDigest' => [ 'base' => NULL, 'refs' => [ 'ModelDigests$ArtifactDigest' => '

Provides a hash value that uniquely identifies the stored model artifacts.

', ], ], 'ArtifactProperties' => [ 'base' => NULL, 'refs' => [ 'CreateArtifactRequest$Properties' => '

A list of properties to add to the artifact.

', 'UpdateArtifactRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'ArtifactPropertyValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$value' => NULL, ], ], 'ArtifactSource' => [ 'base' => '

A structure describing the source of an artifact.

', 'refs' => [ 'ArtifactSummary$Source' => '

The source of the artifact.

', 'CreateArtifactRequest$Source' => '

The ID, ID type, and URI of the source.

', 'DeleteArtifactRequest$Source' => '

The URI of the source.

', 'DescribeArtifactResponse$Source' => '

The source of the artifact.

', ], ], 'ArtifactSourceIdType' => [ 'base' => NULL, 'refs' => [ 'ArtifactSourceType$SourceIdType' => '

The type of ID.

', ], ], 'ArtifactSourceType' => [ 'base' => '

The ID and ID type of an artifact source.

', 'refs' => [ 'ArtifactSourceTypes$member' => NULL, ], ], 'ArtifactSourceTypes' => [ 'base' => NULL, 'refs' => [ 'ArtifactSource$SourceTypes' => '

A list of source types.

', ], ], 'ArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsResponse$ArtifactSummaries' => '

A list of artifacts and their properties.

', ], ], 'ArtifactSummary' => [ 'base' => '

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

', 'refs' => [ 'ArtifactSummaries$member' => NULL, ], ], 'AssemblyType' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$AssembleWith' => '

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

', ], ], 'AssociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociationEdgeType' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$AssociationType' => '

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

', 'AssociationSummary$AssociationType' => '

The type of the association.

', 'Edge$AssociationType' => '

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

', 'ListAssociationsRequest$AssociationType' => '

A filter that returns only associations of the specified type.

', ], ], 'AssociationEntityArn' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$SourceArn' => '

The ARN of the source.

', 'AddAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AddAssociationResponse$SourceArn' => '

The ARN of the source.

', 'AddAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AssociationSummary$SourceArn' => '

The ARN of the source.

', 'AssociationSummary$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationRequest$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationResponse$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'Edge$SourceArn' => '

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

', 'Edge$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

', 'ListAssociationsRequest$SourceArn' => '

A filter that returns only associations with the specified source ARN.

', 'ListAssociationsRequest$DestinationArn' => '

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

', 'QueryLineageStartArns$member' => NULL, 'Vertex$Arn' => '

The Amazon Resource Name (ARN) of the lineage entity resource.

', ], ], 'AssociationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsResponse$AssociationSummaries' => '

A list of associations and their properties.

', ], ], 'AssociationSummary' => [ 'base' => '

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

', 'refs' => [ 'AssociationSummaries$member' => NULL, ], ], 'AsyncInferenceClientConfig' => [ 'base' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', 'refs' => [ 'AsyncInferenceConfig$ClientConfig' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', ], ], 'AsyncInferenceConfig' => [ 'base' => '

Specifies configuration for how an endpoint performs asynchronous inference.

', 'refs' => [ 'CreateEndpointConfigInput$AsyncInferenceConfig' => '

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

', 'DescribeEndpointConfigOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeEndpointOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', ], ], 'AsyncInferenceNotificationConfig' => [ 'base' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', 'refs' => [ 'AsyncInferenceOutputConfig$NotificationConfig' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', ], ], 'AsyncInferenceOutputConfig' => [ 'base' => '

Specifies the configuration for asynchronous inference invocation outputs.

', 'refs' => [ 'AsyncInferenceConfig$OutputConfig' => '

Specifies the configuration for asynchronous inference invocation outputs.

', ], ], 'AsyncNotificationTopicTypeList' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$IncludeInferenceResponseIn' => '

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

', ], ], 'AsyncNotificationTopicTypes' => [ 'base' => NULL, 'refs' => [ 'AsyncNotificationTopicTypeList$member' => NULL, ], ], 'AthenaCatalog' => [ 'base' => '

The name of the data catalog used in Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Catalog' => NULL, ], ], 'AthenaDatabase' => [ 'base' => '

The name of the database used in the Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Database' => NULL, ], ], 'AthenaDatasetDefinition' => [ 'base' => '

Configuration for Athena Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$AthenaDatasetDefinition' => NULL, ], ], 'AthenaQueryString' => [ 'base' => '

The SQL query statements, to be executed.

', 'refs' => [ 'AthenaDatasetDefinition$QueryString' => NULL, ], ], 'AthenaResultCompressionType' => [ 'base' => '

The compression used for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputCompression' => NULL, ], ], 'AthenaResultFormat' => [ 'base' => '

The data storage format for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputFormat' => NULL, ], ], 'AthenaWorkGroup' => [ 'base' => '

The name of the workgroup in which the Athena query is being started.

', 'refs' => [ 'AthenaDatasetDefinition$WorkGroup' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeNames$member' => NULL, ], ], 'AttributeNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$AttributeNames' => '

A list of one or more attribute names to use that are found in a specified augmented manifest file.

', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AuthMode' => '

The mode of authentication that members use to access the domain.

', 'DescribeDomainResponse$AuthMode' => '

The domain\'s authentication mode.

', ], ], 'AutoGenerateEndpointName' => [ 'base' => NULL, 'refs' => [ 'ModelDeployConfig$AutoGenerateEndpointName' => '

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

', ], ], 'AutoMLAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithms$member' => NULL, ], ], 'AutoMLAlgorithmConfig' => [ 'base' => '

The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.

', 'refs' => [ 'AutoMLAlgorithmsConfig$member' => NULL, ], ], 'AutoMLAlgorithms' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithmConfig$AutoMLAlgorithms' => '

The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.

Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

', ], ], 'AutoMLAlgorithmsConfig' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', 'CandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train model candidates on tabular data.

The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .

For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', ], ], 'AutoMLCandidate' => [ 'base' => '

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

', 'refs' => [ 'AutoMLCandidates$member' => NULL, 'DescribeAutoMLJobResponse$BestCandidate' => '

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

', 'DescribeAutoMLJobV2Response$BestCandidate' => '

Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

', ], ], 'AutoMLCandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how a candidate is generated (optional).

', 'refs' => [ 'AutoMLJobConfig$CandidateGenerationConfig' => '

The configuration for generating a candidate for an AutoML job (optional).

', ], ], 'AutoMLCandidateStep' => [ 'base' => '

Information about the steps for a candidate and what step it is working on.

', 'refs' => [ 'CandidateSteps$member' => NULL, ], ], 'AutoMLCandidates' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobResponse$Candidates' => '

Summaries about the AutoMLCandidates.

', ], ], 'AutoMLChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.

A validation dataset must contain the same headers as the training dataset.

', 'refs' => [ 'AutoMLInputDataConfig$member' => NULL, ], ], 'AutoMLChannelType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ChannelType' => '

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.

', 'AutoMLJobChannel$ChannelType' => '

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

', ], ], 'AutoMLContainerDefinition' => [ 'base' => '

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.

', 'refs' => [ 'AutoMLContainerDefinitions$member' => NULL, ], ], 'AutoMLContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$InferenceContainers' => '

Information about the recommended inference container definitions.

', 'AutoMLInferenceContainerDefinitions$value' => '

Information about the recommended inference container definitions.

', ], ], 'AutoMLDataSource' => [ 'base' => '

The data source for the Autopilot job.

', 'refs' => [ 'AutoMLChannel$DataSource' => '

The data source for an AutoML channel.

', 'AutoMLJobChannel$DataSource' => '

The data source for an AutoML channel (Required).

', ], ], 'AutoMLDataSplitConfig' => [ 'base' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

', 'refs' => [ 'AutoMLJobConfig$DataSplitConfig' => '

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

', 'CreateAutoMLJobV2Request$DataSplitConfig' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.

', 'DescribeAutoMLJobV2Response$DataSplitConfig' => '

Returns the configuration settings of how the data are split into train and validation datasets.

', ], ], 'AutoMLFailureReason' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$FailureReason' => '

The failure reason.

', 'AutoMLJobSummary$FailureReason' => '

The failure reason of an AutoML job.

', 'AutoMLPartialFailureReason$PartialFailureMessage' => '

The message containing the reason for a partial failure of an AutoML job.

', 'DescribeAutoMLJobResponse$FailureReason' => '

Returns the failure reason for an AutoML job, when applicable.

', 'DescribeAutoMLJobV2Response$FailureReason' => '

Returns the reason for the failure of the AutoML job V2, when applicable.

', ], ], 'AutoMLInferenceContainerDefinitions' => [ 'base' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLCandidate$InferenceContainerDefinitions' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

', ], ], 'AutoMLInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$InputDataConfig' => '

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

', 'DescribeAutoMLJobResponse$InputDataConfig' => '

Returns the input data configuration for the AutoML job.

', ], ], 'AutoMLJobArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the AutoML job.

', 'AutoMLJobSummary$AutoMLJobArn' => '

The ARN of the AutoML job.

', 'CreateAutoMLJobResponse$AutoMLJobArn' => '

The unique ARN assigned to the AutoML job when it is created.

', 'CreateAutoMLJobV2Response$AutoMLJobArn' => '

The unique ARN assigned to the AutoMLJob when it is created.

', 'DescribeAutoMLJobResponse$AutoMLJobArn' => '

Returns the ARN of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobArn' => '

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

', 'DescribeProcessingJobResponse$AutoMLJobArn' => '

The ARN of an AutoML job associated with this processing job.

', 'DescribeTrainingJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of an AutoML job.

', 'DescribeTransformJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML transform job.

', 'ProcessingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

', 'TrainingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'TransformJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

', ], ], 'AutoMLJobArtifacts' => [ 'base' => '

The artifacts that are generated during an AutoML job.

', 'refs' => [ 'DescribeAutoMLJobResponse$AutoMLJobArtifacts' => '

Returns information on the job\'s artifacts found in AutoMLJobArtifacts.

', 'DescribeAutoMLJobV2Response$AutoMLJobArtifacts' => NULL, ], ], 'AutoMLJobChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLJobInputDataConfig$member' => NULL, ], ], 'AutoMLJobCompletionCriteria' => [ 'base' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'refs' => [ 'AutoMLJobConfig$CompletionCriteria' => '

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

', 'AutoMLResolvedAttributes$CompletionCriteria' => NULL, 'ImageClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'ResolvedAttributes$CompletionCriteria' => NULL, 'TabularJobConfig$CompletionCriteria' => NULL, 'TextClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'TextGenerationJobConfig$CompletionCriteria' => '

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

', 'TimeSeriesForecastingJobConfig$CompletionCriteria' => NULL, ], ], 'AutoMLJobConfig' => [ 'base' => '

A collection of settings used for an AutoML job.

', 'refs' => [ 'CreateAutoMLJobRequest$AutoMLJobConfig' => '

A collection of settings used to configure an AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobConfig' => '

Returns the configuration for the AutoML job.

', ], ], 'AutoMLJobInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLJobInputDataConfig' => '

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:

', 'DescribeAutoMLJobV2Response$AutoMLJobInputDataConfig' => '

Returns an array of channel objects describing the input data and their location.

', ], ], 'AutoMLJobName' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobName' => '

The name of the AutoML job you are requesting.

', 'CreateAutoMLJobRequest$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'CreateAutoMLJobV2Request$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'DescribeAutoMLJobRequest$AutoMLJobName' => '

Requests information about an AutoML job using its unique name.

', 'DescribeAutoMLJobResponse$AutoMLJobName' => '

Returns the name of the AutoML job.

', 'DescribeAutoMLJobV2Request$AutoMLJobName' => '

Requests information about an AutoML job V2 using its unique name.

', 'DescribeAutoMLJobV2Response$AutoMLJobName' => '

Returns the name of the AutoML job V2.

', 'ListCandidatesForAutoMLJobRequest$AutoMLJobName' => '

List the candidates created for the job by providing the job\'s name.

', 'StopAutoMLJobRequest$AutoMLJobName' => '

The name of the object you are requesting.

', ], ], 'AutoMLJobObjective' => [ 'base' => '

Specifies a metric to minimize or maximize as the objective of an AutoML job.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLJobObjective' => NULL, 'CreateAutoMLJobRequest$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

', 'CreateAutoMLJobV2Request$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.

', 'DescribeAutoMLJobResponse$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'DescribeAutoMLJobV2Response$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'ResolvedAttributes$AutoMLJobObjective' => NULL, ], ], 'AutoMLJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Type' => '

The type of metric with the best result.

', ], ], 'AutoMLJobSecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobSecondaryStatus' => '

The secondary status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job V2.

', ], ], 'AutoMLJobStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobStatus' => '

The status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobStatus' => '

Returns the status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobStatus' => '

Returns the status of the AutoML job V2.

', 'ListAutoMLJobsRequest$StatusEquals' => '

Request a list of jobs, using a filter for status.

', ], ], 'AutoMLJobStepMetadata' => [ 'base' => '

Metadata for an AutoML job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$AutoMLJob' => '

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

', ], ], 'AutoMLJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsResponse$AutoMLJobSummaries' => '

Returns a summary list of jobs.

', ], ], 'AutoMLJobSummary' => [ 'base' => '

Provides a summary about an AutoML job.

', 'refs' => [ 'AutoMLJobSummaries$member' => NULL, ], ], 'AutoMLMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$MaxResults' => '

Request a list of jobs up to a specified limit.

', ], ], 'AutoMLMaxResultsForTrials' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$MaxResults' => '

List the job\'s candidates up to a specified limit.

', ], ], 'AutoMLMetricEnum' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobObjective$MetricName' => '

The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model\'s parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.

The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.

', 'FinalAutoMLJobObjectiveMetric$MetricName' => '

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

', 'FinalAutoMLJobObjectiveMetric$StandardMetricName' => '

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

', 'MetricDatum$MetricName' => '

The name of the metric.

', ], ], 'AutoMLMetricExtendedEnum' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$StandardMetricName' => '

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

', ], ], 'AutoMLMode' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', 'TabularJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', ], ], 'AutoMLNameContains' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$NameContains' => '

Request a list of jobs, using a search filter for name.

', ], ], 'AutoMLOutputDataConfig' => [ 'base' => '

The output data configuration.

', 'refs' => [ 'CreateAutoMLJobRequest$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

', 'CreateAutoMLJobV2Request$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

', 'DescribeAutoMLJobResponse$OutputDataConfig' => '

Returns the job\'s output data config.

', 'DescribeAutoMLJobV2Response$OutputDataConfig' => '

Returns the job\'s output data config.

', ], ], 'AutoMLPartialFailureReason' => [ 'base' => '

The reason for a partial failure of an AutoML job.

', 'refs' => [ 'AutoMLPartialFailureReasons$member' => NULL, ], ], 'AutoMLPartialFailureReasons' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$PartialFailureReasons' => '

The list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobResponse$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobV2Response$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job V2.

', ], ], 'AutoMLProblemTypeConfig' => [ 'base' => '

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

', 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLProblemTypeConfig' => '

Defines the configuration settings of one of the supported problem types.

', 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig' => '

Returns the configuration settings of the problem type set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeConfigName' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName' => '

Returns the name of the problem type configuration set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'base' => '

Stores resolved attributes specific to the problem type of an AutoML job V2.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes' => '

Defines the resolved attributes specific to a problem type.

', ], ], 'AutoMLProcessingUnit' => [ 'base' => NULL, 'refs' => [ 'AutoMLInferenceContainerDefinitions$key' => '

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.

', ], ], 'AutoMLResolvedAttributes' => [ 'base' => '

The resolved attributes used to configure an AutoML job V2.

', 'refs' => [ 'DescribeAutoMLJobV2Response$ResolvedAttributes' => '

Returns the resolved attributes used by the AutoML job V2.

', ], ], 'AutoMLS3DataSource' => [ 'base' => '

Describes the Amazon S3 data source.

', 'refs' => [ 'AutoMLDataSource$S3DataSource' => '

The Amazon S3 location of the input data.

', ], ], 'AutoMLS3DataType' => [ 'base' => NULL, 'refs' => [ 'AutoMLS3DataSource$S3DataType' => '

The data type.

', ], ], 'AutoMLSecurityConfig' => [ 'base' => '

Security options.

', 'refs' => [ 'AutoMLJobConfig$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'CreateAutoMLJobV2Request$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'DescribeAutoMLJobV2Response$SecurityConfig' => '

Returns the security configuration for traffic encryption or Amazon VPC settings.

', ], ], 'AutoMLSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortBy' => '

The parameter by which to sort the results. The default is Name.

', ], ], 'AutoMLSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortOrder' => '

The sort order for the results. The default is Descending.

', 'ListCandidatesForAutoMLJobRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', ], ], 'AutoParameter' => [ 'base' => '

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

', 'refs' => [ 'AutoParameters$member' => NULL, ], ], 'AutoParameters' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$AutoParameters' => '

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

', ], ], 'AutoRollbackConfig' => [ 'base' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', 'refs' => [ 'DeploymentConfig$AutoRollbackConfiguration' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', ], ], 'Autotune' => [ 'base' => '

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$Autotune' => '

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:

', 'DescribeHyperParameterTuningJobResponse$Autotune' => '

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

', ], ], 'AutotuneMode' => [ 'base' => NULL, 'refs' => [ 'Autotune$Mode' => '

Set Mode to Enabled if you want to use Autotune.

', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'base' => NULL, 'refs' => [ 'HumanLoopRequestSource$AwsManagedHumanLoopRequestSource' => '

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

', ], ], 'BacktestResultsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$BacktestResults' => '

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

', ], ], 'BaseModelName' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$BaseModelName' => '

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

', 'TextGenerationResolvedAttributes$BaseModelName' => '

The name of the base model to fine-tune.

', ], ], 'BatchDataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data for batch transform jobs.

', 'refs' => [ 'CreateTransformJobRequest$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'DescribeTransformJobResponse$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'TransformJob$DataCaptureConfig' => NULL, ], ], 'BatchDescribeModelPackageError' => [ 'base' => '

The error code and error description associated with the resource.

', 'refs' => [ 'BatchDescribeModelPackageErrorMap$value' => NULL, ], ], 'BatchDescribeModelPackageErrorMap' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap' => '

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

', ], ], 'BatchDescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageSummary' => [ 'base' => '

Provides summary information about the model package.

', 'refs' => [ 'ModelPackageSummaries$value' => NULL, ], ], 'BatchStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

', 'DescribeTransformJobResponse$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

', 'TransformJob$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

', 'TransformJobDefinition$BatchStrategy' => '

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

', ], ], 'BatchTransformInput' => [ 'base' => '

Input object for the batch transform job.

', 'refs' => [ 'DataQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelBiasJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelDashboardMonitoringSchedule$BatchTransformInput' => NULL, 'ModelExplainabilityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'MonitoringInput$BatchTransformInput' => '

Input object for the batch transform job.

', ], ], 'BestObjectiveNotImproving' => [ 'base' => '

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

', 'refs' => [ 'TuningJobCompletionCriteria$BestObjectiveNotImproving' => '

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

', ], ], 'Bias' => [ 'base' => '

Contains bias metrics for a model.

', 'refs' => [ 'ModelMetrics$Bias' => '

Metrics that measure bias in a model.

', ], ], 'BillableTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$BillableTimeInSeconds' => '

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

', 'TrainingJob$BillableTimeInSeconds' => '

The billable time in seconds.

', ], ], 'BlockedReason' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreStatus$BlockedReason' => '

The justification for why the OfflineStoreStatus is Blocked (if applicable).

', ], ], 'BlueGreenUpdatePolicy' => [ 'base' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', 'refs' => [ 'DeploymentConfig$BlueGreenUpdatePolicy' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$EnableSageMakerMetricsTimeSeries' => '

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren\'t generated except in the following cases:

', 'AutoMLSecurityConfig$EnableInterContainerTrafficEncryption' => '

Whether to use traffic encryption between the container layers.

', 'BatchDataCaptureConfig$GenerateInferenceId' => '

Flag that indicates whether to append inference id to the output.

', 'ChannelSpecification$IsRequired' => '

Indicates whether the channel is required by the algorithm.

', 'ClarifyCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'ClarifyCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

', 'CreateEndpointConfigInput$EnableNetworkIsolation' => '

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'CreateModelInput$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'CreateTrainingJobRequest$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'CreateTrainingJobRequest$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

', 'CreateTrainingJobRequest$EnableManagedSpotTraining' => '

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

', 'DescribeEndpointConfigOutput$EnableNetworkIsolation' => '

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'DescribeModelOutput$EnableNetworkIsolation' => '

If True, no inbound or outbound network calls can be made to or from the model container.

', 'DescribeTrainingJobResponse$EnableNetworkIsolation' => '

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'DescribeTrainingJobResponse$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

', 'DescribeTrainingJobResponse$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'HyperParameterSpecification$IsTunable' => '

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

', 'HyperParameterSpecification$IsRequired' => '

Indicates whether this hyperparameter is required.

', 'HyperParameterTrainingJobDefinition$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'HyperParameterTrainingJobDefinition$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'ListStageDevicesRequest$ExcludeDevicesDeployedInOtherStage' => '

Toggle for excluding devices deployed in other stages.

', 'Model$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'ModelDashboardIndicatorAction$Enabled' => '

Indicates whether the alert action is turned on.

', 'MonitoringCsvDatasetFormat$Header' => '

Indicates if the CSV data has a header.

', 'MonitoringJsonDatasetFormat$Line' => '

Indicates if the file should be read as a JSON object per line.

', 'MonitoringNetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

', 'MonitoringNetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

', 'NetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

', 'NetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

', 'OfflineStoreConfig$DisableGlueTableCreation' => '

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena\'s naming recommendations.

The default value is False.

', 'OnlineStoreConfig$EnableOnlineStore' => '

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

', 'QualityCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'QualityCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

', 'QueryLineageRequest$IncludeEdges' => '

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

', 'TrainingJob$EnableNetworkIsolation' => '

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can\'t communicate beyond the VPC they run in.

', 'TrainingJob$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'TrainingJob$EnableManagedSpotTraining' => '

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

', 'TrainingSpecification$SupportsDistributedTraining' => '

Indicates whether the algorithm supports distributed training. If set to false, buyers can\'t request more than one instance during training.

', 'UpdateEndpointInput$RetainAllVariantProperties' => '

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

', 'UpdateEndpointInput$RetainDeploymentConfig' => '

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

', ], ], 'BooleanOperator' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$Operator' => '

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

', ], ], 'Branch' => [ 'base' => NULL, 'refs' => [ 'GitConfig$Branch' => '

The default branch for the Git repository.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$Bucket' => '

Name of the S3 bucket.

', ], ], 'CacheHitResult' => [ 'base' => '

Details on the cache hit of a pipeline execution step.

', 'refs' => [ 'PipelineExecutionStep$CacheHitResult' => '

If this pipeline execution step was cached, details on the cache hit.

', ], ], 'CallbackStepMetadata' => [ 'base' => '

Metadata about a callback step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Callback' => '

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepFailureRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepSuccessRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', ], ], 'CandidateArtifactLocations' => [ 'base' => '

The location of artifacts for an AutoML candidate job.

', 'refs' => [ 'CandidateProperties$CandidateArtifactLocations' => '

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

', ], ], 'CandidateDefinitionNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$CandidateDefinitionNotebookLocation' => '

The URL of the notebook location.

', ], ], 'CandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how model candidates are generated using an AutoML job V2.

', 'refs' => [ 'TabularJobConfig$CandidateGenerationConfig' => '

The configuration information of how model candidates are generated.

', ], ], 'CandidateName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateName' => '

The name of the candidate.

', 'ListCandidatesForAutoMLJobRequest$CandidateNameEquals' => '

List the candidates for the job and filter by candidate name.

', ], ], 'CandidateProperties' => [ 'base' => '

The properties of an AutoML candidate job.

', 'refs' => [ 'AutoMLCandidate$CandidateProperties' => '

The properties of an AutoML candidate job.

', ], ], 'CandidateSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$SortBy' => '

The parameter by which to sort the results. The default is Descending.

', ], ], 'CandidateStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateStatus' => '

The candidate\'s status.

', 'ListCandidatesForAutoMLJobRequest$StatusEquals' => '

List the candidates for the job and filter by status.

', ], ], 'CandidateStepArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepArn' => '

The ARN for the candidate\'s step.

', ], ], 'CandidateStepName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepName' => '

The name for the candidate\'s step.

', ], ], 'CandidateStepType' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepType' => '

Whether the candidate is at the transform, training, or processing step.

', ], ], 'CandidateSteps' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateSteps' => '

Information about the candidate\'s steps.

', ], ], 'CanvasAppSettings' => [ 'base' => '

The SageMaker Canvas application settings.

', 'refs' => [ 'UserSettings$CanvasAppSettings' => '

The Canvas app settings.

', ], ], 'CapacitySize' => [ 'base' => '

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don\'t specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

', 'refs' => [ 'RollingUpdatePolicy$MaximumBatchSize' => '

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant\'s total instance count.

', 'RollingUpdatePolicy$RollbackMaximumBatchSize' => '

Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

', 'TrafficRoutingConfig$CanarySize' => '

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant\'s total instance count.

', 'TrafficRoutingConfig$LinearStepSize' => '

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant\'s total instance count.

', ], ], 'CapacitySizeType' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Type' => '

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.

  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

', ], ], 'CapacitySizeValue' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Value' => '

Defines the capacity size, either as a number of instances or a capacity percentage.

', ], ], 'CapacityUnit' => [ 'base' => NULL, 'refs' => [ 'ThroughputConfig$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfig$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigDescription$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigDescription$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigUpdate$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

', 'ThroughputConfigUpdate$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

', ], ], 'CaptureContentTypeHeader' => [ 'base' => '

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.

', 'refs' => [ 'DataCaptureConfig$CaptureContentTypeHeader' => '

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

', 'InferenceExperimentDataStorageConfig$ContentType' => NULL, ], ], 'CaptureMode' => [ 'base' => NULL, 'refs' => [ 'CaptureOption$CaptureMode' => '

Specify the boundary of data to capture.

', ], ], 'CaptureOption' => [ 'base' => '

Specifies data Model Monitor will capture.

', 'refs' => [ 'CaptureOptionList$member' => NULL, ], ], 'CaptureOptionList' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$CaptureOptions' => '

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

', ], ], 'CaptureStatus' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfigSummary$CaptureStatus' => '

Whether data capture is currently functional.

', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Catalog' => '

The name of the Glue table catalog.

', ], ], 'CategoricalParameter' => [ 'base' => '

Environment parameters you want to benchmark your load test against.

', 'refs' => [ 'CategoricalParameters$member' => NULL, ], ], 'CategoricalParameterRange' => [ 'base' => '

A list of categorical hyperparameters to tune.

', 'refs' => [ 'CategoricalParameterRanges$member' => NULL, ], ], 'CategoricalParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a categorical hyperparameter.

', 'refs' => [ 'ParameterRange$CategoricalParameterRangeSpecification' => '

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

', ], ], 'CategoricalParameterRangeValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameter$Value' => '

The list of values you can pass.

', ], ], 'CategoricalParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$CategoricalParameterRanges' => '

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

', ], ], 'CategoricalParameters' => [ 'base' => NULL, 'refs' => [ 'EnvironmentParameterRanges$CategoricalParameterRanges' => '

Specified a list of parameters for each category.

', ], ], 'Cents' => [ 'base' => NULL, 'refs' => [ 'USD$Cents' => '

The fractional portion, in cents, of the amount.

', ], ], 'CertifyForMarketplace' => [ 'base' => NULL, 'refs' => [ 'CreateAlgorithmInput$CertifyForMarketplace' => '

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

', 'CreateModelPackageInput$CertifyForMarketplace' => '

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

', 'DescribeAlgorithmOutput$CertifyForMarketplace' => '

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

', 'DescribeModelPackageOutput$CertifyForMarketplace' => '

Whether the model package is certified for listing on Amazon Web Services Marketplace.

', 'ModelPackage$CertifyForMarketplace' => '

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

', ], ], 'Channel' => [ 'base' => '

A channel is a named input source that training algorithms can consume.

', 'refs' => [ 'InputDataConfig$member' => NULL, ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$ChannelName' => '

The name of the channel.

', 'ChannelSpecification$Name' => '

The name of the channel.

', ], ], 'ChannelSpecification' => [ 'base' => '

Defines a named input source, called a channel, to be used by an algorithm.

', 'refs' => [ 'ChannelSpecifications$member' => NULL, ], ], 'ChannelSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$TrainingChannels' => '

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

', ], ], 'CheckpointConfig' => [ 'base' => '

Contains information about the output location for managed spot training checkpoint data.

', 'refs' => [ 'CreateTrainingJobRequest$CheckpointConfig' => '

Contains information about the output location for managed spot training checkpoint data.

', 'DescribeTrainingJobResponse$CheckpointConfig' => NULL, 'HyperParameterTrainingJobDefinition$CheckpointConfig' => NULL, 'TrainingJob$CheckpointConfig' => NULL, ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'Cidrs$member' => NULL, ], ], 'Cidrs' => [ 'base' => NULL, 'refs' => [ 'SourceIpConfig$Cidrs' => '

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

', ], ], 'ClarifyCheckStepMetadata' => [ 'base' => '

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$ClarifyCheck' => '

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'ClarifyContentTemplate' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ContentTemplate' => '

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string \'{"myfeatures":$features}\' will format a list of features [1,2,3] into the record string \'{"myfeatures":[1,2,3]}\'. Required only when the model container input is in JSON Lines format.

', ], ], 'ClarifyEnableExplanations' => [ 'base' => NULL, 'refs' => [ 'ClarifyExplainerConfig$EnableExplanations' => '

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

', ], ], 'ClarifyExplainerConfig' => [ 'base' => '

The configuration parameters for the SageMaker Clarify explainer.

', 'refs' => [ 'ExplainerConfig$ClarifyExplainerConfig' => '

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

', ], ], 'ClarifyFeatureHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureHeaders' => '

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeatureType' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureTypes$member' => NULL, ], ], 'ClarifyFeatureTypes' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureTypes' => '

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one \'text\' string (for example, [\'text\']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeaturesAttribute' => '

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression \'myfeatures\', it extracts a list of features [1,2,3] from request data \'{"myfeatures":[1,2,3]}\'.

', ], ], 'ClarifyHeader' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureHeaders$member' => NULL, 'ClarifyLabelHeaders$member' => NULL, ], ], 'ClarifyInferenceConfig' => [ 'base' => '

The inference configuration parameter for the model container.

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

The inference configuration parameter for the model container.

', ], ], 'ClarifyLabelAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelAttribute' => '

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is \'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}\', then set LabelAttribute to \'labels\' to extract the list of label headers ["cat","dog","fish"]

', ], ], 'ClarifyLabelHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelHeaders' => '

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

', ], ], 'ClarifyLabelIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelIndex' => '

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set LabelIndex to 0 to select the label headers [\'cat\',\'dog\',\'fish\'].

', ], ], 'ClarifyMaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxPayloadInMB' => '

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

', ], ], 'ClarifyMaxRecordCount' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxRecordCount' => '

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container\'s capacity at runtime.

', ], ], 'ClarifyMimeType' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$MimeType' => '

The MIME type of the baseline data. Choose from \'text/csv\' or \'application/jsonlines\'. Defaults to \'text/csv\'.

', ], ], 'ClarifyProbabilityAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityAttribute' => '

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is \'{"predicted_label":1,"probability":0.6}\', then set ProbabilityAttribute to \'probability\'.

', ], ], 'ClarifyProbabilityIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityIndex' => '

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: \'1,0.6\', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

', ], ], 'ClarifyShapBaseline' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$ShapBaseline' => '

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

', ], ], 'ClarifyShapBaselineConfig' => [ 'base' => '

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

', 'refs' => [ 'ClarifyShapConfig$ShapBaselineConfig' => '

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

', ], ], 'ClarifyShapConfig' => [ 'base' => '

The configuration for SHAP analysis using SageMaker Clarify Explainer.

', 'refs' => [ 'ClarifyExplainerConfig$ShapConfig' => '

The configuration for SHAP analysis.

', ], ], 'ClarifyShapNumberOfSamples' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$NumberOfSamples' => '

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

', ], ], 'ClarifyShapSeed' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$Seed' => '

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

', ], ], 'ClarifyShapUseLogit' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$UseLogit' => '

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

', ], ], 'ClarifyTextConfig' => [ 'base' => '

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

', 'refs' => [ 'ClarifyShapConfig$TextConfig' => '

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

', ], ], 'ClarifyTextGranularity' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Granularity' => '

The unit of granularity for the analysis of text features. For example, if the unit is \'token\', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

', ], ], 'ClarifyTextLanguage' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Language' => '

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code \'xx\'.

', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$ClientId' => '

The client ID for your Amazon Cognito user pool.

', 'CognitoMemberDefinition$ClientId' => '

An identifier for an application client. You must create the app client ID using Amazon Cognito.

', 'OidcConfig$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', 'OidcConfigForResponse$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$ClientSecret' => '

The OIDC IdP client secret used to configure your private workforce.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ClientToken' => '

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

', 'CreateModelPackageInput$ClientToken' => '

A unique token that guarantees that the call to this API is idempotent.

', ], ], 'ClusterArn' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'CreateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the cluster.

', 'DeleteClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'UpdateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

', 'UpdateClusterSoftwareResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

', ], ], 'ClusterInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$TargetCount' => '

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceCount' => '

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupDetails' => [ 'base' => '

Details of an instance group in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetailsList$member' => NULL, ], ], 'ClusterInstanceGroupDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterResponse$InstanceGroups' => '

The instance groups of the SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceGroupName' => '

The name of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceGroupName' => '

Specifies the name of the instance group.

', 'ClusterNodeDetails$InstanceGroupName' => '

The instance group name in which the instance is.

', 'ClusterNodeSummary$InstanceGroupName' => '

The name of the instance group in which the instance is.

', 'ListClusterNodesRequest$InstanceGroupNameContains' => '

A filter that returns the instance groups whose name contain a specified string.

', ], ], 'ClusterInstanceGroupSpecification' => [ 'base' => '

The specifications of an instance group that you need to define.

', 'refs' => [ 'ClusterInstanceGroupSpecifications$member' => NULL, ], ], 'ClusterInstanceGroupSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$InstanceGroups' => '

The instance groups to be created in the SageMaker HyperPod cluster.

', 'UpdateClusterRequest$InstanceGroups' => '

Specify the instance groups to update.

', ], ], 'ClusterInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceStatusDetails$Status' => '

The status of an instance in a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceStatusDetails' => [ 'base' => '

Details of an instance in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeDetails$InstanceStatus' => '

The status of the instance.

', 'ClusterNodeSummary$InstanceStatus' => '

The status of the instance.

', ], ], 'ClusterInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceType' => '

The instance type of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceType' => '

Specifies the instance type of the instance group.

', 'ClusterNodeDetails$InstanceType' => '

The type of the instance.

', 'ClusterNodeSummary$InstanceType' => '

The type of the instance.

', ], ], 'ClusterLifeCycleConfig' => [ 'base' => '

The lifecycle configuration for a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetails$LifeCycleConfig' => '

Details of LifeCycle configuration for the instance group.

', 'ClusterInstanceGroupSpecification$LifeCycleConfig' => '

Specifies the LifeCycle configuration for the instance group.

', 'ClusterNodeDetails$LifeCycleConfig' => '

The LifeCycle configuration applied to the instance.

', ], ], 'ClusterLifeCycleConfigFileName' => [ 'base' => NULL, 'refs' => [ 'ClusterLifeCycleConfig$OnCreate' => '

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.

', ], ], 'ClusterName' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', 'CreateClusterRequest$ClusterName' => '

The name for the new SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', ], ], 'ClusterNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterNodeRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

', 'DescribeClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'ListClusterNodesRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

', 'UpdateClusterRequest$ClusterName' => '

Specify the name of the SageMaker HyperPod cluster you want to update.

', 'UpdateClusterSoftwareRequest$ClusterName' => '

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

', ], ], 'ClusterNodeDetails' => [ 'base' => '

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

', 'refs' => [ 'DescribeClusterNodeResponse$NodeDetails' => '

The details of the instance.

', ], ], 'ClusterNodeId' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterNodeRequest$NodeId' => '

The ID of the instance.

', ], ], 'ClusterNodeSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesResponse$ClusterNodeSummaries' => '

The summaries of listed instances in a SageMaker HyperPod cluster

', ], ], 'ClusterNodeSummary' => [ 'base' => '

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeSummaries$member' => NULL, ], ], 'ClusterNonNegativeInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$CurrentCount' => '

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterSortBy' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', 'ListClustersRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', ], ], 'ClusterStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', ], ], 'ClusterSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClustersResponse$ClusterSummaries' => '

The summaries of listed SageMaker HyperPod clusters.

', ], ], 'ClusterSummary' => [ 'base' => '

Lists a summary of the properties of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterSummaries$member' => NULL, ], ], 'ClusterThreadsPerCore' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$ThreadsPerCore' => '

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterInstanceGroupSpecification$ThreadsPerCore' => '

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn\'t support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterNodeDetails$ThreadsPerCore' => '

The number of threads per CPU core you specified under CreateCluster.

', ], ], 'CodeEditorAppImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. The FileSystemConfig object is not supported.

', 'refs' => [ 'AppImageConfigDetails$CodeEditorAppImageConfig' => '

The configuration for the file system and the runtime, such as the environment variables and entry point.

', 'CreateAppImageConfigRequest$CodeEditorAppImageConfig' => '

The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor.

', 'DescribeAppImageConfigResponse$CodeEditorAppImageConfig' => '

The configuration of the Code Editor app.

', 'UpdateAppImageConfigRequest$CodeEditorAppImageConfig' => '

The Code Editor app running on the image.

', ], ], 'CodeEditorAppSettings' => [ 'base' => '

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

', 'refs' => [ 'UserSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'CodeRepositories' => [ 'base' => NULL, 'refs' => [ 'JupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', 'JupyterServerAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'SpaceJupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', ], ], 'CodeRepository' => [ 'base' => '

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'refs' => [ 'CodeRepositories$member' => NULL, ], ], 'CodeRepositoryArn' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'CreateCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the new repository.

', 'DescribeCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'UpdateCodeRepositoryOutput$CodeRepositoryArn' => '

The ARN of the Git repository.

', ], ], 'CodeRepositoryContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$DefaultCodeRepositoryContains' => '

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

', ], ], 'CodeRepositoryNameContains' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$NameContains' => '

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

', ], ], 'CodeRepositoryNameOrUrl' => [ 'base' => NULL, 'refs' => [ 'AdditionalCodeRepositoryNamesOrUrls$member' => NULL, 'CreateNotebookInstanceInput$DefaultCodeRepository' => '

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'ListNotebookInstancesInput$AdditionalCodeRepositoryEquals' => '

A filter that returns only notebook instances with associated with the specified git repository.

', 'NotebookInstanceSummary$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$DefaultCodeRepository' => '

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'CodeRepositorySortBy' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'CodeRepositorySortOrder' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'CodeRepositorySummary' => [ 'base' => '

Specifies summary information about a Git repository.

', 'refs' => [ 'CodeRepositorySummaryList$member' => NULL, ], ], 'CodeRepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesOutput$CodeRepositorySummaryList' => '

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

  • Name

  • Amazon Resource Name (ARN)

  • Creation time

  • Last modified time

  • Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'CognitoConfig' => [ 'base' => '

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', 'refs' => [ 'CreateWorkforceRequest$CognitoConfig' => '

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

', 'Workforce$CognitoConfig' => '

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', ], ], 'CognitoMemberDefinition' => [ 'base' => '

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

', 'refs' => [ 'MemberDefinition$CognitoMemberDefinition' => '

The Amazon Cognito user group that is part of the work team.

', ], ], 'CognitoUserGroup' => [ 'base' => NULL, 'refs' => [ 'CognitoMemberDefinition$UserGroup' => '

An identifier for a user group.

', ], ], 'CognitoUserPool' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$UserPool' => '

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

', 'CognitoMemberDefinition$UserPool' => '

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

', ], ], 'CollectionConfig' => [ 'base' => '

Configuration for your collection.

', 'refs' => [ 'FeatureDefinition$CollectionConfig' => '

Configuration for your collection.

', ], ], 'CollectionConfiguration' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger output tensor collections.

', 'refs' => [ 'CollectionConfigurations$member' => NULL, ], ], 'CollectionConfigurations' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$CollectionConfigurations' => '

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'CollectionName' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionName' => '

The name of the tensor collection. The name must be unique relative to other rule configuration names.

', ], ], 'CollectionParameters' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionParameters' => '

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

', ], ], 'CollectionType' => [ 'base' => NULL, 'refs' => [ 'FeatureDefinition$CollectionType' => '

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

', ], ], 'CompilationJobArn' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', 'CreateCompilationJobResponse$CompilationJobArn' => '

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

', 'DescribeCompilationJobResponse$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', ], ], 'CompilationJobStatus' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobStatus' => '

The status of the model compilation job.

', 'DescribeCompilationJobResponse$CompilationJobStatus' => '

The status of the model compilation job.

', 'ListCompilationJobsRequest$StatusEquals' => '

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

', ], ], 'CompilationJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsResponse$CompilationJobSummaries' => '

An array of CompilationJobSummary objects, each describing a model compilation job.

', ], ], 'CompilationJobSummary' => [ 'base' => '

A summary of a model compilation job.

', 'refs' => [ 'CompilationJobSummaries$member' => NULL, ], ], 'CompilerOptions' => [ 'base' => NULL, 'refs' => [ 'OutputConfig$CompilerOptions' => '

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model\'s input. "float32" is used if "DTYPE" is not specified. Options for data type are:

    • float32: Use either "float" or "float32".

    • int64: Use either "int64" or "long".

    For example, {"dtype" : "float32"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {\'mcpu\': \'skylake-avx512\'}

    • mattr: CPU flags. For example, {\'mattr\': [\'+neon\', \'+vfpv4\']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {\'mattr\': [\'+neon\']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.

    • trt-ver: Specifies the TensorRT versions in x.y.z. format.

    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {\'gpu-code\': \'sm_72\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.1\'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {\'ANDROID_PLATFORM\': 28}.

    • mattr: Add {\'mattr\': [\'+neon\']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\\"--verbose 1 --num-neuroncores 2 -O2\\"".

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

  • CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by newlines.

  • EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:

    • precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".

    • signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow\'s default signature def key.

    • output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

    For example: {"precision_mode": "FP32", "output_names": ["output:0"]}

', ], ], 'CompleteOnConvergence' => [ 'base' => NULL, 'refs' => [ 'ConvergenceDetected$CompleteOnConvergence' => '

A flag to stop a tuning job once AMT has detected that the job has converged.

', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$CompressionType' => '

The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.

', 'AutoMLChannel$CompressionType' => '

You can use Gzip or None. The default value is None.

', 'AutoMLJobChannel$CompressionType' => '

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

', 'Channel$CompressionType' => '

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

', 'CompressionTypes$member' => NULL, 'TransformInput$CompressionType' => '

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

', ], ], 'CompressionTypes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedCompressionTypes' => '

The allowed compression types, if data compression is used.

', ], ], 'ConditionOutcome' => [ 'base' => NULL, 'refs' => [ 'ConditionStepMetadata$Outcome' => '

The outcome of the Condition step evaluation.

', ], ], 'ConditionStepMetadata' => [ 'base' => '

Metadata for a Condition step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Condition' => '

The outcome of the condition evaluation that was run by this step execution.

', ], ], 'ConfigKey' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$key' => NULL, 'HookParameters$key' => NULL, 'ProfilingParameters$key' => NULL, 'RuleParameters$key' => NULL, ], ], 'ConfigValue' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$value' => NULL, 'HookParameters$value' => NULL, 'ProfilingParameters$value' => NULL, 'RuleParameters$value' => NULL, ], ], 'ConflictException' => [ 'base' => '

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

', 'refs' => [], ], 'ContainerArgument' => [ 'base' => NULL, 'refs' => [ 'ContainerArguments$member' => NULL, 'MonitoringContainerArguments$member' => NULL, ], ], 'ContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerArguments' => '

The arguments for a container used to run a processing job.

', ], ], 'ContainerConfig' => [ 'base' => '

The configuration used to run the application image container.

', 'refs' => [ 'CodeEditorAppImageConfig$ContainerConfig' => NULL, 'JupyterLabAppImageConfig$ContainerConfig' => NULL, ], ], 'ContainerDefinition' => [ 'base' => '

Describes the container, as part of model definition.

', 'refs' => [ 'ContainerDefinitionList$member' => NULL, 'CreateModelInput$PrimaryContainer' => '

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

', 'DescribeModelOutput$PrimaryContainer' => '

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

', 'Model$PrimaryContainer' => NULL, ], ], 'ContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$Containers' => '

Specifies the containers in the inference pipeline.

', 'DescribeModelOutput$Containers' => '

The containers in the inference pipeline.

', 'Model$Containers' => '

The containers in the inference pipeline.

', ], ], 'ContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a processing job.

', 'DataQualityAppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a monitoring job.

', 'ModelQualityAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container that the monitoring job runs.

', 'MonitoringAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container used to run the monitoring job.

', ], ], 'ContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'ContainerEntrypoint$member' => NULL, ], ], 'ContainerHostname' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ContainerHostname' => '

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don\'t specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

', 'ModelPackageContainerDefinition$ContainerHostname' => '

The DNS host name for the Docker container.

', ], ], 'ContainerImage' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Image' => '

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', 'DeployedImage$SpecifiedImage' => '

The image path you specified when you created the model.

', 'DeployedImage$ResolvedImage' => '

The specific digest path of the image hosted in this ProductionVariant.

', 'InferenceComponentContainerSpecification$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

', 'ModelPackageContainerDefinition$Image' => '

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'TrainingSpecification$TrainingImage' => '

The Amazon ECR registry path of the Docker image that contains the training algorithm.

', ], ], 'ContainerMode' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$Mode' => '

Whether the container hosts a single model or multiple models.

', ], ], 'ContentClassifier' => [ 'base' => NULL, 'refs' => [ 'ContentClassifiers$member' => NULL, ], ], 'ContentClassifiers' => [ 'base' => NULL, 'refs' => [ 'LabelingJobDataAttributes$ContentClassifiers' => '

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

', ], ], 'ContentColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$ContentColumn' => '

The name of the column used to provide the sentences to be classified. It should not be the same as the target column.

', ], ], 'ContentDigest' => [ 'base' => NULL, 'refs' => [ 'FileSource$ContentDigest' => '

The digest of the file source.

', 'MetricsSource$ContentDigest' => '

The hash key used for the metrics source.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ContentType' => '

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'AutoMLJobChannel$ContentType' => '

The content type of the data from the input source. The following are the allowed content types for different problems:

  • For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

  • For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'Channel$ContentType' => '

The MIME type of the data.

', 'ContentTypes$member' => NULL, 'FileSource$ContentType' => '

The type of content stored in the file source.

', 'MetricsSource$ContentType' => '

The metric source content type.

', 'TransformInput$ContentType' => '

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

', ], ], 'ContentTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedContentTypes' => '

The supported MIME types for the input data.

', 'ChannelSpecification$SupportedContentTypes' => '

The supported MIME types for the data.

', 'InferenceSpecification$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'ContextArn' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'CreateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DeleteContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DescribeContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'UpdateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', ], ], 'ContextName' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextName' => '

The name of the context.

', 'CreateContextRequest$ContextName' => '

The name of the context. Must be unique to your account in an Amazon Web Services Region.

', 'DeleteContextRequest$ContextName' => '

The name of the context to delete.

', 'DescribeContextResponse$ContextName' => '

The name of the context.

', 'UpdateContextRequest$ContextName' => '

The name of the context to update.

', ], ], 'ContextNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeContextRequest$ContextName' => '

The name of the context to describe.

', ], ], 'ContextSource' => [ 'base' => '

A structure describing the source of a context.

', 'refs' => [ 'ContextSummary$Source' => '

The source of the context.

', 'CreateContextRequest$Source' => '

The source type, ID, and URI.

', 'DescribeContextResponse$Source' => '

The source of the context.

', ], ], 'ContextSummaries' => [ 'base' => NULL, 'refs' => [ 'ListContextsResponse$ContextSummaries' => '

A list of contexts and their properties.

', ], ], 'ContextSummary' => [ 'base' => '

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

', 'refs' => [ 'ContextSummaries$member' => NULL, ], ], 'ContinuousParameterRange' => [ 'base' => '

A list of continuous hyperparameters to tune.

', 'refs' => [ 'ContinuousParameterRanges$member' => NULL, ], ], 'ContinuousParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a continuous hyperparameter.

', 'refs' => [ 'ParameterRange$ContinuousParameterRangeSpecification' => '

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

', ], ], 'ContinuousParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$ContinuousParameterRanges' => '

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

', ], ], 'ConvergenceDetected' => [ 'base' => '

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

', 'refs' => [ 'TuningJobCompletionCriteria$ConvergenceDetected' => '

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

', ], ], 'CountryCode' => [ 'base' => NULL, 'refs' => [ 'HolidayConfigAttributes$CountryCode' => '

The country code for the holiday calendar.

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.

', ], ], 'CreateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$CreationTime' => '

A timestamp that shows when the algorithm was created.

', 'AppDetails$CreationTime' => '

The creation time.

', 'BatchDescribeModelPackageSummary$CreationTime' => '

The creation time of the mortgage package summary.

', 'CodeRepositorySummary$CreationTime' => '

The date and time that the Git repository was created.

', 'CompilationJobSummary$CreationTime' => '

The time when the model compilation job was created.

', 'DescribeAlgorithmOutput$CreationTime' => '

A timestamp specifying when the algorithm was created.

', 'DescribeCodeRepositoryOutput$CreationTime' => '

The date and time that the repository was created.

', 'DescribeCompilationJobResponse$CreationTime' => '

The time that the model compilation job was created.

', 'DescribeDomainResponse$CreationTime' => '

The creation time.

', 'DescribeFeatureGroupResponse$CreationTime' => '

A timestamp indicating when SageMaker created the FeatureGroup.

', 'DescribeFeatureMetadataResponse$CreationTime' => '

A timestamp indicating when the feature was created.

', 'DescribeInferenceRecommendationsJobResponse$CreationTime' => '

A timestamp that shows when the job was created.

', 'DescribeModelPackageGroupOutput$CreationTime' => '

The time that the model group was created.

', 'DescribeModelPackageOutput$CreationTime' => '

A timestamp specifying when the model package was created.

', 'DescribeNotebookInstanceLifecycleConfigOutput$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'DescribeNotebookInstanceOutput$CreationTime' => '

A timestamp. Use this parameter to return the time when the notebook instance was created

', 'DescribeSpaceResponse$CreationTime' => '

The creation time.

', 'DescribeUserProfileResponse$CreationTime' => '

The creation time.

', 'DomainDetails$CreationTime' => '

The creation time.

', 'FeatureGroup$CreationTime' => '

The time a FeatureGroup was created.

', 'FeatureMetadata$CreationTime' => '

A timestamp indicating when the feature was created.

', 'InferenceRecommendationsJob$CreationTime' => '

A timestamp that shows when the job was created.

', 'ListAlgorithmsInput$CreationTimeAfter' => '

A filter that returns only algorithms created after the specified time (timestamp).

', 'ListAlgorithmsInput$CreationTimeBefore' => '

A filter that returns only algorithms created before the specified time (timestamp).

', 'ListCodeRepositoriesInput$CreationTimeAfter' => '

A filter that returns only Git repositories that were created after the specified time.

', 'ListCodeRepositoriesInput$CreationTimeBefore' => '

A filter that returns only Git repositories that were created before the specified time.

', 'ListCompilationJobsRequest$CreationTimeAfter' => '

A filter that returns the model compilation jobs that were created after a specified time.

', 'ListCompilationJobsRequest$CreationTimeBefore' => '

A filter that returns the model compilation jobs that were created before a specified time.

', 'ListFeatureGroupsRequest$CreationTimeAfter' => '

Use this parameter to search for FeatureGroupss created after a specific date and time.

', 'ListFeatureGroupsRequest$CreationTimeBefore' => '

Use this parameter to search for FeatureGroupss created before a specific date and time.

', 'ListInferenceRecommendationsJobsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before the specified time (timestamp).

', 'ListModelPackageGroupsInput$CreationTimeAfter' => '

A filter that returns only model groups created after the specified time.

', 'ListModelPackageGroupsInput$CreationTimeBefore' => '

A filter that returns only model groups created before the specified time.

', 'ListModelPackagesInput$CreationTimeAfter' => '

A filter that returns only model packages created after the specified time (timestamp).

', 'ListModelPackagesInput$CreationTimeBefore' => '

A filter that returns only model packages created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore' => '

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter' => '

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeBefore' => '

A filter that returns only notebook instances that were created before the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeAfter' => '

A filter that returns only notebook instances that were created after the specified time (timestamp).

', 'ModelPackage$CreationTime' => '

The time that the model package was created.

', 'ModelPackageGroup$CreationTime' => '

The time that the model group was created.

', 'ModelPackageGroupSummary$CreationTime' => '

The time that the model group was created.

', 'ModelPackageSummary$CreationTime' => '

A timestamp that shows when the model package was created.

', 'NotebookInstanceLifecycleConfigSummary$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'NotebookInstanceSummary$CreationTime' => '

A timestamp that shows when the notebook instance was created.

', 'SpaceDetails$CreationTime' => '

The creation time.

', 'UserProfileDetails$CreationTime' => '

The creation time.

', ], ], 'CrossAccountFilterOption' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$CrossAccountFilterOption' => '

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

', ], ], 'CsvContentType' => [ 'base' => NULL, 'refs' => [ 'CsvContentTypes$member' => NULL, ], ], 'CsvContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$CsvContentTypes' => '

The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.

', ], ], 'CustomFileSystem' => [ 'base' => '

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystems$member' => NULL, ], ], 'CustomFileSystemConfig' => [ 'base' => '

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystemConfigs$member' => NULL, ], ], 'CustomFileSystemConfigs' => [ 'base' => NULL, 'refs' => [ 'DefaultSpaceSettings$CustomFileSystemConfigs' => '

The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'UserSettings$CustomFileSystemConfigs' => '

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomFileSystems' => [ 'base' => NULL, 'refs' => [ 'SpaceSettings$CustomFileSystems' => '

A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomImage' => [ 'base' => '

A custom SageMaker image. For more information, see Bring your own SageMaker image.

', 'refs' => [ 'CustomImages$member' => NULL, ], ], 'CustomImageContainerArguments' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerArguments' => '

The arguments for the container when you\'re running the application.

', ], ], 'CustomImageContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEntrypoint' => '

The entrypoint used to run the application in the container.

', ], ], 'CustomImageContainerEnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEnvironmentVariables' => '

The environment variables to set in the container

', ], ], 'CustomImages' => [ 'base' => NULL, 'refs' => [ 'CodeEditorAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a Code Editor app.

', 'JupyterLabAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a JupyterLab app.

', 'KernelGatewayAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a KernelGateway app.

', 'RSessionAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a RSession app.

', ], ], 'CustomPosixUserConfig' => [ 'base' => '

Details about the POSIX identity that is used for file system operations.

', 'refs' => [ 'DefaultSpaceSettings$CustomPosixUserConfig' => NULL, 'UserSettings$CustomPosixUserConfig' => '

Details about the POSIX identity that is used for file system operations.

', ], ], 'CustomerMetadataKey' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataKeyList$member' => NULL, 'CustomerMetadataMap$key' => NULL, ], ], 'CustomerMetadataKeyList' => [ 'base' => NULL, 'refs' => [ 'UpdateModelPackageInput$CustomerMetadataPropertiesToRemove' => '

The metadata properties associated with the model package versions to remove.

', ], ], 'CustomerMetadataMap' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'DescribeModelPackageOutput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'ModelPackage$CustomerMetadataProperties' => '

The metadata properties for the model package.

', 'UpdateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', ], ], 'CustomerMetadataValue' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataMap$value' => NULL, ], ], 'CustomizedMetricSpecification' => [ 'base' => '

A customized metric.

', 'refs' => [ 'MetricSpecification$Customized' => '

Information about a customized metric.

', ], ], 'DataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data.

', 'refs' => [ 'CreateEndpointConfigInput$DataCaptureConfig' => NULL, 'DescribeEndpointConfigOutput$DataCaptureConfig' => NULL, ], ], 'DataCaptureConfigSummary' => [ 'base' => '

The currently active data capture configuration used by your Endpoint.

', 'refs' => [ 'DescribeEndpointOutput$DataCaptureConfig' => NULL, 'Endpoint$DataCaptureConfig' => NULL, ], ], 'DataCatalogConfig' => [ 'base' => '

The meta data of the Glue table which serves as data catalog for the OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$DataCatalogConfig' => '

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

', ], ], 'DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$DataDistributionType' => '

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

', ], ], 'DataExplorationNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$DataExplorationNotebookLocation' => '

The URL of the notebook location.

', ], ], 'DataInputConfig' => [ 'base' => NULL, 'refs' => [ 'DerivedInformation$DerivedDataInputConfig' => '

The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don\'t need to specify the data input configuration when you create a compilation job.

', 'InputConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input":[1,1024,1024,3]}

      • If using the CLI, {\\"input\\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

      • If using the CLI, {\\"data1\\": [1,28,28,1], \\"data2\\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input_1":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\": [1,3,224,224], \\"input_2\\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"data":[1,3,1024,1024]}

      • If using the CLI, {\\"data\\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

      • If using the CLI, {\\"var1\\": [1,1,28,28], \\"var2\\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {"input0":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224]}

    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224], \\"input1\\":[1,3,224,224]}

    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

  • shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}

    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}

  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.

  • bias: If the input type is an Image, you need to provide the bias vector.

  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]

  • Image type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

  • Image type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow\'s default signature def key. For example:

    • "DataInputConfig": {"inputs": [1, 224, 224, 3]}

    • "CompilerOptions": {"signature_def_key": "serving_custom"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]}

    • "CompilerOptions": {"output_names": ["output_tensor:0"]}

', 'ModelInput$DataInputConfig' => '

The input configuration object for the model.

', ], ], 'DataProcessing' => [ 'base' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'refs' => [ 'CreateTransformJobRequest$DataProcessing' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'DescribeTransformJobResponse$DataProcessing' => NULL, 'TransformJob$DataProcessing' => NULL, ], ], 'DataQualityAppSpecification' => [ 'base' => '

Information about the container that a data quality monitoring job runs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification' => '

Specifies the container that runs the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification' => '

Information about the container that runs the data quality monitoring job.

', ], ], 'DataQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig' => '

Configures the constraints and baselines for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig' => '

The constraints and baselines for the data quality monitoring job definition.

', ], ], 'DataQualityJobInput' => [ 'base' => '

The input for the data quality monitoring job. Currently endpoints are supported for input.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobInput' => '

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityJobInput' => '

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

', ], ], 'DataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'Channel$DataSource' => '

The location of the channel data.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderOAuthSetting$DataSourceName' => '

The name of the data source that you\'re connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Database' => '

The name of the Glue table database.

', ], ], 'DatasetDefinition' => [ 'base' => '

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

', 'refs' => [ 'ProcessingInput$DatasetDefinition' => '

Configuration for a Dataset Definition input.

', ], ], 'DebugHookConfig' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'CreateTrainingJobRequest$DebugHookConfig' => NULL, 'DescribeTrainingJobResponse$DebugHookConfig' => NULL, 'TrainingJob$DebugHookConfig' => NULL, ], ], 'DebugRuleConfiguration' => [ 'base' => '

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'DebugRuleConfigurations$member' => NULL, ], ], 'DebugRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'DescribeTrainingJobResponse$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'TrainingJob$DebugRuleConfigurations' => '

Information about the debug rule configuration.

', ], ], 'DebugRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'DebugRuleEvaluationStatuses$member' => NULL, ], ], 'DebugRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$DebugRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

', 'TrainingJob$DebugRuleEvaluationStatuses' => '

Information about the evaluation status of the rules for the training job.

', ], ], 'DefaultEbsStorageSettings' => [ 'base' => '

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

', 'refs' => [ 'DefaultSpaceStorageSettings$DefaultEbsStorageSettings' => '

The default EBS storage settings for a space.

', ], ], 'DefaultGid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultGid' => '

The default POSIX group ID (GID). If not specified, defaults to 100.

', ], ], 'DefaultSpaceSettings' => [ 'base' => '

A collection of settings that apply to spaces created in the domain.

', 'refs' => [ 'CreateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'DescribeDomainResponse$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'UpdateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space within the domain.

', ], ], 'DefaultSpaceStorageSettings' => [ 'base' => '

The default storage settings for a space.

', 'refs' => [ 'DefaultSpaceSettings$SpaceStorageSettings' => NULL, 'UserSettings$SpaceStorageSettings' => '

The storage settings for a space.

', ], ], 'DefaultUid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultUid' => '

The default POSIX user ID (UID). If not specified, defaults to 1000.

', ], ], 'DeleteActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyCopyPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyCopyPath' => '

The hub content dependency copy path.

', ], ], 'DependencyOriginPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyOriginPath' => '

The hub content dependency origin path.

', ], ], 'DeployedImage' => [ 'base' => '

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

', 'refs' => [ 'DeployedImages$member' => NULL, 'InferenceComponentContainerSpecificationSummary$DeployedImage' => NULL, ], ], 'DeployedImages' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', 'ProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', ], ], 'DeploymentConfig' => [ 'base' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', 'refs' => [ 'CreateEndpointInput$DeploymentConfig' => NULL, 'DescribeEndpointOutput$LastDeploymentConfig' => '

The most recent deployment configuration for the endpoint.

', 'UpdateEndpointInput$DeploymentConfig' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', ], ], 'DeploymentRecommendation' => [ 'base' => '

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

', 'refs' => [ 'DescribeModelOutput$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', 'Model$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', ], ], 'DeploymentStage' => [ 'base' => '

Contains information about a stage in an edge deployment plan.

', 'refs' => [ 'DeploymentStages$member' => NULL, ], ], 'DeploymentStageMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', ], ], 'DeploymentStageStatusSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanResponse$Stages' => '

List of stages in the edge deployment plan.

', ], ], 'DeploymentStageStatusSummary' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummaries$member' => NULL, ], ], 'DeploymentStages' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$Stages' => '

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

', 'CreateEdgeDeploymentStageRequest$Stages' => '

List of stages to be added to the edge deployment plan.

', ], ], 'DeregisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DerivedInformation' => [ 'base' => '

Information that SageMaker Neo automatically derived about the model.

', 'refs' => [ 'DescribeCompilationJobResponse$DerivedInformation' => '

Information that SageMaker Neo automatically derived about the model.

', ], ], 'DescribeActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$Description' => '

A free-form description of a FeatureGroup.

', 'DescribeFeatureGroupResponse$Description' => '

A free form description of the feature group.

', 'FeatureGroup$Description' => '

A free form description of a FeatureGroup.

', ], ], 'DesiredWeightAndCapacity' => [ 'base' => '

Specifies weight and capacity values for a production variant.

', 'refs' => [ 'DesiredWeightAndCapacityList$member' => NULL, ], ], 'DesiredWeightAndCapacityList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities' => '

An object that provides new capacity and weight values for a variant.

', ], ], 'DestinationS3Uri' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$S3OutputPath' => '

The Amazon S3 location to upload inference responses to.

', 'AsyncInferenceOutputConfig$S3FailurePath' => '

The Amazon S3 location to upload failure inference responses to.

', 'BatchTransformInput$DataCapturedDestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'DataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location used to capture the data.

', 'DataCaptureConfigSummary$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'InferenceExperimentDataStorageConfig$Destination' => '

The Amazon S3 bucket where the inference request and response data is stored.

', 'ProductionVariantCoreDumpConfig$DestinationS3Uri' => '

The Amazon S3 bucket to send the core dump to.

', ], ], 'DetailedAlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$Status' => '

The current status.

', ], ], 'DetailedModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusItem$Status' => '

The current status.

', ], ], 'Device' => [ 'base' => '

Information of a particular device.

', 'refs' => [ 'Devices$member' => NULL, ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceArn' => '

The Amazon Resource Name (ARN) of the device.

', 'DeviceDeploymentSummary$DeviceArn' => '

The ARN of the device.

', 'DeviceSummary$DeviceArn' => '

Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceDeploymentSummary$DeviceDeploymentStatus' => '

The deployment status of the device.

', ], ], 'DeviceDeploymentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStageDevicesResponse$DeviceDeploymentSummaries' => '

List of summaries of devices allocated to the stage.

', ], ], 'DeviceDeploymentSummary' => [ 'base' => '

Contains information summarizing device details and deployment status.

', 'refs' => [ 'DeviceDeploymentSummaries$member' => NULL, ], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Description' => '

A description of the device.

', 'Device$Description' => '

Description of the device.

', 'DeviceDeploymentSummary$Description' => '

The description of the device.

', 'DeviceSummary$Description' => '

A description of the device.

', ], ], 'DeviceFleetArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$DeviceFleetArn' => '

The The Amazon Resource Name (ARN) of the fleet.

', 'DeviceFleetSummary$DeviceFleetArn' => '

Amazon Resource Name (ARN) of the device fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetArn' => '

The Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceFleetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$Description' => '

A description of the fleet.

', 'DescribeDeviceFleetResponse$Description' => '

A description of the fleet.

', 'GetDeviceFleetReportResponse$Description' => '

Description of the fleet.

', 'UpdateDeviceFleetRequest$Description' => '

Description of the fleet.

', ], ], 'DeviceFleetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsResponse$DeviceFleetSummaries' => '

Summary of the device fleet.

', ], ], 'DeviceFleetSummary' => [ 'base' => '

Summary of the device fleet.

', 'refs' => [ 'DeviceFleetSummaries$member' => NULL, ], ], 'DeviceName' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceName' => '

The name of the device.

', 'DeviceDeploymentSummary$DeviceName' => '

The name of the device.

', 'DeviceNames$member' => NULL, 'DeviceSelectionConfig$DeviceNameContains' => '

A filter to select devices with names containing this name.

', ], ], 'DeviceNames' => [ 'base' => NULL, 'refs' => [ 'DeregisterDevicesRequest$DeviceNames' => '

The unique IDs of the devices.

', 'DeviceSelectionConfig$DeviceNames' => '

List of devices chosen to deploy.

', ], ], 'DeviceSelectionConfig' => [ 'base' => '

Contains information about the configurations of selected devices.

', 'refs' => [ 'DeploymentStage$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', 'DeploymentStageStatusSummary$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', ], ], 'DeviceStats' => [ 'base' => '

Status of devices.

', 'refs' => [ 'GetDeviceFleetReportResponse$DeviceStats' => '

Status of devices.

', ], ], 'DeviceSubsetType' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$DeviceSubsetType' => '

Type of device subsets to deploy to the current stage.

', ], ], 'DeviceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$DeviceSummaries' => '

Summary of devices.

', ], ], 'DeviceSummary' => [ 'base' => '

Summary of the device.

', 'refs' => [ 'DeviceSummaries$member' => NULL, ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'RegisterDevicesRequest$Devices' => '

A list of devices to register with SageMaker Edge Manager.

', 'UpdateDevicesRequest$Devices' => '

List of devices to register with Edge Manager agent.

', ], ], 'Dimension' => [ 'base' => NULL, 'refs' => [ 'VectorConfig$Dimension' => '

The number of elements in your vector.

', ], ], 'DirectDeploySettings' => [ 'base' => '

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain\'s or user profile\'s Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain\'s or user profile\'s settings in the SageMaker console.

', 'refs' => [ 'CanvasAppSettings$DirectDeploySettings' => '

The model deployment settings for the SageMaker Canvas application.

', ], ], 'DirectInternetAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$DirectInternetAccess' => '

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

', 'DescribeNotebookInstanceOutput$DirectInternetAccess' => '

Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

', ], ], 'Direction' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$Direction' => '

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

', ], ], 'DirectoryPath' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfig$LocalPath' => '

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

', 'DebugHookConfig$LocalPath' => '

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

', 'DebugRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'FileSystemDataSource$DirectoryPath' => '

The full path to the directory to associate with the channel.

', 'ProfilerRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'TensorBoardOutputConfig$LocalPath' => '

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

', ], ], 'DisableProfiler' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$DisableProfiler' => '

Configuration to turn off Amazon SageMaker Debugger\'s system monitoring and profiling functionality. To turn it off, set to True.

', 'ProfilerConfigForUpdate$DisableProfiler' => '

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

', ], ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAdditionalCodeRepositories' => '

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateDefaultCodeRepository' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository' => '

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateLifecycleConfig' => '

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerSettings' => [ 'base' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'refs' => [ 'DomainSettings$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'DomainSettingsForUpdate$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', ], ], 'DocumentSchemaVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$DocumentSchemaVersion' => '

The document schema version for the hub content.

', 'HubContentInfo$DocumentSchemaVersion' => '

The version of the hub content document schema.

', 'ImportHubContentRequest$DocumentSchemaVersion' => '

The version of the hub content schema to import.

', 'ListHubContentVersionsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema version.

', 'ListHubContentsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema verion.

', ], ], 'Dollars' => [ 'base' => NULL, 'refs' => [ 'USD$Dollars' => '

The whole number of dollars in the amount.

', ], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the created domain.

', 'DescribeDomainResponse$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'DomainDetails$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'UpdateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the domain.

', ], ], 'DomainDetails' => [ 'base' => '

The domain\'s details.

', 'refs' => [ 'DomainList$member' => NULL, ], ], 'DomainId' => [ 'base' => NULL, 'refs' => [ 'AppDetails$DomainId' => '

The domain ID.

', 'CreateAppRequest$DomainId' => '

The domain ID.

', 'CreatePresignedDomainUrlRequest$DomainId' => '

The domain ID.

', 'CreateSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'CreateUserProfileRequest$DomainId' => '

The ID of the associated Domain.

', 'DeleteAppRequest$DomainId' => '

The domain ID.

', 'DeleteDomainRequest$DomainId' => '

The domain ID.

', 'DeleteSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'DeleteUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeAppRequest$DomainId' => '

The domain ID.

', 'DescribeAppResponse$DomainId' => '

The domain ID.

', 'DescribeDomainRequest$DomainId' => '

The domain ID.

', 'DescribeDomainResponse$DomainId' => '

The domain ID.

', 'DescribeSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'DescribeSpaceResponse$DomainId' => '

The ID of the associated domain.

', 'DescribeUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeUserProfileResponse$DomainId' => '

The ID of the domain that contains the profile.

', 'DomainDetails$DomainId' => '

The domain ID.

', 'ListAppsRequest$DomainIdEquals' => '

A parameter to search for the domain ID.

', 'ListSpacesRequest$DomainIdEquals' => '

A parameter to search for the domain ID.

', 'ListUserProfilesRequest$DomainIdEquals' => '

A parameter by which to filter the results.

', 'SpaceDetails$DomainId' => '

The ID of the associated domain.

', 'UpdateDomainRequest$DomainId' => '

The ID of the domain to be updated.

', 'UpdateSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'UpdateUserProfileRequest$DomainId' => '

The domain ID.

', 'UserProfileDetails$DomainId' => '

The domain ID.

', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResponse$Domains' => '

The list of domains.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$DomainName' => '

A name for the domain.

', 'DescribeDomainResponse$DomainName' => '

The domain name.

', 'DomainDetails$DomainName' => '

The domain name.

', ], ], 'DomainSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', 'DomainSettingsForUpdate$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', ], ], 'DomainSettings' => [ 'base' => '

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

', 'refs' => [ 'CreateDomainRequest$DomainSettings' => '

A collection of Domain settings.

', 'DescribeDomainResponse$DomainSettings' => '

A collection of Domain settings.

', ], ], 'DomainSettingsForUpdate' => [ 'base' => '

A collection of Domain configuration settings to update.

', 'refs' => [ 'UpdateDomainRequest$DomainSettingsForUpdate' => '

A collection of DomainSettings configuration values to update.

', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$Status' => '

The status.

', 'DomainDetails$Status' => '

The status.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$TargetValue' => '

The recommended target value to specify for the metric when creating a scaling policy.

', ], ], 'DoubleParameterValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameterValue$NumberValue' => '

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can\'t specify the StringValue parameter.

', ], ], 'DriftCheckBaselines' => [ 'base' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'CreateModelPackageInput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'DescribeModelPackageOutput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'ModelPackage$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckBias' => [ 'base' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Bias' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckExplainability' => [ 'base' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Explainability' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelDataQuality' => [ 'base' => '

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelDataQuality' => '

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelQuality' => [ 'base' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelQuality' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DynamicScalingConfiguration' => [ 'base' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', ], ], 'EFSFileSystem' => [ 'base' => '

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystem$EFSFileSystem' => '

A custom file system in Amazon EFS.

', ], ], 'EFSFileSystemConfig' => [ 'base' => '

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker Domain.

', 'refs' => [ 'CustomFileSystemConfig$EFSFileSystemConfig' => '

The settings for a custom Amazon EFS file system.

', ], ], 'EMRStepMetadata' => [ 'base' => '

The configurations and outcomes of an Amazon EMR step execution.

', 'refs' => [ 'PipelineExecutionStepMetadata$EMR' => '

The configurations and outcomes of an Amazon EMR step execution.

', ], ], 'EbsStorageSettings' => [ 'base' => '

A collection of EBS storage settings that apply to both private and shared spaces.

', 'refs' => [ 'SpaceStorageSettings$EbsStorageSettings' => '

A collection of EBS storage settings for a space.

', ], ], 'Edge' => [ 'base' => '

A directed edge connecting two lineage entities.

', 'refs' => [ 'Edges$member' => NULL, ], ], 'EdgeDeploymentConfig' => [ 'base' => '

Contains information about the configuration of a deployment.

', 'refs' => [ 'DeploymentStage$DeploymentConfig' => '

Configuration of the deployment details.

', 'DeploymentStageStatusSummary$DeploymentConfig' => '

Configuration of the deployment details.

', ], ], 'EdgeDeploymentModelConfig' => [ 'base' => '

Contains information about the configuration of a model in a deployment.

', 'refs' => [ 'EdgeDeploymentModelConfigs$member' => NULL, ], ], 'EdgeDeploymentModelConfigs' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$ModelConfigs' => '

List of models associated with the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$ModelConfigs' => '

List of models associated with the edge deployment plan.

', ], ], 'EdgeDeploymentPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of edge deployment plan.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', ], ], 'EdgeDeploymentPlanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries' => '

List of summaries of edge deployment plans.

', ], ], 'EdgeDeploymentPlanSummary' => [ 'base' => '

Contains information summarizing an edge deployment plan.

', 'refs' => [ 'EdgeDeploymentPlanSummaries$member' => NULL, ], ], 'EdgeDeploymentStatus' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummary$DeploymentStatus' => '

General status of the current state.

', ], ], 'EdgeModel' => [ 'base' => '

The model on the edge device.

', 'refs' => [ 'EdgeModels$member' => NULL, ], ], 'EdgeModelStat' => [ 'base' => '

Status of edge devices with this model.

', 'refs' => [ 'EdgeModelStats$member' => NULL, ], ], 'EdgeModelStats' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$ModelStats' => '

Status of model on device.

', ], ], 'EdgeModelSummaries' => [ 'base' => NULL, 'refs' => [ 'DeviceSummary$Models' => '

Models on the device.

', ], ], 'EdgeModelSummary' => [ 'base' => '

Summary of model on edge device.

', 'refs' => [ 'EdgeModelSummaries$member' => NULL, ], ], 'EdgeModels' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Models' => '

Models on the device.

', ], ], 'EdgeOutputConfig' => [ 'base' => '

The output configuration.

', 'refs' => [ 'CreateDeviceFleetRequest$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'CreateEdgePackagingJobRequest$OutputConfig' => '

Provides information about the output location for the packaged model.

', 'DescribeDeviceFleetResponse$OutputConfig' => '

The output configuration for storing sampled data.

', 'DescribeEdgePackagingJobResponse$OutputConfig' => '

The output configuration for the edge packaging job.

', 'GetDeviceFleetReportResponse$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'UpdateDeviceFleetRequest$OutputConfig' => '

Output configuration for storing sample data collected by the fleet.

', ], ], 'EdgePackagingJobArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', ], ], 'EdgePackagingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatus' => '

The current status of the packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobStatus' => '

The status of the edge packaging job.

', 'ListEdgePackagingJobsRequest$StatusEquals' => '

The job status to filter for.

', ], ], 'EdgePackagingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsResponse$EdgePackagingJobSummaries' => '

Summaries of edge packaging jobs.

', ], ], 'EdgePackagingJobSummary' => [ 'base' => '

Summary of edge packaging job.

', 'refs' => [ 'EdgePackagingJobSummaries$member' => NULL, ], ], 'EdgePresetDeploymentArtifact' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Artifact' => '

The Amazon Resource Name (ARN) of the generated deployable resource.

', ], ], 'EdgePresetDeploymentOutput' => [ 'base' => '

The output of a SageMaker Edge Manager deployable resource.

', 'refs' => [ 'DescribeEdgePackagingJobResponse$PresetDeploymentOutput' => '

The output of a SageMaker Edge Manager deployable resource.

', ], ], 'EdgePresetDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Status' => '

The status of the deployable resource.

', ], ], 'EdgePresetDeploymentType' => [ 'base' => NULL, 'refs' => [ 'EdgeOutputConfig$PresetDeploymentType' => '

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', 'EdgePresetDeploymentOutput$Type' => '

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', ], ], 'EdgeVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$Version' => '

Version of the agent.

', 'CreateEdgePackagingJobRequest$ModelVersion' => '

The version of the model.

', 'DescribeDeviceResponse$AgentVersion' => '

Edge Manager agent version.

', 'DescribeEdgePackagingJobResponse$ModelVersion' => '

The version of the model.

', 'DeviceSummary$AgentVersion' => '

Edge Manager agent version.

', 'EdgeModel$ModelVersion' => '

The model version.

', 'EdgeModelStat$ModelVersion' => '

The model version.

', 'EdgeModelSummary$ModelVersion' => '

The version model.

', 'EdgePackagingJobSummary$ModelVersion' => '

The version of the model.

', ], ], 'Edges' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Edges' => '

A list of edges that connect vertices in the response.

', ], ], 'EfsUid' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$HomeEfsFileSystemUid' => '

The ID of the space\'s profile in the Amazon EFS volume.

', 'DescribeUserProfileResponse$HomeEfsFileSystemUid' => '

The ID of the user\'s profile in the Amazon Elastic File System volume.

', ], ], 'EnableCapture' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$EnableCapture' => '

Whether data capture should be enabled or disabled (defaults to enabled).

', 'DataCaptureConfigSummary$EnableCapture' => '

Whether data capture is enabled or disabled.

', ], ], 'EnableInfraCheck' => [ 'base' => NULL, 'refs' => [ 'InfraCheckConfig$EnableInfraCheck' => '

Enables an infrastructure health check.

', ], ], 'EnableIotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', 'UpdateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', ], ], 'EnableRemoteDebug' => [ 'base' => NULL, 'refs' => [ 'RemoteDebugConfig$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', 'RemoteDebugConfigForUpdate$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', ], ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'Endpoint' => [ 'base' => '

A hosted endpoint for real-time inference.

', 'refs' => [ 'SearchRecord$Endpoint' => NULL, ], ], 'EndpointArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'Endpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'EndpointSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'InferenceComponentSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'ModelDashboardEndpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the updated endpoint.

', ], ], 'EndpointConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'EndpointConfigSummary$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', ], ], 'EndpointConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

', 'CreateEndpointInput$EndpointConfigName' => '

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

', 'DeleteEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration that you want to delete.

', 'DescribeEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigName' => '

Name of the SageMaker endpoint configuration.

', 'DescribeEndpointOutput$EndpointConfigName' => '

The name of the endpoint configuration associated with this endpoint.

', 'Endpoint$EndpointConfigName' => '

The endpoint configuration associated with the endpoint.

', 'EndpointConfigSummary$EndpointConfigName' => '

The name of the endpoint configuration.

', 'EndpointMetadata$EndpointConfigName' => '

The name of the endpoint configuration.

', 'PendingDeploymentSummary$EndpointConfigName' => '

The name of the endpoint configuration used in the deployment.

', 'UpdateEndpointInput$EndpointConfigName' => '

The name of the new endpoint configuration.

', ], ], 'EndpointConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NameContains' => '

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

', ], ], 'EndpointConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'EndpointConfigSummary' => [ 'base' => '

Provides summary information for an endpoint configuration.

', 'refs' => [ 'EndpointConfigSummaryList$member' => NULL, ], ], 'EndpointConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsOutput$EndpointConfigs' => '

An array of endpoint configurations.

', ], ], 'EndpointInfo' => [ 'base' => '

Details about a customer endpoint that was compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$EndpointInfo' => NULL, 'Endpoints$member' => NULL, ], ], 'EndpointInput' => [ 'base' => '

Input object for the endpoint

', 'refs' => [ 'DataQualityJobInput$EndpointInput' => NULL, 'ModelBiasJobInput$EndpointInput' => NULL, 'ModelExplainabilityJobInput$EndpointInput' => NULL, 'ModelQualityJobInput$EndpointInput' => NULL, 'MonitoringInput$EndpointInput' => '

The endpoint for a monitoring job.

', ], ], 'EndpointInputConfiguration' => [ 'base' => '

The endpoint configuration for the load test.

', 'refs' => [ 'EndpointInputConfigurations$member' => NULL, ], ], 'EndpointInputConfigurations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$EndpointConfigurations' => '

Specifies the endpoint configuration to use for a job.

', ], ], 'EndpointMetadata' => [ 'base' => '

The metadata of the endpoint.

', 'refs' => [ 'DescribeInferenceExperimentResponse$EndpointMetadata' => '

The metadata of the endpoint on which the inference experiment ran.

', ], ], 'EndpointName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointInput$EndpointName' => '

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

', 'CreateInferenceComponentInput$EndpointName' => '

The name of an existing endpoint where you host the inference component.

', 'CreateInferenceExperimentRequest$EndpointName' => '

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

', 'DeleteEndpointInput$EndpointName' => '

The name of the endpoint that you want to delete.

', 'DescribeEndpointInput$EndpointName' => '

The name of the endpoint.

', 'DescribeEndpointOutput$EndpointName' => '

Name of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'DescribeMonitoringScheduleResponse$EndpointName' => '

The name of the endpoint for the monitoring job.

', 'Endpoint$EndpointName' => '

The name of the endpoint.

', 'EndpointInfo$EndpointName' => '

The name of a customer\'s endpoint.

', 'EndpointInput$EndpointName' => '

An endpoint in customer\'s account which has enabled DataCaptureConfig enabled.

', 'EndpointMetadata$EndpointName' => '

The name of the endpoint.

', 'EndpointSummary$EndpointName' => '

The name of the endpoint.

', 'GetScalingConfigurationRecommendationRequest$EndpointName' => '

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the RecommendationId field.

', 'GetScalingConfigurationRecommendationResponse$EndpointName' => '

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

', 'InferenceComponentSummary$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'ListDataQualityJobDefinitionsRequest$EndpointName' => '

A filter that lists the data quality job definitions associated with the specified endpoint.

', 'ListInferenceComponentsInput$EndpointNameEquals' => '

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

', 'ListModelBiasJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model bias.

', 'ListModelExplainabilityJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model explainability.

', 'ListModelQualityJobDefinitionsRequest$EndpointName' => '

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

', 'ListMonitoringExecutionsRequest$EndpointName' => '

Name of a specific endpoint to fetch jobs for.

', 'ListMonitoringSchedulesRequest$EndpointName' => '

Name of a specific endpoint to fetch schedules for.

', 'ModelDashboardEndpoint$EndpointName' => '

The endpoint name.

', 'ModelDashboardMonitoringSchedule$EndpointName' => '

The endpoint which is monitored.

', 'ModelDeployConfig$EndpointName' => '

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

', 'ModelDeployResult$EndpointName' => '

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

', 'MonitoringExecutionSummary$EndpointName' => '

The name of the endpoint used to run the monitoring job.

', 'MonitoringJobDefinitionSummary$EndpointName' => '

The name of the endpoint that the job monitors.

', 'MonitoringSchedule$EndpointName' => '

The endpoint that hosts the model being monitored.

', 'MonitoringScheduleSummary$EndpointName' => '

The name of the endpoint using the monitoring schedule.

', 'UpdateEndpointInput$EndpointName' => '

The name of the endpoint whose configuration you want to update.

', 'UpdateEndpointWeightsAndCapacitiesInput$EndpointName' => '

The name of an existing SageMaker endpoint.

', ], ], 'EndpointNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$NameContains' => '

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

', ], ], 'EndpointOutputConfiguration' => [ 'base' => '

The endpoint configuration made by Inference Recommender during a recommendation job.

', 'refs' => [ 'InferenceRecommendation$EndpointConfiguration' => '

Defines the endpoint configuration parameters.

', 'RecommendationJobInferenceBenchmark$EndpointConfiguration' => NULL, ], ], 'EndpointPerformance' => [ 'base' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', 'refs' => [ 'EndpointPerformances$member' => NULL, ], ], 'EndpointPerformances' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$EndpointPerformances' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', ], ], 'EndpointSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'EndpointStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint\'s status to InService, see Rolling Deployments.

', 'Endpoint$EndpointStatus' => '

The status of the endpoint.

', 'EndpointMetadata$EndpointStatus' => '

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

', 'EndpointSummary$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

', 'ListEndpointsInput$StatusEquals' => '

A filter that returns only endpoints with the specified status.

', 'ModelDashboardEndpoint$EndpointStatus' => '

The endpoint status.

', ], ], 'EndpointSummary' => [ 'base' => '

Provides summary information for an endpoint.

', 'refs' => [ 'EndpointSummaryList$member' => NULL, ], ], 'EndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsOutput$Endpoints' => '

An array or endpoint objects.

', ], ], 'Endpoints' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$Endpoints' => '

Existing customer endpoints on which to run an Inference Recommender job.

', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Description' => '

A description of the additional Inference specification

', 'AlgorithmSummary$AlgorithmDescription' => '

A brief description of the algorithm.

', 'BatchDescribeModelPackageSummary$ModelPackageDescription' => '

The description of the model package.

', 'ChannelSpecification$Description' => '

A brief description of the channel.

', 'CreateAlgorithmInput$AlgorithmDescription' => '

A description of the algorithm.

', 'CreateModelPackageGroupInput$ModelPackageGroupDescription' => '

A description for the model group.

', 'CreateModelPackageInput$ModelPackageDescription' => '

A description of the model package.

', 'CreateProjectInput$ProjectDescription' => '

A description for the project.

', 'DescribeAlgorithmOutput$AlgorithmDescription' => '

A brief summary about the algorithm.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupDescription' => '

A description of the model group.

', 'DescribeModelPackageOutput$ModelPackageDescription' => '

A brief summary of the model package.

', 'DescribeProjectOutput$ProjectDescription' => '

The description of the project.

', 'HyperParameterSpecification$Description' => '

A brief description of the hyperparameter.

', 'ModelPackage$ModelPackageDescription' => '

The description of the model package.

', 'ModelPackageGroup$ModelPackageGroupDescription' => '

The description for the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupDescription' => '

A description of the model group.

', 'ModelPackageSummary$ModelPackageDescription' => '

A brief description of the model package.

', 'Project$ProjectDescription' => '

The description of the project.

', 'ProjectSummary$ProjectDescription' => '

The description of the project.

', 'UpdateProjectInput$ProjectDescription' => '

The description for the project.

', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Name' => '

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

', 'AlgorithmStatusItem$Name' => '

The name of the algorithm for which the overall status is being reported.

', 'AlgorithmSummary$AlgorithmName' => '

The name of the algorithm that is described by the summary.

', 'AlgorithmValidationProfile$ProfileName' => '

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'BatchDescribeModelPackageSummary$ModelPackageGroupName' => '

The group name for the model package

', 'CodeRepositorySummary$CodeRepositoryName' => '

The name of the Git repository.

', 'CompilationJobSummary$CompilationJobName' => '

The name of the model compilation job that you want a summary for.

', 'CreateAlgorithmInput$AlgorithmName' => '

The name of the algorithm.

', 'CreateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'CreateCompilationJobRequest$CompilationJobName' => '

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

', 'CreateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet that the device belongs to.

', 'CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgeDeploymentPlanRequest$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'CreateEdgePackagingJobRequest$CompilationJobName' => '

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

', 'CreateEdgePackagingJobRequest$ModelName' => '

The name of the model.

', 'CreateModelCardExportJobRequest$ModelCardExportJobName' => '

The name of the model card export job.

', 'CreateModelCardRequest$ModelCardName' => '

The unique name of the model card.

', 'CreateModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group.

', 'CreateModelPackageInput$ModelPackageName' => '

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

', 'DeleteAlgorithmInput$AlgorithmName' => '

The name of the algorithm to delete.

', 'DeleteCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to delete.

', 'DeleteCompilationJobRequest$CompilationJobName' => '

The name of the compilation job to delete.

', 'DeleteDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet to delete.

', 'DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to delete.

', 'DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan from which the stage will be deleted.

', 'DeleteEdgeDeploymentStageRequest$StageName' => '

The name of the stage.

', 'DeleteModelCardRequest$ModelCardName' => '

The name of the model card to delete.

', 'DeleteModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to delete the policy.

', 'DeploymentStage$StageName' => '

The name of the stage.

', 'DeploymentStageStatusSummary$StageName' => '

The name of the stage.

', 'DeregisterDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeAlgorithmOutput$AlgorithmName' => '

The name of the algorithm being described.

', 'DescribeCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to describe.

', 'DescribeCodeRepositoryOutput$CodeRepositoryName' => '

The name of the Git repository.

', 'DescribeCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job that you want information about.

', 'DescribeCompilationJobResponse$CompilationJobName' => '

The name of the model compilation job.

', 'DescribeDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceFleetResponse$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceRequest$DeviceName' => '

The unique ID of the device.

', 'DescribeDeviceRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeDeviceResponse$DeviceName' => '

The unique identifier of the device.

', 'DescribeDeviceResponse$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the deployment plan to describe.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'DescribeEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$CompilationJobName' => '

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

', 'DescribeEdgePackagingJobResponse$ModelName' => '

The name of the model.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobName' => '

The name of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

', 'DescribeModelCardResponse$ModelCardName' => '

The name of the model card.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupName' => '

The name of the model group.

', 'DescribeModelPackageOutput$ModelPackageName' => '

The name of the model package being described.

', 'DescribeModelPackageOutput$ModelPackageGroupName' => '

If the model is a versioned model, the name of the model group that the versioned model belongs to.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DeviceDeploymentSummary$StageName' => '

The name of the stage in the edge deployment plan.

', 'DeviceDeploymentSummary$DeployedStageName' => '

The name of the deployed stage.

', 'DeviceDeploymentSummary$DeviceFleetName' => '

The name of the fleet to which the device belongs to.

', 'DeviceFleetSummary$DeviceFleetName' => '

Name of the device fleet.

', 'DeviceSummary$DeviceName' => '

The unique identifier of the device.

', 'DeviceSummary$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'EdgeDeploymentModelConfig$ModelHandle' => '

The name the device application uses to reference this model.

', 'EdgeDeploymentModelConfig$EdgePackagingJobName' => '

The edge packaging job associated with this deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$DeviceFleetName' => '

The name of the device fleet used for the deployment.

', 'EdgeModel$ModelName' => '

The name of the model.

', 'EdgeModelStat$ModelName' => '

The name of the model.

', 'EdgeModelSummary$ModelName' => '

The name of the model.

', 'EdgePackagingJobSummary$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'EdgePackagingJobSummary$CompilationJobName' => '

The name of the SageMaker Neo compilation job.

', 'EdgePackagingJobSummary$ModelName' => '

The name of the model.

', 'GetDeviceFleetReportRequest$DeviceFleetName' => '

The name of the fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetName' => '

The name of the fleet.

', 'GetModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to get the resource policy.

', 'ListDevicesRequest$ModelName' => '

A filter that searches devices that contains this name in any of their models.

', 'ListDevicesRequest$DeviceFleetName' => '

Filter for fleets containing this name in their device fleet name.

', 'ListModelCardExportJobsRequest$ModelCardName' => '

List export jobs for the model card with the specified name.

', 'ListModelCardExportJobsRequest$ModelCardExportJobNameContains' => '

Only list model card export jobs with names that contain the specified string.

', 'ListModelCardsRequest$NameContains' => '

Only list model cards with names that contain the specified string.

', 'ListStageDevicesRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'ListStageDevicesRequest$StageName' => '

The name of the stage in the deployment.

', 'ModelCard$ModelCardName' => '

The unique name of the model card.

', 'ModelCardExportJobSummary$ModelCardExportJobName' => '

The name of the model card export job.

', 'ModelCardExportJobSummary$ModelCardName' => '

The name of the model card that the export job exports.

', 'ModelCardSummary$ModelCardName' => '

The name of the model card.

', 'ModelCardVersionSummary$ModelCardName' => '

The name of the model card.

', 'ModelDashboardModelCard$ModelCardName' => '

The name of a model card.

', 'ModelPackage$ModelPackageName' => '

The name of the model.

', 'ModelPackage$ModelPackageGroupName' => '

The model group to which the model belongs.

', 'ModelPackageGroup$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageStatusItem$Name' => '

The name of the model package for which the overall status is being reported.

', 'ModelPackageSummary$ModelPackageName' => '

The name of the model package.

', 'ModelPackageSummary$ModelPackageGroupName' => '

If the model package is a versioned model, the model group that the versioned model belongs to.

', 'ModelPackageValidationProfile$ProfileName' => '

The name of the profile for the model package.

', 'PutModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group to add a resource policy to.

', 'RegisterDevicesRequest$DeviceFleetName' => '

The name of the fleet.

', 'StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to start.

', 'StartEdgeDeploymentStageRequest$StageName' => '

The name of the stage to start.

', 'StopCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job to stop.

', 'StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to stop.

', 'StopEdgeDeploymentStageRequest$StageName' => '

The name of the stage to stop.

', 'StopEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'UpdateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to update.

', 'UpdateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'UpdateDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', ], ], 'EnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$key' => NULL, ], ], 'EnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Environment' => '

The environment variables to set in the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Environment' => '

The environment variables to set in the Docker container.

The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB.

', 'InferenceComponentContainerSpecification$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

', 'InferenceComponentContainerSpecificationSummary$Environment' => '

The environment variables to set in the Docker container.

', 'ModelPackageContainerDefinition$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

', 'RealTimeInferenceRecommendation$Environment' => '

The recommended environment variables to set in the model container for Real-Time Inference.

', ], ], 'EnvironmentParameter' => [ 'base' => '

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

', 'refs' => [ 'EnvironmentParameters$member' => NULL, ], ], 'EnvironmentParameterRanges' => [ 'base' => '

Specifies the range of environment parameters

', 'refs' => [ 'EndpointInputConfiguration$EnvironmentParameterRanges' => '

The parameter you want to benchmark against.

', ], ], 'EnvironmentParameters' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$EnvironmentParameters' => '

Defines the environment parameters that includes key, value types, and values.

', ], ], 'EnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$value' => NULL, ], ], 'ExcludeFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', 'EndpointInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', ], ], 'ExecutionRoleIdentityConfig' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

', 'DomainSettingsForUpdate$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$StatusEquals' => '

A filter that retrieves only jobs with a specific status.

', 'MonitoringExecutionSummary$MonitoringExecutionStatus' => '

The status of the monitoring job.

', ], ], 'ExitMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJob$ExitMessage' => '

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJobSummary$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', ], ], 'Experiment' => [ 'base' => '

The properties of an experiment as returned by the Search API.

', 'refs' => [ 'SearchRecord$Experiment' => '

The properties of an experiment.

', ], ], 'ExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'DeleteExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment that is being deleted.

', 'DescribeExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'Experiment$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'ExperimentSummary$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'UpdateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', ], ], 'ExperimentConfig' => [ 'base' => '

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

', 'refs' => [ 'CreateProcessingJobRequest$ExperimentConfig' => NULL, 'CreateTrainingJobRequest$ExperimentConfig' => NULL, 'CreateTransformJobRequest$ExperimentConfig' => NULL, 'DescribeProcessingJobResponse$ExperimentConfig' => '

The configuration information used to create an experiment.

', 'DescribeTrainingJobResponse$ExperimentConfig' => NULL, 'DescribeTransformJobResponse$ExperimentConfig' => NULL, 'ProcessingJob$ExperimentConfig' => NULL, 'TrainingJob$ExperimentConfig' => NULL, 'TransformJob$ExperimentConfig' => NULL, ], ], 'ExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Description' => '

The description of the action.

', 'CreateContextRequest$Description' => '

The description of the context.

', 'CreateExperimentRequest$Description' => '

The description of the experiment.

', 'DescribeActionResponse$Description' => '

The description of the action.

', 'DescribeContextResponse$Description' => '

The description of the context.

', 'DescribeExperimentResponse$Description' => '

The description of the experiment.

', 'DescribeLineageGroupResponse$Description' => '

The description of the lineage group.

', 'Experiment$Description' => '

The description of the experiment.

', 'UpdateActionRequest$Description' => '

The new description for the action.

', 'UpdateContextRequest$Description' => '

The new description for the context.

', 'UpdateExperimentRequest$Description' => '

The description of the experiment.

', ], ], 'ExperimentEntityName' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionName' => '

The name of the action.

', 'ArtifactSummary$ArtifactName' => '

The name of the artifact.

', 'AssociateTrialComponentRequest$TrialComponentName' => '

The name of the component to associated with the trial.

', 'AssociateTrialComponentRequest$TrialName' => '

The name of the trial to associate with.

', 'AssociationSummary$SourceName' => '

The name of the source.

', 'AssociationSummary$DestinationName' => '

The name of the destination.

', 'CreateActionRequest$ActionName' => '

The name of the action. Must be unique to your account in an Amazon Web Services Region.

', 'CreateArtifactRequest$ArtifactName' => '

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

', 'CreateExperimentRequest$ExperimentName' => '

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If you don\'t specify DisplayName, the value in ExperimentName is displayed.

', 'CreateTrialComponentRequest$TrialComponentName' => '

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'CreateTrialRequest$TrialName' => '

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', 'CreateTrialRequest$ExperimentName' => '

The name of the experiment to associate the trial with.

', 'DeleteActionRequest$ActionName' => '

The name of the action to delete.

', 'DeleteExperimentRequest$ExperimentName' => '

The name of the experiment to delete.

', 'DeleteTrialComponentRequest$TrialComponentName' => '

The name of the component to delete.

', 'DeleteTrialRequest$TrialName' => '

The name of the trial to delete.

', 'DescribeExperimentRequest$ExperimentName' => '

The name of the experiment to describe.

', 'DescribeExperimentResponse$ExperimentName' => '

The name of the experiment.

', 'DescribeExperimentResponse$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'DescribeLineageGroupRequest$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$DisplayName' => '

The display name of the lineage group.

', 'DescribeTrialComponentResponse$TrialComponentName' => '

The name of the trial component.

', 'DescribeTrialComponentResponse$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'DescribeTrialRequest$TrialName' => '

The name of the trial to describe.

', 'DescribeTrialResponse$TrialName' => '

The name of the trial.

', 'DescribeTrialResponse$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'DescribeTrialResponse$ExperimentName' => '

The name of the experiment the trial is part of.

', 'DisassociateTrialComponentRequest$TrialComponentName' => '

The name of the component to disassociate from the trial.

', 'DisassociateTrialComponentRequest$TrialName' => '

The name of the trial to disassociate from.

', 'Experiment$ExperimentName' => '

The name of the experiment.

', 'Experiment$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'ExperimentConfig$ExperimentName' => '

The name of an existing experiment to associate with the trial component.

', 'ExperimentConfig$TrialName' => '

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

', 'ExperimentConfig$TrialComponentDisplayName' => '

The display name for the trial component. If this key isn\'t specified, the display name is the trial component name.

', 'ExperimentConfig$RunName' => '

The name of the experiment run to associate with the trial component.

', 'ExperimentSummary$ExperimentName' => '

The name of the experiment.

', 'ExperimentSummary$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'LineageGroupSummary$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$DisplayName' => '

The display name of the lineage group summary.

', 'ListTrialComponentsRequest$ExperimentName' => '

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can\'t filter by SourceArn or TrialName.

', 'ListTrialComponentsRequest$TrialName' => '

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can\'t filter by ExperimentName or SourceArn.

', 'ListTrialsRequest$ExperimentName' => '

A filter that returns only trials that are part of the specified experiment.

', 'ListTrialsRequest$TrialComponentName' => '

A filter that returns only trials that are associated with the specified trial component.

', 'Parent$TrialName' => '

The name of the trial.

', 'Parent$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$TrialName' => '

The name of the trial.

', 'Trial$TrialName' => '

The name of the trial.

', 'Trial$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'Trial$ExperimentName' => '

The name of the experiment the trial is part of.

', 'TrialComponent$TrialComponentName' => '

The name of the trial component.

', 'TrialComponent$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialComponent$RunName' => '

The name of the experiment run.

', 'TrialComponentSimpleSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialSummary$TrialName' => '

The name of the trial.

', 'TrialSummary$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'UpdateActionRequest$ActionName' => '

The name of the action to update.

', 'UpdateArtifactRequest$ArtifactName' => '

The new name for the artifact.

', 'UpdateExperimentRequest$ExperimentName' => '

The name of the experiment to update.

', 'UpdateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'UpdateTrialComponentRequest$TrialComponentName' => '

The name of the component to update.

', 'UpdateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'UpdateTrialRequest$TrialName' => '

The name of the trial to update.

', 'UpdateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', ], ], 'ExperimentEntityNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionRequest$ActionName' => '

The name of the action to describe.

', 'DescribeActionResponse$ActionName' => '

The name of the action.

', 'DescribeArtifactResponse$ArtifactName' => '

The name of the artifact.

', 'DescribeTrialComponentRequest$TrialComponentName' => '

The name of the trial component to describe.

', ], ], 'ExperimentSource' => [ 'base' => '

The source of the experiment.

', 'refs' => [ 'DescribeExperimentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the type.

', 'Experiment$Source' => NULL, 'ExperimentSummary$ExperimentSource' => NULL, ], ], 'ExperimentSourceArn' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'ExperimentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsResponse$ExperimentSummaries' => '

A list of the summaries of your experiments.

', ], ], 'ExperimentSummary' => [ 'base' => '

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

', 'refs' => [ 'ExperimentSummaries$member' => NULL, ], ], 'ExpiresInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$ExpiresInSeconds' => '

The number of seconds until the pre-signed URL expires. This value defaults to 300.

', ], ], 'Explainability' => [ 'base' => '

Contains explainability metrics for a model.

', 'refs' => [ 'ModelMetrics$Explainability' => '

Metrics that help explain a model.

', ], ], 'ExplainabilityLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$Explainability' => '

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

', ], ], 'ExplainerConfig' => [ 'base' => '

A parameter to activate explainers.

', 'refs' => [ 'CreateEndpointConfigInput$ExplainerConfig' => '

A member of CreateEndpointConfig that enables explainers.

', 'DescribeEndpointConfigOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', 'DescribeEndpointOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', ], ], 'FailStepMetadata' => [ 'base' => '

The container for the metadata for Fail step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Fail' => '

The configurations and outcomes of a Fail step execution.

', ], ], 'FailureHandlingPolicy' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentConfig$FailureHandlingPolicy' => '

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'DescribeAppResponse$FailureReason' => '

The failure reason.

', 'DescribeCompilationJobResponse$FailureReason' => '

If a model compilation job failed, the reason it failed.

', 'DescribeDomainResponse$FailureReason' => '

The failure reason.

', 'DescribeEndpointOutput$FailureReason' => '

If the status of the endpoint is Failed, the reason why it failed.

', 'DescribeFeatureGroupResponse$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.

  • The FeatureGroup could not be deleted from the OfflineStore.

', 'DescribeFlowDefinitionResponse$FailureReason' => '

The reason your flow definition failed.

', 'DescribeHubContentResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHubResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHyperParameterTuningJobResponse$FailureReason' => '

If the tuning job failed, the reason it failed.

', 'DescribeImageResponse$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'DescribeImageVersionResponse$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'DescribeInferenceComponentOutput$FailureReason' => '

If the inference component status is Failed, the reason for the failure.

', 'DescribeInferenceRecommendationsJobResponse$FailureReason' => '

If the job fails, provides information why the job failed.

', 'DescribeLabelingJobResponse$FailureReason' => '

If the job failed, the reason that it failed.

', 'DescribeModelCardExportJobResponse$FailureReason' => '

The failure reason if the model export job fails.

', 'DescribeMonitoringScheduleResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

', 'DescribeNotebookInstanceOutput$FailureReason' => '

If status is Failed, the reason it failed.

', 'DescribeProcessingJobResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'DescribeSpaceResponse$FailureReason' => '

The failure reason.

', 'DescribeTrainingJobResponse$FailureReason' => '

If the training job failed, the reason it failed.

', 'DescribeTransformJobResponse$FailureReason' => '

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

', 'DescribeUserProfileResponse$FailureReason' => '

The failure reason.

', 'Endpoint$FailureReason' => '

If the endpoint failed, the reason it failed.

', 'EndpointMetadata$FailureReason' => '

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

', 'FeatureGroup$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

', 'FlowDefinitionSummary$FailureReason' => '

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

', 'HyperParameterTrainingJobSummary$FailureReason' => '

The reason that the training job failed.

', 'HyperParameterTuningJobSearchEntity$FailureReason' => '

The error that was created when a hyperparameter tuning job failed.

', 'Image$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'ImageVersion$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'InferenceRecommendationsJob$FailureReason' => '

If the job fails, provides information why the job failed.

', 'LabelingJobSummary$FailureReason' => '

If the LabelingJobStatus field is Failed, this field contains a description of the error.

', 'LastUpdateStatus$FailureReason' => '

If the update wasn\'t successful, indicates the reason why it failed.

', 'ModelDashboardMonitoringSchedule$FailureReason' => '

If a monitoring job failed, provides the reason.

', 'MonitoringExecutionSummary$FailureReason' => '

Contains the reason a monitoring job failed, if it failed.

', 'MonitoringSchedule$FailureReason' => '

If the monitoring schedule failed, the reason it failed.

', 'PipelineExecutionStep$FailureReason' => '

The reason why the step failed execution. This is only returned if the step failed its execution.

', 'ProcessingJob$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ProcessingJobSummary$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ResourceInUse$Message' => NULL, 'ResourceLimitExceeded$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'TrainingJob$FailureReason' => '

If the training job failed, the reason it failed.

', 'TransformJob$FailureReason' => '

If the transform job failed, the reason it failed.

', 'TransformJobSummary$FailureReason' => '

If the transform job failed, the reason it failed.

', ], ], 'FeatureAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureGroupRequest$FeatureAdditions' => '

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you\'ve made a valid request. It takes some time after you\'ve made a valid request for Feature Store to update the feature group.

', ], ], 'FeatureDefinition' => [ 'base' => '

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

', 'refs' => [ 'FeatureAdditions$member' => NULL, 'FeatureDefinitions$member' => NULL, ], ], 'FeatureDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureDefinitions' => '

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', 'DescribeFeatureGroupResponse$FeatureDefinitions' => '

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

', 'FeatureGroup$FeatureDefinitions' => '

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', ], ], 'FeatureDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Description' => '

The description you added to describe the feature.

', 'FeatureMetadata$Description' => '

An optional description that you specify to better describe the feature.

', 'UpdateFeatureMetadataRequest$Description' => '

A description that you can write to better describe the feature.

', ], ], 'FeatureGroup' => [ 'base' => '

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

', 'refs' => [ 'SearchRecord$FeatureGroup' => NULL, ], ], 'FeatureGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

', 'DescribeFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that contains the feature.

', 'FeatureGroup$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of a FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupArn' => '

Unique identifier for the FeatureGroup.

', 'FeatureMetadata$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group.

', 'UpdateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that you\'re updating.

', ], ], 'FeatureGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$MaxResults' => '

The maximum number of results returned by ListFeatureGroups.

', ], ], 'FeatureGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

', 'DeleteFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeFeatureGroupResponse$FeatureGroupName' => '

he name of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupName' => '

The name of the feature group that you\'ve specified.

', 'FeatureGroup$FeatureGroupName' => '

The name of the FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupName' => '

The name of FeatureGroup.

', 'FeatureMetadata$FeatureGroupName' => '

The name of the feature group containing the feature.

', 'ProcessingFeatureStoreOutput$FeatureGroupName' => '

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

', ], ], 'FeatureGroupNameContains' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$NameContains' => '

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

', ], ], 'FeatureGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

', 'DescribeFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature.

', 'UpdateFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group that you\'re updating.

', 'UpdateFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you\'re updating.

', ], ], 'FeatureGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortBy' => '

The value on which the feature group list is sorted.

', ], ], 'FeatureGroupSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortOrder' => '

The order in which feature groups are listed.

', ], ], 'FeatureGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$FeatureGroupStatus' => '

The status of the feature group.

', 'FeatureGroup$FeatureGroupStatus' => '

A FeatureGroup status.

', 'FeatureGroupSummary$FeatureGroupStatus' => '

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

', 'ListFeatureGroupsRequest$FeatureGroupStatusEquals' => '

A FeatureGroup status. Filters by FeatureGroup status.

', ], ], 'FeatureGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsResponse$FeatureGroupSummaries' => '

A summary of feature groups.

', ], ], 'FeatureGroupSummary' => [ 'base' => '

The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

', 'refs' => [ 'FeatureGroupSummaries$member' => NULL, ], ], 'FeatureMetadata' => [ 'base' => '

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

', 'refs' => [ 'SearchRecord$FeatureMetadata' => '

The feature metadata used to search through the features.

', ], ], 'FeatureName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions\' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

', 'CreateFeatureGroupRequest$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd\'T\'HH:mm:ssZ and yyyy-MM-dd\'T\'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. \'T\' and Z are constants.

', 'DescribeFeatureGroupResponse$RecordIdentifierFeatureName' => '

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

', 'DescribeFeatureGroupResponse$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

', 'DescribeFeatureMetadataRequest$FeatureName' => '

The name of the feature.

', 'DescribeFeatureMetadataResponse$FeatureName' => '

The name of the feature that you\'ve specified.

', 'FeatureDefinition$FeatureName' => '

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

', 'FeatureGroup$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

', 'FeatureGroup$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

', 'FeatureMetadata$FeatureName' => '

The name of feature.

', 'UpdateFeatureMetadataRequest$FeatureName' => '

The name of the feature that you\'re updating.

', ], ], 'FeatureParameter' => [ 'base' => '

A key-value pair that you specify to describe the feature.

', 'refs' => [ 'FeatureParameterAdditions$member' => NULL, 'FeatureParameters$member' => NULL, ], ], 'FeatureParameterAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterAdditions' => '

A list of key-value pairs that you can add to better describe the feature.

', ], ], 'FeatureParameterKey' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Key' => '

A key that must contain a value to describe the feature.

', 'FeatureParameterRemovals$member' => NULL, ], ], 'FeatureParameterRemovals' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterRemovals' => '

A list of parameter keys that you can specify to remove parameters that describe your feature.

', ], ], 'FeatureParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Value' => '

The value that belongs to a key.

', ], ], 'FeatureParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Parameters' => '

The key-value pairs that you added to describe the feature.

', 'FeatureMetadata$Parameters' => '

Optional key-value pairs that you specify to better describe the feature.

', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'DirectDeploySettings$Status' => '

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

', 'DockerSettings$EnableDockerAccess' => '

Indicates whether the domain can access Docker.

', 'IdentityProviderOAuthSetting$Status' => '

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

', 'KendraSettings$Status' => '

Describes whether the document querying feature is enabled or disabled in the Canvas application.

', 'ModelRegisterSettings$Status' => '

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

', 'TimeSeriesForecastingSettings$Status' => '

Describes whether time series forecasting is enabled or disabled in the Canvas application.

', ], ], 'FeatureType' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$FeatureType' => '

The data type of the feature.

', 'FeatureDefinition$FeatureType' => '

The value type of a feature. Valid values are Integral, Fractional, or String.

', 'FeatureMetadata$FeatureType' => '

The data type of the feature.

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

Contains details regarding the file source.

', 'refs' => [ 'DriftCheckBias$ConfigFile' => '

The bias config file for a model.

', 'DriftCheckExplainability$ConfigFile' => '

The explainability config file for the model.

', ], ], 'FileSystemAccessMode' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemAccessMode' => '

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

', ], ], 'FileSystemConfig' => [ 'base' => '

The Amazon Elastic File System storage configuration for a SageMaker image.

', 'refs' => [ 'CodeEditorAppImageConfig$FileSystemConfig' => NULL, 'JupyterLabAppImageConfig$FileSystemConfig' => NULL, 'KernelGatewayImageConfig$FileSystemConfig' => '

The Amazon Elastic File System storage configuration for a SageMaker image.

', ], ], 'FileSystemDataSource' => [ 'base' => '

Specifies a file system data source for a channel.

', 'refs' => [ 'DataSource$FileSystemDataSource' => '

The file system that is associated with a channel.

', ], ], 'FileSystemId' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystem$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'EFSFileSystemConfig$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'FileSystemDataSource$FileSystemId' => '

The file system id.

', ], ], 'FileSystemPath' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystemConfig$FileSystemPath' => '

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemType' => '

The file system type.

', ], ], 'FillingTransformationMap' => [ 'base' => NULL, 'refs' => [ 'FillingTransformations$value' => NULL, ], ], 'FillingTransformationValue' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$value' => NULL, ], ], 'FillingTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Filling' => '

A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

The supported filling methods and their corresponding options are:

  • frontfill: none (Supported only for target column)

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

', ], ], 'FillingType' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$key' => NULL, ], ], 'Filter' => [ 'base' => '

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GreaterThan",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LessThan",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'NestedFilters$Filters' => '

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

', 'SearchExpression$Filters' => '

A list of filter objects.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'Filter$Value' => '

A value used with Name and Operator to determine which resources satisfy the filter\'s condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd\'T\'HH:MM:SS.

', ], ], 'FinalAutoMLJobObjectiveMetric' => [ 'base' => '

The best candidate result from an AutoML training job.

', 'refs' => [ 'AutoMLCandidate$FinalAutoMLJobObjectiveMetric' => NULL, ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'base' => '

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

', 'refs' => [ 'HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric' => '

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

', ], ], 'FinalMetricDataList' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$FinalMetricDataList' => '

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

', 'TrainingJob$FinalMetricDataList' => '

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

', ], ], 'FlatInvocations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$FlatInvocations' => '

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'MetricData$Value' => '

The value of the metric.

', 'MetricDatum$Value' => '

The value of the metric.

', 'RecommendationMetrics$CostPerHour' => '

Defines the cost per hour for the instance.

', 'RecommendationMetrics$CostPerInference' => '

Defines the cost per inference for the instance .

', ], ], 'FlowDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition you create.

', 'DescribeFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow defintion.

', 'FlowDefinitionSummary$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition.

', ], ], 'FlowDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionRequest$FlowDefinitionName' => '

The name of your flow definition.

', 'DeleteFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition you are deleting.

', 'DescribeFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition.

', 'DescribeFlowDefinitionResponse$FlowDefinitionName' => '

The Amazon Resource Name (ARN) of the flow definition.

', 'FlowDefinitionSummary$FlowDefinitionName' => '

The name of the flow definition.

', ], ], 'FlowDefinitionOutputConfig' => [ 'base' => '

Contains information about where human output will be stored.

', 'refs' => [ 'CreateFlowDefinitionRequest$OutputConfig' => '

An object containing information about where the human review results will be uploaded.

', 'DescribeFlowDefinitionResponse$OutputConfig' => '

An object containing information about the output file.

', ], ], 'FlowDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowDefinitionResponse$FlowDefinitionStatus' => '

The status of the flow definition. Valid values are listed below.

', 'FlowDefinitionSummary$FlowDefinitionStatus' => '

The status of the flow definition. Valid values:

', ], ], 'FlowDefinitionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFlowDefinitionsResponse$FlowDefinitionSummaries' => '

An array of objects describing the flow definitions.

', ], ], 'FlowDefinitionSummary' => [ 'base' => '

Contains summary information about the flow definition.

', 'refs' => [ 'FlowDefinitionSummaries$member' => NULL, ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for review by human workers.

', ], ], 'FlowDefinitionTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskCount' => '

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

', ], ], 'FlowDefinitionTaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskDescription' => '

A description for the human worker task.

', ], ], 'FlowDefinitionTaskKeyword' => [ 'base' => NULL, 'refs' => [ 'FlowDefinitionTaskKeywords$member' => NULL, ], ], 'FlowDefinitionTaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskKeywords' => '

Keywords used to describe the task so that workers can discover the task.

', ], ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

', ], ], 'FlowDefinitionTaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTitle' => '

A title for the human worker task.

', ], ], 'ForecastFrequency' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastFrequency' => '

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.

The valid values for each frequency are the following:

  • Minute - 1-59

  • Hour - 1-23

  • Day - 1-6

  • Week - 1-4

  • Month - 1-11

  • Year - 1

', ], ], 'ForecastHorizon' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastHorizon' => '

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.

', ], ], 'ForecastQuantile' => [ 'base' => NULL, 'refs' => [ 'ForecastQuantiles$member' => NULL, ], ], 'ForecastQuantiles' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastQuantiles' => '

The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.

', ], ], 'Framework' => [ 'base' => NULL, 'refs' => [ 'InputConfig$Framework' => '

Identifies the framework in which the model was trained. For example: TENSORFLOW.

', ], ], 'FrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'InputConfig$FrameworkVersion' => '

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

', ], ], 'GenerateCandidateDefinitionsOnly' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', 'DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly' => '

Indicates whether the output for an AutoML job generates candidate definitions only.

', 'TabularJobConfig$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', ], ], 'GenerativeAiSettings' => [ 'base' => '

The generative AI settings for the SageMaker Canvas application.

Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.

', 'refs' => [ 'CanvasAppSettings$GenerativeAiSettings' => '

The generative AI settings for the SageMaker Canvas application.

', ], ], 'GetDeviceFleetReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceFleetReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Gid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Gid' => '

The POSIX group ID.

', ], ], 'GitConfig' => [ 'base' => '

Specifies configuration details for a Git repository in your Amazon Web Services account.

', 'refs' => [ 'CodeRepositorySummary$GitConfig' => '

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', 'CreateCodeRepositoryInput$GitConfig' => '

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

', 'DescribeCodeRepositoryOutput$GitConfig' => '

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'GitConfigForUpdate' => [ 'base' => '

Specifies configuration details for a Git repository when the repository is updated.

', 'refs' => [ 'UpdateCodeRepositoryInput$GitConfig' => '

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', ], ], 'GitConfigUrl' => [ 'base' => NULL, 'refs' => [ 'GitConfig$RepositoryUrl' => '

The URL where the Git repository is located.

', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupingAttributeName' => [ 'base' => NULL, 'refs' => [ 'GroupingAttributeNames$member' => NULL, ], ], 'GroupingAttributeNames' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$GroupingAttributeNames' => '

A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'OidcMemberDefinition$Groups' => '

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

', ], ], 'HolidayConfig' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$HolidayConfig' => '

The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.

', ], ], 'HolidayConfigAttributes' => [ 'base' => '

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

', 'refs' => [ 'HolidayConfig$member' => NULL, ], ], 'HookParameters' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$HookParameters' => '

Configuration information for the Amazon SageMaker Debugger hook parameters.

', ], ], 'Horovod' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', 'DescribeImageVersionResponse$Horovod' => '

Indicates Horovod compatibility.

', 'UpdateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', ], ], 'HubArn' => [ 'base' => NULL, 'refs' => [ 'CreateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'DescribeHubContentResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub that contains the content.

', 'DescribeHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'HubInfo$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'ImportHubContentResponse$HubArn' => '

The ARN of the hub that the content was imported into.

', 'UpdateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the updated hub.

', ], ], 'HubContentArn' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'HubContentInfo$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'ImportHubContentResponse$HubContentArn' => '

The ARN of the hub content that was imported.

', ], ], 'HubContentDependency' => [ 'base' => '

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

', 'refs' => [ 'HubContentDependencyList$member' => NULL, ], ], 'HubContentDependencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDependencies' => '

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

', ], ], 'HubContentDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDescription' => '

A description of the hub content.

', 'HubContentInfo$HubContentDescription' => '

A description of the hub content.

', 'ImportHubContentRequest$HubContentDescription' => '

A description of the hub content to import.

', ], ], 'HubContentDisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDisplayName' => '

The display name of the hub content.

', 'HubContentInfo$HubContentDisplayName' => '

The display name of the hub content.

', 'ImportHubContentRequest$HubContentDisplayName' => '

The display name of the hub content to import.

', ], ], 'HubContentDocument' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', 'ImportHubContentRequest$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', ], ], 'HubContentInfo' => [ 'base' => '

Information about hub content.

', 'refs' => [ 'HubContentInfoList$member' => NULL, ], ], 'HubContentInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsResponse$HubContentSummaries' => '

The summaries of the listed hub content versions.

', 'ListHubContentsResponse$HubContentSummaries' => '

The summaries of the listed hub content.

', ], ], 'HubContentMarkdown' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', 'ImportHubContentRequest$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', ], ], 'HubContentName' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentName' => '

The name of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentName' => '

The name of the content to describe.

', 'DescribeHubContentResponse$HubContentName' => '

The name of the hub content.

', 'HubContentInfo$HubContentName' => '

The name of the hub content.

', 'ImportHubContentRequest$HubContentName' => '

The name of the hub content to import.

', 'ListHubContentVersionsRequest$HubContentName' => '

The name of the hub content.

', ], ], 'HubContentSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'HubContentInfo$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'ImportHubContentRequest$HubContentSearchKeywords' => '

The searchable keywords of the hub content.

', ], ], 'HubContentSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', 'ListHubContentsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', ], ], 'HubContentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentStatus' => '

The status of the hub content.

', 'HubContentInfo$HubContentStatus' => '

The status of the hub content.

', ], ], 'HubContentType' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentType' => '

The type of content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentType' => '

The type of content in the hub.

', 'DescribeHubContentResponse$HubContentType' => '

The type of hub content.

', 'HubContentInfo$HubContentType' => '

The type of hub content.

', 'ImportHubContentRequest$HubContentType' => '

The type of hub content to import.

', 'ListHubContentVersionsRequest$HubContentType' => '

The type of hub content to list versions of.

', 'ListHubContentsRequest$HubContentType' => '

The type of hub content to list.

', ], ], 'HubContentVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentVersion' => '

The version of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentVersion' => '

The version of the content to describe.

', 'DescribeHubContentResponse$HubContentVersion' => '

The version of the hub content.

', 'HubContentInfo$HubContentVersion' => '

The version of the hub content.

', 'ImportHubContentRequest$HubContentVersion' => '

The version of the hub content to import.

', 'ListHubContentVersionsRequest$MinVersion' => '

The lower bound of the hub content versions to list.

', ], ], 'HubDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDescription' => '

A description of the hub.

', 'DescribeHubResponse$HubDescription' => '

A description of the hub.

', 'HubInfo$HubDescription' => '

A description of the hub.

', 'UpdateHubRequest$HubDescription' => '

A description of the updated hub.

', ], ], 'HubDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDisplayName' => '

The display name of the hub.

', 'DescribeHubResponse$HubDisplayName' => '

The display name of the hub.

', 'HubInfo$HubDisplayName' => '

The display name of the hub.

', 'UpdateHubRequest$HubDisplayName' => '

The display name of the hub.

', ], ], 'HubInfo' => [ 'base' => '

Information about a hub.

', 'refs' => [ 'HubInfoList$member' => NULL, ], ], 'HubInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubsResponse$HubSummaries' => '

The summaries of the listed hubs.

', ], ], 'HubName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubName' => '

The name of the hub to create.

', 'DeleteHubContentRequest$HubName' => '

The name of the hub that you want to delete content in.

', 'DeleteHubRequest$HubName' => '

The name of the hub to delete.

', 'DescribeHubContentRequest$HubName' => '

The name of the hub that contains the content to describe.

', 'DescribeHubContentResponse$HubName' => '

The name of the hub that contains the content.

', 'DescribeHubRequest$HubName' => '

The name of the hub to describe.

', 'DescribeHubResponse$HubName' => '

The name of the hub.

', 'HubInfo$HubName' => '

The name of the hub.

', 'ImportHubContentRequest$HubName' => '

The name of the hub to import content into.

', 'ListHubContentVersionsRequest$HubName' => '

The name of the hub to list the content versions of.

', 'ListHubContentsRequest$HubName' => '

The name of the hub to list the contents of.

', 'UpdateHubRequest$HubName' => '

The name of the hub to update.

', ], ], 'HubS3StorageConfig' => [ 'base' => '

The Amazon S3 storage configuration of a hub.

', 'refs' => [ 'CreateHubRequest$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', 'DescribeHubResponse$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', ], ], 'HubSearchKeyword' => [ 'base' => NULL, 'refs' => [ 'HubContentSearchKeywordList$member' => NULL, 'HubSearchKeywordList$member' => NULL, ], ], 'HubSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'DescribeHubResponse$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'HubInfo$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'UpdateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', ], ], 'HubSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubsRequest$SortBy' => '

Sort hubs by either name or creation time.

', ], ], 'HubStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubResponse$HubStatus' => '

The status of the hub.

', 'HubInfo$HubStatus' => '

The status of the hub.

', ], ], 'HumanLoopActivationConditions' => [ 'base' => NULL, 'refs' => [ 'HumanLoopActivationConditionsConfig$HumanLoopActivationConditions' => '

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

', ], ], 'HumanLoopActivationConditionsConfig' => [ 'base' => '

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

', 'refs' => [ 'HumanLoopActivationConfig$HumanLoopActivationConditionsConfig' => '

Container structure for defining under what conditions SageMaker creates a human loop.

', ], ], 'HumanLoopActivationConfig' => [ 'base' => '

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopActivationConfig' => '

An object containing information about the events that trigger a human workflow.

', 'DescribeFlowDefinitionResponse$HumanLoopActivationConfig' => '

An object containing information about what triggers a human review workflow.

', ], ], 'HumanLoopConfig' => [ 'base' => '

Describes the work to be performed by human workers.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopConfig' => '

An object containing information about the tasks the human reviewers will perform.

', 'DescribeFlowDefinitionResponse$HumanLoopConfig' => '

An object containing information about who works on the task, the workforce task price, and other task details.

', ], ], 'HumanLoopRequestSource' => [ 'base' => '

Container for configuring the source of human task requests.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', 'DescribeFlowDefinitionResponse$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', ], ], 'HumanTaskConfig' => [ 'base' => '

Information required for human workers to complete a labeling task.

', 'refs' => [ 'CreateLabelingJobRequest$HumanTaskConfig' => '

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

', 'DescribeLabelingJobResponse$HumanTaskConfig' => '

Configuration information required for human workers to complete a labeling task.

', ], ], 'HumanTaskUiArn' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

', 'DescribeHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

', 'HumanLoopConfig$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

', 'HumanTaskUiSummary$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

', 'RenderUiTemplateRequest$HumanTaskUiArn' => '

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

', 'UiConfig$HumanTaskUiArn' => '

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

', ], ], 'HumanTaskUiName' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiRequest$HumanTaskUiName' => '

The name of the user interface you are creating.

', 'DeleteHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (work task template) you want to delete.

', 'DescribeHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (worker task template) you want information about.

', 'DescribeHumanTaskUiResponse$HumanTaskUiName' => '

The name of the human task user interface (worker task template).

', 'HumanTaskUiSummary$HumanTaskUiName' => '

The name of the human task user interface.

', ], ], 'HumanTaskUiStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHumanTaskUiResponse$HumanTaskUiStatus' => '

The status of the human task user interface (worker task template). Valid values are listed below.

', ], ], 'HumanTaskUiSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHumanTaskUisResponse$HumanTaskUiSummaries' => '

An array of objects describing the human task user interfaces.

', ], ], 'HumanTaskUiSummary' => [ 'base' => '

Container for human task user interface information.

', 'refs' => [ 'HumanTaskUiSummaries$member' => NULL, ], ], 'HyperParameterAlgorithmSpecification' => [ 'base' => '

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$AlgorithmSpecification' => '

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

', ], ], 'HyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameters$key' => NULL, ], ], 'HyperParameterScalingType' => [ 'base' => NULL, 'refs' => [ 'ContinuousParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

', 'IntegerParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

', ], ], 'HyperParameterSpecification' => [ 'base' => '

Defines a hyperparameter to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecifications$member' => NULL, ], ], 'HyperParameterSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedHyperParameters' => '

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

', ], ], 'HyperParameterTrainingJobDefinition' => [ 'base' => '

Defines the training jobs launched by a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

', 'HyperParameterTrainingJobDefinitions$member' => NULL, 'HyperParameterTuningJobSearchEntity$TrainingJobDefinition' => NULL, ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$DefinitionName' => '

The job definition name.

', 'HyperParameterTrainingJobSummary$TrainingJobDefinitionName' => '

The training job definition name.

', ], ], 'HyperParameterTrainingJobDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'HyperParameterTuningJobSearchEntity$TrainingJobDefinitions' => '

The job definitions included in a hyperparameter tuning job.

', ], ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$key' => NULL, ], ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$Environment' => '

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can\'t exceed the maximum number specified.

', ], ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$value' => NULL, ], ], 'HyperParameterTrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries' => '

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

', ], ], 'HyperParameterTrainingJobSummary' => [ 'base' => '

The container for the summary information about a training job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$BestTrainingJob' => '

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

', 'DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob' => '

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

', 'HyperParameterTrainingJobSummaries$member' => NULL, 'HyperParameterTuningJobSearchEntity$BestTrainingJob' => NULL, 'HyperParameterTuningJobSearchEntity$OverallBestTrainingJob' => NULL, ], ], 'HyperParameterTuningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$AllocationStrategy' => '

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

', ], ], 'HyperParameterTuningInstanceConfig' => [ 'base' => '

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

', 'refs' => [ 'HyperParameterTuningInstanceConfigs$member' => NULL, ], ], 'HyperParameterTuningInstanceConfigs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$InstanceConfigs' => '

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

', ], ], 'HyperParameterTuningJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'DescribeTrainingJobResponse$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'TrainingJob$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'TuningJobStepMetaData$Arn' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'HyperParameterTuningJobCompletionDetails' => [ 'base' => '

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails' => '

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

', 'HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails' => '

Information about either a current or completed hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobConfig' => [ 'base' => '

Configures a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig' => NULL, ], ], 'HyperParameterTuningJobConsumedResources' => [ 'base' => '

The total resources consumed by your hyperparameter tuning job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ConsumedResources' => NULL, 'HyperParameterTuningJobSearchEntity$ConsumedResources' => '

The total amount of resources consumed by a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobName' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

', 'DeleteHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job that you want to delete.

', 'DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job.

', 'HyperParameterTrainingJobSummary$TuningJobName' => '

The HyperParameter tuning job that launched the training job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName' => '

The name of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job whose training jobs you want to list.

', 'ParentHyperParameterTuningJob$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'StopHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job to stop.

', ], ], 'HyperParameterTuningJobObjective' => [ 'base' => '

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$TuningObjective' => NULL, 'HyperParameterTuningJobConfig$HyperParameterTuningJobObjective' => '

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

', 'HyperParameterTuningJobObjectives$member' => NULL, ], ], 'HyperParameterTuningJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$Type' => '

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

', 'HyperParameterTuningJobObjective$Type' => '

Whether to minimize or maximize the objective metric.

', ], ], 'HyperParameterTuningJobObjectives' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTuningJobObjectiveMetrics' => '

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'base' => '

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

', 'refs' => [ 'SearchRecord$HyperParameterTuningJob' => '

The properties of a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsRequest$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'HyperParameterTuningJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobStatus' => '

The status of the tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus' => '

The status of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobStatus' => '

The status of the tuning job.

', 'ListHyperParameterTuningJobsRequest$StatusEquals' => '

A filter that returns only tuning jobs with the specified status.

', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'base' => '

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

', 'refs' => [ 'HyperParameterTuningJobConfig$StrategyConfig' => '

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

', ], ], 'HyperParameterTuningJobStrategyType' => [ 'base' => '

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

', 'refs' => [ 'HyperParameterTuningJobConfig$Strategy' => '

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

', 'HyperParameterTuningJobSummary$Strategy' => '

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

', ], ], 'HyperParameterTuningJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries' => '

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

', ], ], 'HyperParameterTuningJobSummary' => [ 'base' => '

Provides summary information about a hyperparameter tuning job.

', 'refs' => [ 'HyperParameterTuningJobSummaries$member' => NULL, ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'base' => '

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$WarmStartConfig' => '

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'DescribeHyperParameterTuningJobResponse$WarmStartConfig' => '

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

', 'HyperParameterTuningJobSearchEntity$WarmStartConfig' => NULL, ], ], 'HyperParameterTuningJobWarmStartType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$WarmStartType' => '

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxRuntimeInSeconds' => '

The maximum time in seconds that a hyperparameter tuning job can run.

', ], ], 'HyperParameterTuningResourceConfig' => [ 'base' => '

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterTuningResourceConfig' => '

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

', ], ], 'HyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$DefaultValue' => '

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

', 'HyperParameters$value' => NULL, ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$HyperParameters' => '

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'DescribeTrainingJobResponse$HyperParameters' => '

Algorithm-specific parameters.

', 'HyperParameterTrainingJobDefinition$StaticHyperParameters' => '

Specifies the values of hyperparameters that do not change for the tuning job.

', 'HyperParameterTrainingJobSummary$TunedHyperParameters' => '

A list of the hyperparameters for which you specified ranges to search.

', 'TrainingJob$HyperParameters' => '

Algorithm-specific parameters.

', 'TrainingJobDefinition$HyperParameters' => '

The hyperparameters used for the training job.

', ], ], 'HyperbandStrategyConfig' => [ 'base' => '

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

', 'refs' => [ 'HyperParameterTuningJobStrategyConfig$HyperbandStrategyConfig' => '

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

', ], ], 'HyperbandStrategyMaxResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MaxResource' => '

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs

  • numepochs

  • n-epochs

  • n_epochs

  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

', ], ], 'HyperbandStrategyMinResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MinResource' => '

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

', ], ], 'IamIdentity' => [ 'base' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

', 'refs' => [ 'UserContext$IamIdentity' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'DeletePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'RetryPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'SendPipelineExecutionStepFailureRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'SendPipelineExecutionStepSuccessRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'StartPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'StopPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', ], ], 'IdentityProviderOAuthSetting' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

', 'refs' => [ 'IdentityProviderOAuthSettings$member' => NULL, ], ], 'IdentityProviderOAuthSettings' => [ 'base' => NULL, 'refs' => [ 'CanvasAppSettings$IdentityProviderOAuthSettings' => '

The settings for connecting to an external data source with OAuth.

', ], ], 'Image' => [ 'base' => '

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

', 'refs' => [ 'Images$member' => NULL, ], ], 'ImageArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageVersionResponse$ImageArn' => '

The ARN of the image the version is based on.

', 'Image$ImageArn' => '

The ARN of the image.

', 'ImageVersion$ImageArn' => '

The ARN of the image the version is based on.

', 'ResourceSpec$SageMakerImageArn' => '

The ARN of the SageMaker image that the image version belongs to.

', 'UpdateImageResponse$ImageArn' => '

The ARN of the image.

', ], ], 'ImageBaseImage' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$BaseImage' => '

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

', 'DescribeImageVersionResponse$BaseImage' => '

The registry path of the container image on which this image version is based.

', ], ], 'ImageClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the image classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$ImageClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the image classification problem type.

', ], ], 'ImageConfig' => [ 'base' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

', 'refs' => [ 'ContainerDefinition$ImageConfig' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', ], ], 'ImageContainerImage' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ContainerImage' => '

The registry path of the container image that contains this image version.

', ], ], 'ImageDeleteProperty' => [ 'base' => NULL, 'refs' => [ 'ImageDeletePropertyList$member' => NULL, ], ], 'ImageDeletePropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateImageRequest$DeleteProperties' => '

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

', ], ], 'ImageDescription' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$Description' => '

The description of the image.

', 'DescribeImageResponse$Description' => '

The description of the image.

', 'Image$Description' => '

The description of the image.

', 'UpdateImageRequest$Description' => '

The new description for the image.

', ], ], 'ImageDigest' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$ImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', 'TrainingSpecification$TrainingImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', ], ], 'ImageDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$DisplayName' => '

The display name of the image. If not provided, ImageName is displayed.

', 'DescribeImageResponse$DisplayName' => '

The name of the image as displayed.

', 'Image$DisplayName' => '

The name of the image as displayed.

', 'UpdateImageRequest$DisplayName' => '

The new display name for the image.

', ], ], 'ImageName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$ImageName' => '

The name of the image. Must be unique to your account.

', 'CreateImageVersionRequest$ImageName' => '

The ImageName of the Image to create a version of.

', 'CustomImage$ImageName' => '

The name of the CustomImage. Must be unique to your account.

', 'DeleteImageRequest$ImageName' => '

The name of the image to delete.

', 'DeleteImageVersionRequest$ImageName' => '

The name of the image to delete.

', 'DescribeImageRequest$ImageName' => '

The name of the image to describe.

', 'DescribeImageResponse$ImageName' => '

The name of the image.

', 'DescribeImageVersionRequest$ImageName' => '

The name of the image.

', 'Image$ImageName' => '

The name of the image.

', 'ListAliasesRequest$ImageName' => '

The name of the image.

', 'ListImageVersionsRequest$ImageName' => '

The name of the image to list the versions of.

', 'UpdateImageRequest$ImageName' => '

The name of the image to update.

', 'UpdateImageVersionRequest$ImageName' => '

The name of the image.

', ], ], 'ImageNameContains' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$NameContains' => '

A filter that returns only images whose name contains the specified string.

', ], ], 'ImageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageResponse$ImageStatus' => '

The status of the image.

', 'Image$ImageStatus' => '

The status of the image.

', ], ], 'ImageUri' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ImageUri' => '

The container image to be run by the processing job.

', 'DataQualityAppSpecification$ImageUri' => '

The container image that the data quality monitoring job runs.

', 'ModelBiasAppSpecification$ImageUri' => '

The container image to be run by the model bias job.

', 'ModelExplainabilityAppSpecification$ImageUri' => '

The container image to be run by the model explainability job.

', 'ModelQualityAppSpecification$ImageUri' => '

The address of the container image that the monitoring job runs.

', 'MonitoringAppSpecification$ImageUri' => '

The container image to be run by the monitoring job.

', ], ], 'ImageVersion' => [ 'base' => '

A version of a SageMaker Image. A version represents an existing container image.

', 'refs' => [ 'ImageVersions$member' => NULL, ], ], 'ImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$SageMakerImageVersionAlias' => '

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

', ], ], 'ImageVersionArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', 'DescribeImageVersionResponse$ImageVersionArn' => '

The ARN of the version.

', 'ImageVersion$ImageVersionArn' => '

The ARN of the version.

', 'ResourceSpec$SageMakerImageVersionArn' => '

The ARN of the image version created on the instance.

', 'UpdateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', ], ], 'ImageVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CustomImage$ImageVersionNumber' => '

The version number of the CustomImage.

', 'DeleteImageVersionRequest$Version' => '

The version to delete.

', 'DescribeImageVersionRequest$Version' => '

The version of the image. If not specified, the latest version is described.

', 'DescribeImageVersionResponse$Version' => '

The version number.

', 'ImageVersion$Version' => '

The version number.

', 'ListAliasesRequest$Version' => '

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

', 'UpdateImageVersionRequest$Version' => '

The version of the image.

', ], ], 'ImageVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageVersionSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ImageVersionStatus' => '

The status of the version.

', 'ImageVersion$ImageVersionStatus' => '

The status of the version.

', ], ], 'ImageVersions' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsResponse$ImageVersions' => '

A list of versions and their properties.

', ], ], 'Images' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$Images' => '

A list of images and their properties.

', ], ], 'ImportHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InferenceComponentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'InferenceComponentSummary$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentRuntimeConfigOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', ], ], 'InferenceComponentComputeResourceRequirements' => [ 'base' => '

Defines the compute resources to allocate to run a model that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

', 'refs' => [ 'InferenceComponentSpecification$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', 'InferenceComponentSpecificationSummary$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', ], ], 'InferenceComponentContainerSpecification' => [ 'base' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', 'refs' => [ 'InferenceComponentSpecification$Container' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'InferenceComponentSpecificationSummary$Container' => '

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

', ], ], 'InferenceComponentCopyCount' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentRuntimeConfig$CopyCount' => '

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

', 'InferenceComponentRuntimeConfigSummary$DesiredCopyCount' => '

The number of runtime copies of the model container that you requested to deploy with the inference component.

', 'InferenceComponentRuntimeConfigSummary$CurrentCopyCount' => '

The number of runtime copies of the model container that are currently deployed.

', ], ], 'InferenceComponentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$InferenceComponentName' => '

A unique name to assign to the inference component.

', 'DeleteInferenceComponentInput$InferenceComponentName' => '

The name of the inference component to delete.

', 'DescribeInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentName' => '

The name of the inference component.

', 'InferenceComponentSummary$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$InferenceComponentName' => '

The name of the inference component to update.

', ], ], 'InferenceComponentNameContains' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$NameContains' => '

Filters the results to only those inference components with a name that contains the specified string.

', ], ], 'InferenceComponentRuntimeConfig' => [ 'base' => '

Runtime settings for a model that is deployed with an inference component.

', 'refs' => [ 'CreateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$DesiredRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'base' => '

Details about the runtime settings for the model that is deployed with the inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$RuntimeConfig' => '

Details about the runtime settings for the model that is deployed with the inference component.

', ], ], 'InferenceComponentSortKey' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$SortBy' => '

The field by which to sort the inference components in the response. The default is CreationTime.

', ], ], 'InferenceComponentSpecification' => [ 'base' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'refs' => [ 'CreateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'UpdateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', ], ], 'InferenceComponentSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$Specification' => '

Details about the resources that are deployed with this inference component.

', ], ], 'InferenceComponentStartupParameters' => [ 'base' => '

Settings that take effect while the model container starts up.

', 'refs' => [ 'InferenceComponentSpecification$StartupParameters' => '

Settings that take effect while the model container starts up.

', 'InferenceComponentSpecificationSummary$StartupParameters' => '

Settings that take effect while the model container starts up.

', ], ], 'InferenceComponentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceComponentOutput$InferenceComponentStatus' => '

The status of the inference component.

', 'InferenceComponentSummary$InferenceComponentStatus' => '

The status of the inference component.

', 'ListInferenceComponentsInput$StatusEquals' => '

Filters the results to only those inference components with the specified status.

', ], ], 'InferenceComponentSummary' => [ 'base' => '

A summary of the properties of an inference component.

', 'refs' => [ 'InferenceComponentSummaryList$member' => NULL, ], ], 'InferenceComponentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsOutput$InferenceComponents' => '

A list of inference components and their properties that matches any of the filters you specified in the request.

', ], ], 'InferenceExecutionConfig' => [ 'base' => '

Specifies details about how containers in a multi-container endpoint are run.

', 'refs' => [ 'CreateModelInput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'DescribeModelOutput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'Model$InferenceExecutionConfig' => NULL, ], ], 'InferenceExecutionMode' => [ 'base' => NULL, 'refs' => [ 'InferenceExecutionConfig$Mode' => '

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.

  • DIRECT - Only the individual container that you specify is run.

', ], ], 'InferenceExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN for your inference experiment.

', 'DeleteInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the deleted inference experiment.

', 'DescribeInferenceExperimentResponse$Arn' => '

The ARN of the inference experiment being described.

', 'StartInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the started inference experiment to start.

', 'StopInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the stopped inference experiment.

', 'UpdateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the updated inference experiment.

', ], ], 'InferenceExperimentDataStorageConfig' => [ 'base' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'refs' => [ 'CreateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

', 'DescribeInferenceExperimentResponse$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'UpdateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', ], ], 'InferenceExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Description' => '

A description for the inference experiment.

', 'DescribeInferenceExperimentResponse$Description' => '

The description of the inference experiment.

', 'InferenceExperimentSummary$Description' => '

The description of the inference experiment.

', 'UpdateInferenceExperimentRequest$Description' => '

The description of the inference experiment.

', ], ], 'InferenceExperimentList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsResponse$InferenceExperiments' => '

List of inference experiments.

', ], ], 'InferenceExperimentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Name' => '

The name for the inference experiment.

', 'DeleteInferenceExperimentRequest$Name' => '

The name of the inference experiment you want to delete.

', 'DescribeInferenceExperimentRequest$Name' => '

The name of the inference experiment to describe.

', 'DescribeInferenceExperimentResponse$Name' => '

The name of the inference experiment.

', 'InferenceExperimentSummary$Name' => '

The name of the inference experiment.

', 'StartInferenceExperimentRequest$Name' => '

The name of the inference experiment to start.

', 'StopInferenceExperimentRequest$Name' => '

The name of the inference experiment to stop.

', 'UpdateInferenceExperimentRequest$Name' => '

The name of the inference experiment to be updated.

', ], ], 'InferenceExperimentSchedule' => [ 'base' => '

The start and end times of an inference experiment.

The maximum duration that you can set for an inference experiment is 30 days.

', 'refs' => [ 'CreateInferenceExperimentRequest$Schedule' => '

The duration for which you want the inference experiment to run. If you don\'t specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

', 'DescribeInferenceExperimentResponse$Schedule' => '

The duration for which the inference experiment ran or will run.

', 'InferenceExperimentSummary$Schedule' => '

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

', 'UpdateInferenceExperimentRequest$Schedule' => '

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

', ], ], 'InferenceExperimentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$Status' => '

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.

  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

  • Updating - When you make changes to your experiment, your experiment shows as updating.

  • Starting - Amazon SageMaker is beginning your experiment.

  • Running - Your experiment is in progress.

  • Stopping - Amazon SageMaker is stopping your experiment.

  • Completed - Your experiment has completed.

  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

', 'InferenceExperimentSummary$Status' => '

The status of the inference experiment.

', 'ListInferenceExperimentsRequest$StatusEquals' => '

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

', ], ], 'InferenceExperimentStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$StatusReason' => '

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

', 'InferenceExperimentSummary$StatusReason' => '

The error message for the inference experiment status result.

', 'StopInferenceExperimentRequest$Reason' => '

The reason for stopping the experiment.

', ], ], 'InferenceExperimentStopDesiredState' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$DesiredState' => '

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully

  • Cancelled: The experiment was canceled

', ], ], 'InferenceExperimentSummary' => [ 'base' => '

Lists a summary of properties of an inference experiment.

', 'refs' => [ 'InferenceExperimentList$member' => NULL, ], ], 'InferenceExperimentType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Type' => '

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

', 'DescribeInferenceExperimentResponse$Type' => '

The type of the inference experiment.

', 'InferenceExperimentSummary$Type' => '

The type of the inference experiment.

', 'ListInferenceExperimentsRequest$Type' => '

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

', ], ], 'InferenceImage' => [ 'base' => NULL, 'refs' => [ 'DescribeCompilationJobResponse$InferenceImage' => '

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

', ], ], 'InferenceMetrics' => [ 'base' => '

The metrics for an existing endpoint compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$Metrics' => '

The metrics for an existing endpoint.

', 'RecommendationJobInferenceBenchmark$EndpointMetrics' => NULL, ], ], 'InferenceRecommendation' => [ 'base' => '

A list of recommendations made by Amazon SageMaker Inference Recommender.

', 'refs' => [ 'InferenceRecommendations$member' => NULL, ], ], 'InferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$InferenceRecommendations' => '

The recommendations made by Inference Recommender.

', ], ], 'InferenceRecommendationsJob' => [ 'base' => '

A structure that contains a list of recommendation jobs.

', 'refs' => [ 'InferenceRecommendationsJobs$member' => NULL, ], ], 'InferenceRecommendationsJobStep' => [ 'base' => '

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

', 'refs' => [ 'InferenceRecommendationsJobSteps$member' => NULL, ], ], 'InferenceRecommendationsJobSteps' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobStepsResponse$Steps' => '

A list of all subtask details in Inference Recommender.

', ], ], 'InferenceRecommendationsJobs' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs' => '

The recommendations created from the Amazon SageMaker Inference Recommender job.

', ], ], 'InferenceSpecification' => [ 'base' => '

Defines how to perform inference generation after a training job is run.

', 'refs' => [ 'BatchDescribeModelPackageSummary$InferenceSpecification' => NULL, 'CreateAlgorithmInput$InferenceSpecification' => '

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

', 'CreateModelPackageInput$InferenceSpecification' => '

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

', 'DescribeAlgorithmOutput$InferenceSpecification' => '

Details about inference jobs that the algorithm runs.

', 'DescribeModelPackageOutput$InferenceSpecification' => '

Details about inference jobs that you can run with models based on this model package.

', 'ModelPackage$InferenceSpecification' => '

Defines how to perform inference generation after a training job is run.

', 'UpdateModelPackageInput$InferenceSpecification' => '

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

', ], ], 'InferenceSpecificationName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'EndpointInputConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'ModelConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', ], ], 'InfraCheckConfig' => [ 'base' => '

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

', 'refs' => [ 'CreateTrainingJobRequest$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', 'DescribeTrainingJobResponse$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', ], ], 'InitialInstanceCount' => [ 'base' => NULL, 'refs' => [ 'EndpointOutputConfiguration$InitialInstanceCount' => '

The number of instances recommended to launch initially.

', ], ], 'InitialNumberOfUsers' => [ 'base' => NULL, 'refs' => [ 'Phase$InitialNumberOfUsers' => '

Specifies how many concurrent users to start with. The value should be between 1 and 3.

', ], ], 'InitialTaskCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$InitialInstanceCount' => '

Number of instances to launch initially.

', ], ], 'InputConfig' => [ 'base' => '

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'refs' => [ 'CreateCompilationJobRequest$InputConfig' => '

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'DescribeCompilationJobResponse$InputConfig' => '

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', ], ], 'InputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$InputDataConfig' => '

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

Your input must be in the same Amazon Web Services region as your training job.

', 'DescribeTrainingJobResponse$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

', 'HyperParameterTrainingJobDefinition$InputDataConfig' => '

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

', 'TrainingJob$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

Your input must be in the same Amazon Web Services region as your training job.

', 'TrainingJobDefinition$InputDataConfig' => '

An array of Channel objects, each of which specifies an input source.

', ], ], 'InputMode' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$InputMode' => '

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InputModes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedInputModes' => '

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InstanceGroup' => [ 'base' => '

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

', 'refs' => [ 'InstanceGroups$member' => NULL, ], ], 'InstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupName' => '

Specifies the name of the instance group.

', 'InstanceGroupNames$member' => NULL, ], ], 'InstanceGroupNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$InstanceGroupNames' => '

A list of names of instance groups that get data from the S3 data source.

', ], ], 'InstanceGroups' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$InstanceGroups' => '

The configuration of a heterogeneous cluster in JSON format.

', ], ], 'InstanceMetadataServiceConfiguration' => [ 'base' => '

Information on the IMDS configuration of the notebook instance

', 'refs' => [ 'CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$InstanceType' => '

The type of ML compute instance to launch for the notebook instance.

', 'DescribeNotebookInstanceOutput$InstanceType' => '

The type of ML compute instance running on the notebook instance.

', 'NotebookInstanceSummary$InstanceType' => '

The type of ML compute instance that the notebook instance is running on.

', 'RealTimeInferenceConfig$InstanceType' => '

The instance type the model is deployed to.

', 'UpdateNotebookInstanceInput$InstanceType' => '

The Amazon ML compute instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardVersion' => '

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

', 'DescribeDeviceResponse$MaxModels' => '

The maximum number of models.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending' => '

The number of edge devices yet to pick up deployment, or in progress.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'DescribeModelCardExportJobResponse$ModelCardVersion' => '

The version of the model card that the model export job exports.

', 'DescribeModelCardRequest$ModelCardVersion' => '

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

', 'DescribeModelCardResponse$ModelCardVersion' => '

The version of the model card.

', 'DynamicScalingConfiguration$MinCapacity' => '

The recommended minimum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$MaxCapacity' => '

The recommended maximum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleInCooldown' => '

The recommended scale in cooldown time for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleOutCooldown' => '

The recommended scale out cooldown time for your autoscaling policy.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPending' => '

The number of edge devices yet to pick up the deployment, or in progress.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'EdgeDeploymentStatus$EdgeDeploymentSuccessInStage' => '

The number of edge devices with the successful deployment in the current stage.

', 'EdgeDeploymentStatus$EdgeDeploymentPendingInStage' => '

The number of edge devices yet to pick up the deployment in current stage, or in progress.

', 'EdgeDeploymentStatus$EdgeDeploymentFailedInStage' => '

The number of edge devices that failed the deployment in current stage.

', 'HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving' => '

The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.

', 'HyperParameterTuningJobConsumedResources$RuntimeInSeconds' => '

The wall clock runtime in seconds used by your hyperparameter tuning job.

', 'InferenceMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'InferenceMetrics$ModelLatency' => '

The expected model latency at maximum invocations per minute for the instance.

', 'ListModelCardExportJobsRequest$ModelCardVersion' => '

List export jobs for the model card with the specified version.

', 'ModelCard$ModelCardVersion' => '

The version of the model card.

', 'ModelCardExportJobSummary$ModelCardVersion' => '

The version of the model card that the export job exports.

', 'ModelCardVersionSummary$ModelCardVersion' => '

A version of the model card.

', 'ModelDashboardModelCard$ModelCardVersion' => '

The model card version.

', 'ModelLatencyThreshold$ValueInMilliseconds' => '

The model latency percentile value in milliseconds.

', 'PipelineExecutionStep$AttemptCount' => '

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

', 'RecommendationJobStoppingConditions$MaxInvocations' => '

The maximum number of requests per minute expected for the endpoint.

', 'RecommendationMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'RecommendationMetrics$ModelLatency' => '

The expected model latency at maximum invocation per minute for the instance.

', 'ScalingPolicyMetric$InvocationsPerInstance' => '

The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.

', 'ScalingPolicyMetric$ModelLatency' => '

The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', 'ScalingPolicyObjective$MinInvocationsPerMinute' => '

The minimum number of expected requests to your endpoint per minute.

', 'ScalingPolicyObjective$MaxInvocationsPerMinute' => '

The maximum number of expected requests to your endpoint per minute.

', ], ], 'IntegerParameterRange' => [ 'base' => '

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

', 'refs' => [ 'IntegerParameterRanges$member' => NULL, ], ], 'IntegerParameterRangeSpecification' => [ 'base' => '

Defines the possible values for an integer hyperparameter.

', 'refs' => [ 'ParameterRange$IntegerParameterRangeSpecification' => '

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

', ], ], 'IntegerParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$IntegerParameterRanges' => '

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

', ], ], 'InvocationEndTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', 'RecommendationJobInferenceBenchmark$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', ], ], 'InvocationStartTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', 'RecommendationJobInferenceBenchmark$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', ], ], 'InvocationsMaxRetries' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsMaxRetries' => '

The maximum number of retries when invocation requests are failing. The default value is 3.

', ], ], 'InvocationsTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsTimeoutInSeconds' => '

The timeout value in seconds for an invocation request. The default value is 600.

', ], ], 'IotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$IotRoleAlias' => '

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

', ], ], 'ItemIdentifierAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$ItemIdentifierAttributeName' => '

The name of the column that represents the set of item identifiers for which you want to predict the target value.

', ], ], 'JobDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$JobDurationInSeconds' => '

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

', ], ], 'JobReferenceCode' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$JobReferenceCode' => '

A unique identifier for work done as part of a labeling job.

', 'LabelingJobForWorkteamSummary$JobReferenceCode' => '

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

', ], ], 'JobReferenceCodeContains' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains' => '

A filter the limits jobs to only the ones whose job reference code contains the specified string.

', ], ], 'JobType' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'DescribeImageVersionResponse$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'UpdateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', ], ], 'JoinSource' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$JoinSource' => '

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

', ], ], 'JsonContentType' => [ 'base' => NULL, 'refs' => [ 'JsonContentTypes$member' => NULL, ], ], 'JsonContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$JsonContentTypes' => '

The list of all content type headers that SageMaker will treat as JSON and capture accordingly.

', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$InputFilter' => '

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: "$", "$[1:]", "$.features"

', 'DataProcessing$OutputFilter' => '

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren\'t within the dimension size of the joined dataset, you get an error.

Examples: "$", "$[0,5:]", "$[\'id\',\'SageMakerOutput\']"

', ], ], 'JupyterLabAppImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app. The FileSystemConfig object is not supported.

', 'refs' => [ 'AppImageConfigDetails$JupyterLabAppImageConfig' => '

The configuration for the file system and the runtime, such as the environment variables and entry point.

', 'CreateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$JupyterLabAppImageConfig' => '

The configuration of the JupyterLab app.

', 'UpdateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLab app running on the image.

', ], ], 'JupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application.

', 'refs' => [ 'DefaultSpaceSettings$JupyterLabAppSettings' => NULL, 'UserSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'JupyterServerAppSettings' => [ 'base' => '

The JupyterServer app settings.

', 'refs' => [ 'DefaultSpaceSettings$JupyterServerAppSettings' => NULL, 'SpaceSettings$JupyterServerAppSettings' => NULL, 'UserSettings$JupyterServerAppSettings' => '

The Jupyter server\'s app settings.

', ], ], 'KeepAlivePeriodInSeconds' => [ 'base' => 'Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.', 'refs' => [ 'ResourceConfig$KeepAlivePeriodInSeconds' => '

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

', 'ResourceConfigForUpdate$KeepAlivePeriodInSeconds' => '

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

', ], ], 'KendraSettings' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure document querying.

', 'refs' => [ 'CanvasAppSettings$KendraSettings' => '

The settings for document querying.

', ], ], 'KernelDisplayName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$DisplayName' => '

The display name of the kernel.

', ], ], 'KernelGatewayAppSettings' => [ 'base' => '

The KernelGateway app settings.

', 'refs' => [ 'DefaultSpaceSettings$KernelGatewayAppSettings' => NULL, 'SpaceSettings$KernelGatewayAppSettings' => NULL, 'UserSettings$KernelGatewayAppSettings' => '

The kernel gateway app settings.

', ], ], 'KernelGatewayImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

', 'refs' => [ 'AppImageConfigDetails$KernelGatewayImageConfig' => '

The configuration for the file system and kernels in the SageMaker image.

', 'CreateAppImageConfigRequest$KernelGatewayImageConfig' => '

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$KernelGatewayImageConfig' => '

The configuration of a KernelGateway app.

', 'UpdateAppImageConfigRequest$KernelGatewayImageConfig' => '

The new KernelGateway app to run on the image.

', ], ], 'KernelName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$Name' => '

The name of the Jupyter kernel in the image. This value is case sensitive.

', ], ], 'KernelSpec' => [ 'base' => '

The specification of a Jupyter kernel.

', 'refs' => [ 'KernelSpecs$member' => NULL, ], ], 'KernelSpecs' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayImageConfig$KernelSpecs' => '

The specification of the Jupyter kernels in the image.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$ObjectKey' => '

The object key (or key name) uniquely identifies the object in an S3 bucket.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

', 'AthenaDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

', 'AutoMLOutputDataConfig$KmsKeyId' => '

The Key Management Service encryption key ID.

', 'AutoMLSecurityConfig$VolumeKmsKeyId' => '

The key used to encrypt stored data.

', 'BatchDataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'CreateDomainRequest$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'CreateDomainRequest$KmsKeyId' => '

SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

', 'CreateEdgePackagingJobRequest$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

', 'CreateEndpointConfigInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'CreateInferenceExperimentRequest$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS key Alias

    "alias/ExampleAlias"

  • Amazon Resource Name (ARN) of a KMS key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'CreateNotebookInstanceInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

', 'DataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'DataCaptureConfigSummary$KmsKeyId' => '

The KMS key being used to encrypt the data in Amazon S3.

', 'DescribeDomainResponse$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'DescribeDomainResponse$KmsKeyId' => '

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

', 'DescribeEdgePackagingJobResponse$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

', 'DescribeEndpointConfigOutput$KmsKeyId' => '

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'DescribeInferenceExperimentResponse$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

', 'DescribeNotebookInstanceOutput$KmsKeyId' => '

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'EdgeOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account.

', 'FlowDefinitionOutputConfig$KmsKeyId' => '

The Amazon Key Management Service (KMS) key ID for server-side encryption.

', 'HyperParameterTuningResourceConfig$VolumeKmsKeyId' => '

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

"1234abcd-12ab-34cd-56ef-1234567890ab"

Amazon Resource Name (ARN) of a KMS key:

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

', 'InferenceExperimentDataStorageConfig$KmsKey' => '

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

', 'LabelingJobOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role\'s account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

', 'LabelingJobResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'ModelCardSecurityConfig$KmsKeyId' => '

A Key Management Service key ID to use for encrypting a model card.

', 'MonitoringClusterConfig$VolumeKmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

', 'MonitoringOutputConfig$KmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

', 'OnlineStoreSecurityConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • "kms:Encrypt"

  • "kms:Decrypt"

  • "kms:DescribeKey"

  • "kms:CreateGrant"

  • "kms:RetireGrant"

  • "kms:ReEncryptFrom"

  • "kms:ReEncryptTo"

  • "kms:GenerateDataKey"

  • "kms:ListAliases"

  • "kms:ListGrants"

  • "kms:RevokeGrant"

The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • "kms:Decrypt"

', 'OutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'OutputDataConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'ProcessingClusterConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'ProcessingOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

', 'ProductionVariantCoreDumpConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'RecommendationJobInputConfig$VolumeKmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RecommendationJobOutputConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RedshiftDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

', 'ResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'S3StorageConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • "kms:GenerateDataKey"

', 'SharingSettings$S3KmsKeyId' => '

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

', 'TransformOutput$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'TransformResources$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'WorkspaceSettings$S3KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

', ], ], 'LabelAttributeName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelAttributeName' => '

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can\'t end with "-metadata".

  • If you are using one of the following built-in task types, the attribute name must end with "-ref". If the task type you are using is not listed below, the attribute name must not end with "-ref".

    • Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

', 'DescribeLabelingJobResponse$LabelAttributeName' => '

The attribute used as the label in the output manifest file.

', ], ], 'LabelCounter' => [ 'base' => NULL, 'refs' => [ 'LabelCounters$TotalLabeled' => '

The total number of objects labeled.

', 'LabelCounters$HumanLabeled' => '

The total number of objects labeled by a human worker.

', 'LabelCounters$MachineLabeled' => '

The total number of objects labeled by automated data labeling.

', 'LabelCounters$FailedNonRetryableError' => '

The total number of objects that could not be labeled due to an error.

', 'LabelCounters$Unlabeled' => '

The total number of objects not yet labeled.

', 'LabelCountersForWorkteam$HumanLabeled' => '

The total number of data objects labeled by a human worker.

', 'LabelCountersForWorkteam$PendingHuman' => '

The total number of data objects that need to be labeled by a human worker.

', 'LabelCountersForWorkteam$Total' => '

The total number of tasks in the labeling job.

', ], ], 'LabelCounters' => [ 'base' => '

Provides a breakdown of the number of objects labeled.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelCounters' => '

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn\'t be labeled, and the total number of objects labeled.

', 'LabelingJobSummary$LabelCounters' => '

Counts showing the progress of the labeling job.

', ], ], 'LabelCountersForWorkteam' => [ 'base' => '

Provides counts for human-labeled tasks in the labeling job.

', 'refs' => [ 'LabelingJobForWorkteamSummary$LabelCounters' => '

Provides information about the progress of a labeling job.

', ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'base' => NULL, 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn' => '

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

', ], ], 'LabelingJobAlgorithmsConfig' => [ 'base' => '

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

', 'refs' => [ 'CreateLabelingJobRequest$LabelingJobAlgorithmsConfig' => '

Configures the information required to perform automated data labeling.

', 'DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig' => '

Configuration information for automated data labeling.

', ], ], 'LabelingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

', 'DescribeLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'DescribeTrainingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

', 'DescribeTransformJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

', 'LabelingJobSummary$LabelingJobArn' => '

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

', 'TrainingJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'TransformJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

', ], ], 'LabelingJobDataAttributes' => [ 'base' => '

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

', 'refs' => [ 'LabelingJobInputConfig$DataAttributes' => '

Attributes of the data specified by the customer.

', ], ], 'LabelingJobDataSource' => [ 'base' => '

Provides information about the location of input data.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

', 'refs' => [ 'LabelingJobInputConfig$DataSource' => '

The location of the input data.

', ], ], 'LabelingJobForWorkteamSummary' => [ 'base' => '

Provides summary information for a work team.

', 'refs' => [ 'LabelingJobForWorkteamSummaryList$member' => NULL, ], ], 'LabelingJobForWorkteamSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LabelingJobInputConfig' => [ 'base' => '

Input configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$InputConfig' => '

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.

  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

', 'DescribeLabelingJobResponse$InputConfig' => '

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

', 'LabelingJobSummary$InputConfig' => '

Input configuration for the labeling job.

', ], ], 'LabelingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelingJobName' => '

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

', 'DescribeLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to return information for.

', 'DescribeLabelingJobResponse$LabelingJobName' => '

The name assigned to the labeling job when it was created.

', 'LabelingJobForWorkteamSummary$LabelingJobName' => '

The name of the labeling job that the work team is assigned to.

', 'LabelingJobSummary$LabelingJobName' => '

The name of the labeling job.

', 'StopLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to stop.

', ], ], 'LabelingJobOutput' => [ 'base' => '

Specifies the location of the output produced by the labeling job.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', 'LabelingJobSummary$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', ], ], 'LabelingJobOutputConfig' => [ 'base' => '

Output configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$OutputConfig' => '

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', 'DescribeLabelingJobResponse$OutputConfig' => '

The location of the job\'s output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', ], ], 'LabelingJobResourceConfig' => [ 'base' => '

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

', 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobResourceConfig' => '

Provides configuration information for a labeling job.

', ], ], 'LabelingJobS3DataSource' => [ 'base' => '

The Amazon S3 location of the input data objects.

', 'refs' => [ 'LabelingJobDataSource$S3DataSource' => '

The Amazon S3 location of the input data objects.

', ], ], 'LabelingJobSnsDataSource' => [ 'base' => '

An Amazon SNS data source used for streaming labeling jobs.

', 'refs' => [ 'LabelingJobDataSource$SnsDataSource' => '

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

', ], ], 'LabelingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobStatus' => '

The processing status of the labeling job.

', 'LabelingJobSummary$LabelingJobStatus' => '

The current status of the labeling job.

', 'ListLabelingJobsRequest$StatusEquals' => '

A filter that retrieves only labeling jobs with a specific status.

', ], ], 'LabelingJobStoppingConditions' => [ 'base' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Labeling jobs fail after 30 days with an appropriate client error message.

', 'refs' => [ 'CreateLabelingJobRequest$StoppingConditions' => '

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

', 'DescribeLabelingJobResponse$StoppingConditions' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

', ], ], 'LabelingJobSummary' => [ 'base' => '

Provides summary information about a labeling job.

', 'refs' => [ 'LabelingJobSummaryList$member' => NULL, ], ], 'LabelingJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'AnnotationConsolidationConfig$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

', 'HumanTaskConfig$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

', 'LabelingJobSummary$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

', 'LabelingJobSummary$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

', ], ], 'LambdaStepMetadata' => [ 'base' => '

Metadata for a Lambda step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Lambda' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

', ], ], 'LandingUri' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$LandingUri' => '

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

  • studio::relative/path: Directs users to the relative path in Studio.

  • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

  • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

  • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

  • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

  • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

', 'UserSettings$DefaultLandingUri' => '

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$LastModifiedTime' => '

The date and time that the Git repository was last modified.

', 'CompilationJobSummary$LastModifiedTime' => '

The time when the model compilation job was last modified.

', 'DescribeCodeRepositoryOutput$LastModifiedTime' => '

The date and time that the repository was last changed.

', 'DescribeCompilationJobResponse$LastModifiedTime' => '

The time that the status of the model compilation job was last modified.

', 'DescribeDomainResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeFeatureGroupResponse$LastModifiedTime' => '

A timestamp indicating when the feature group was last updated.

', 'DescribeFeatureMetadataResponse$LastModifiedTime' => '

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

', 'DescribeInferenceRecommendationsJobResponse$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'DescribeNotebookInstanceOutput$LastModifiedTime' => '

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

', 'DescribeSpaceResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeUserProfileResponse$LastModifiedTime' => '

The last modified time.

', 'DomainDetails$LastModifiedTime' => '

The last modified time.

', 'FeatureGroup$LastModifiedTime' => '

A timestamp indicating the last time you updated the feature group.

', 'FeatureMetadata$LastModifiedTime' => '

A timestamp indicating when the feature was last modified.

', 'InferenceRecommendationsJob$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'ListCompilationJobsRequest$LastModifiedTimeAfter' => '

A filter that returns the model compilation jobs that were modified after a specified time.

', 'ListCompilationJobsRequest$LastModifiedTimeBefore' => '

A filter that returns the model compilation jobs that were modified before a specified time.

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs that were last modified after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs that were last modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore' => '

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter' => '

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeBefore' => '

A filter that returns only notebook instances that were modified before the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeAfter' => '

A filter that returns only notebook instances that were modified after the specified time (timestamp).

', 'NotebookInstanceLifecycleConfigSummary$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'NotebookInstanceSummary$LastModifiedTime' => '

A timestamp that shows when the notebook instance was last modified.

', 'SpaceDetails$LastModifiedTime' => '

The last modified time.

', 'UserProfileDetails$LastModifiedTime' => '

The last modified time.

', ], ], 'LastUpdateStatus' => [ 'base' => '

A value that indicates whether the update was successful.

', 'refs' => [ 'DescribeFeatureGroupResponse$LastUpdateStatus' => '

A value indicating whether the update made to the feature group was successful.

', 'FeatureGroup$LastUpdateStatus' => '

A value that indicates whether the feature group was updated successfully.

', ], ], 'LastUpdateStatusValue' => [ 'base' => NULL, 'refs' => [ 'LastUpdateStatus$Status' => '

A value that indicates whether the update was made successful.

', ], ], 'LifecycleConfigArns' => [ 'base' => NULL, 'refs' => [ 'CodeEditorAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

', 'JupyterLabAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

', 'JupyterServerAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', 'KernelGatewayAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', ], ], 'LineageEntityParameters' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Properties' => '

A list of properties to add to the action.

', 'CreateContextRequest$Properties' => '

A list of properties to add to the context.

', 'DescribeActionResponse$Properties' => '

A list of the action\'s properties.

', 'DescribeArtifactResponse$Properties' => '

A list of the artifact\'s properties.

', 'DescribeContextResponse$Properties' => '

A list of the context\'s properties.

', 'UpdateActionRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', 'UpdateContextRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'LineageGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeArtifactResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeContextResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeTrialComponentResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'GetLineageGroupPolicyResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', 'TrialComponent$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', ], ], 'LineageGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyRequest$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', ], ], 'LineageGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsResponse$LineageGroupSummaries' => '

A list of lineage groups and their properties.

', ], ], 'LineageGroupSummary' => [ 'base' => '

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

', 'refs' => [ 'LineageGroupSummaries$member' => NULL, ], ], 'LineageType' => [ 'base' => NULL, 'refs' => [ 'QueryLineageTypes$member' => NULL, 'Vertex$LineageType' => '

The type of resource of the lineage entity.

', ], ], 'ListActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsRequest$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ListContextsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContextsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$SortBy' => '

The column to sort by.

', ], ], 'ListDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansRequest$SortBy' => '

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

', ], ], 'ListEdgePackagingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsRequest$SortBy' => '

Use to specify what column to sort by.

', ], ], 'ListEndpointConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsRequest$SortBy' => '

The parameter by which to sort the results.

', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ListLabelingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageEntityParameterKey' => [ 'base' => NULL, 'refs' => [ 'UpdateActionRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateArtifactRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateContextRequest$PropertiesToRemove' => '

A list of properties to remove.

', ], ], 'ListLineageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListDevicesRequest$MaxResults' => '

Maximum number of results to select.

', 'ListEdgeDeploymentPlansRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', 'ListEdgePackagingJobsRequest$MaxResults' => '

Maximum number of results to select.

', 'ListStageDevicesRequest$MaxResults' => '

The maximum number of requests to select.

', ], ], 'ListModelBiasJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelBiasJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsInput$MaxResults' => '

Maximum number of tags to return.

', ], ], 'ListTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'UpdateTrialComponentRequest$ParametersToRemove' => '

The hyperparameters to remove from the component.

', 'UpdateTrialComponentRequest$InputArtifactsToRemove' => '

The input artifacts to remove from the component.

', 'UpdateTrialComponentRequest$OutputArtifactsToRemove' => '

The output artifacts to remove from the component.

', ], ], 'ListTrialComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesRequest$SortBy' => '

Sort workforces using the workforce name or creation date.

', ], ], 'ListWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$AgentCount' => '

The number of Edge Manager agents.

', 'DeviceStats$ConnectedDeviceCount' => '

The number of devices connected with a heartbeat.

', 'DeviceStats$RegisteredDeviceCount' => '

The number of registered devices.

', 'EdgeModelStat$OfflineDeviceCount' => '

The number of devices that have this model version and do not have a heart beat.

', 'EdgeModelStat$ConnectedDeviceCount' => '

The number of devices that have this model version and have a heart beat.

', 'EdgeModelStat$ActiveDeviceCount' => '

The number of devices that have this model version, a heart beat, and are currently running.

', 'EdgeModelStat$SamplingDeviceCount' => '

The number of devices with this model version and are producing sample data.

', ], ], 'MLFramework' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', 'DescribeImageVersionResponse$MLFramework' => '

The machine learning framework vended in the image version.

', 'UpdateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', ], ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MaxInstanceCount' => '

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

', ], ], 'ManagedInstanceScalingMinInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MinInstanceCount' => '

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

', ], ], 'ManagedInstanceScalingStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$Status' => '

Indicates whether managed instance scaling is enabled.

', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds' => '

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

', ], ], 'MaxCandidates' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxCandidates' => '

The maximum number of times a training job is allowed to run.

For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

', ], ], 'MaxConcurrentInvocationsPerInstance' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance' => '

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

', ], ], 'MaxConcurrentTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$MaxConcurrentTaskCount' => '

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

', ], ], 'MaxConcurrentTransforms' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'DescribeTransformJobResponse$MaxConcurrentTransforms' => '

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

', 'TransformJob$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'TransformJobDefinition$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

', ], ], 'MaxHumanLabeledObjectCount' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxHumanLabeledObjectCount' => '

The maximum number of objects that can be labeled by human workers.

', ], ], 'MaxNumberOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxNumberOfTests' => '

Defines the maximum number of load tests.

', ], ], 'MaxNumberOfTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxNumberOfTrainingJobs' => '

The maximum number of training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'base' => NULL, 'refs' => [ 'BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving' => '

The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.

', ], ], 'MaxParallelExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$MaxParallelExecutionSteps' => '

The max number of steps that can be executed in parallel.

', ], ], 'MaxParallelOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxParallelOfTests' => '

Defines the maximum number of parallel load tests.

', ], ], 'MaxParallelTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxParallelTrainingJobs' => '

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'DescribeTransformJobResponse$MaxPayloadInMB' => '

The maximum payload size, in MB, used in the transform job.

', 'TransformJob$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'TransformJobDefinition$MaxPayloadInMB' => '

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

', ], ], 'MaxPendingTimeInSeconds' => [ 'base' => 'Maximum job scheduler pending time in seconds.', 'refs' => [ 'StoppingCondition$MaxPendingTimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

', ], ], 'MaxPercentageOfInputDatasetLabeled' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled' => '

The maximum number of input data objects that should be labeled.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$MaxResults' => '

The maximum number of actions to return in the response. The default value is 10.

', 'ListAlgorithmsInput$MaxResults' => '

The maximum number of algorithms to return in the response.

', 'ListAliasesRequest$MaxResults' => '

The maximum number of aliases to return.

', 'ListAppImageConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListAppsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListArtifactsRequest$MaxResults' => '

The maximum number of artifacts to return in the response. The default value is 10.

', 'ListAssociationsRequest$MaxResults' => '

The maximum number of associations to return in the response. The default value is 10.

', 'ListClusterNodesRequest$MaxResults' => '

The maximum number of nodes to return in the response.

', 'ListClustersRequest$MaxResults' => '

Set the maximum number of SageMaker HyperPod clusters to list.

', 'ListCodeRepositoriesInput$MaxResults' => '

The maximum number of Git repositories to return in the response.

', 'ListCompilationJobsRequest$MaxResults' => '

The maximum number of model compilation jobs to return in the response.

', 'ListContextsRequest$MaxResults' => '

The maximum number of contexts to return in the response. The default value is 10.

', 'ListDataQualityJobDefinitionsRequest$MaxResults' => '

The maximum number of data quality monitoring job definitions to return in the response.

', 'ListDomainsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListEndpointConfigsInput$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListEndpointsInput$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListExperimentsRequest$MaxResults' => '

The maximum number of experiments to return in the response. The default value is 10.

', 'ListFlowDefinitionsRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHubContentVersionsRequest$MaxResults' => '

The maximum number of hub content versions to list.

', 'ListHubContentsRequest$MaxResults' => '

The maximum amount of hub content to list.

', 'ListHubsRequest$MaxResults' => '

The maximum number of hubs to list.

', 'ListHumanTaskUisRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHyperParameterTuningJobsRequest$MaxResults' => '

The maximum number of tuning jobs to return. The default value is 10.

', 'ListImageVersionsRequest$MaxResults' => '

The maximum number of versions to return in the response. The default value is 10.

', 'ListImagesRequest$MaxResults' => '

The maximum number of images to return in the response. The default value is 10.

', 'ListInferenceComponentsInput$MaxResults' => '

The maximum number of inference components to return in the response. This value defaults to 10.

', 'ListInferenceExperimentsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListInferenceRecommendationsJobStepsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListInferenceRecommendationsJobsRequest$MaxResults' => '

The maximum number of recommendations to return in the response.

', 'ListLabelingJobsForWorkteamRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLabelingJobsRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLineageGroupsRequest$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListModelBiasJobDefinitionsRequest$MaxResults' => '

The maximum number of model bias jobs to return in the response. The default value is 10.

', 'ListModelCardExportJobsRequest$MaxResults' => '

The maximum number of model card export jobs to list.

', 'ListModelCardVersionsRequest$MaxResults' => '

The maximum number of model card versions to list.

', 'ListModelCardsRequest$MaxResults' => '

The maximum number of model cards to list.

', 'ListModelExplainabilityJobDefinitionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListModelMetadataRequest$MaxResults' => '

The maximum number of models to return in the response.

', 'ListModelPackageGroupsInput$MaxResults' => '

The maximum number of results to return in the response.

', 'ListModelPackagesInput$MaxResults' => '

The maximum number of model packages to return in the response.

', 'ListModelQualityJobDefinitionsRequest$MaxResults' => '

The maximum number of results to return in a call to ListModelQualityJobDefinitions.

', 'ListModelsInput$MaxResults' => '

The maximum number of models to return in the response.

', 'ListMonitoringAlertHistoryRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringAlertsRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringExecutionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListMonitoringSchedulesRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListNotebookInstanceLifecycleConfigsInput$MaxResults' => '

The maximum number of lifecycle configurations to return in the response.

', 'ListNotebookInstancesInput$MaxResults' => '

The maximum number of notebook instances to return.

', 'ListPipelineExecutionStepsRequest$MaxResults' => '

The maximum number of pipeline execution steps to return in the response.

', 'ListPipelineExecutionsRequest$MaxResults' => '

The maximum number of pipeline executions to return in the response.

', 'ListPipelineParametersForExecutionRequest$MaxResults' => '

The maximum number of parameters to return in the response.

', 'ListPipelinesRequest$MaxResults' => '

The maximum number of pipelines to return in the response.

', 'ListProcessingJobsRequest$MaxResults' => '

The maximum number of processing jobs to return in the response.

', 'ListProjectsInput$MaxResults' => '

The maximum number of projects to return in the response.

', 'ListResourceCatalogsRequest$MaxResults' => '

The maximum number of results returned by ListResourceCatalogs.

', 'ListSpacesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListStudioLifecycleConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListSubscribedWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults' => '

The maximum number of training jobs to return. The default value is 10.

', 'ListTrainingJobsRequest$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListTransformJobsRequest$MaxResults' => '

The maximum number of transform jobs to return in the response. The default value is 10.

', 'ListTrialComponentsRequest$MaxResults' => '

The maximum number of components to return in the response. The default value is 10.

', 'ListTrialsRequest$MaxResults' => '

The maximum number of trials to return in the response. The default value is 10.

', 'ListUserProfilesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListWorkforcesRequest$MaxResults' => '

The maximum number of workforces returned in the response.

', 'ListWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'SearchRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'MaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxRuntimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

', ], ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds' => '

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

', ], ], 'MaxWaitTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxWaitTimeInSeconds' => '

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

', ], ], 'MaximumExecutionTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

', 'RollingUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

The time limit for the total deployment. Exceeding this limit causes a timeout.

', ], ], 'MaximumRetryAttempts' => [ 'base' => NULL, 'refs' => [ 'RetryStrategy$MaximumRetryAttempts' => '

The number of times to retry the job. When the job is retried, it\'s SecondaryStatus is changed to STARTING.

', ], ], 'MediaType' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$MediaType' => '

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

', ], ], 'MemberDefinition' => [ 'base' => '

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

', 'refs' => [ 'MemberDefinitions$member' => NULL, ], ], 'MemberDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

', 'UpdateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

', 'Workteam$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

', ], ], 'MemoryInMb' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$MinMemoryRequiredInMb' => '

The minimum MB of memory to allocate to run a model that you assign to an inference component.

', 'InferenceComponentComputeResourceRequirements$MaxMemoryRequiredInMb' => '

The maximum MB of memory to allocate to run a model that you assign to an inference component.

', ], ], 'MetadataProperties' => [ 'base' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'refs' => [ 'CreateActionRequest$MetadataProperties' => NULL, 'CreateArtifactRequest$MetadataProperties' => NULL, 'CreateModelPackageInput$MetadataProperties' => NULL, 'CreateTrialComponentRequest$MetadataProperties' => NULL, 'CreateTrialRequest$MetadataProperties' => NULL, 'DescribeActionResponse$MetadataProperties' => NULL, 'DescribeArtifactResponse$MetadataProperties' => NULL, 'DescribeModelPackageOutput$MetadataProperties' => NULL, 'DescribeTrialComponentResponse$MetadataProperties' => NULL, 'DescribeTrialResponse$MetadataProperties' => NULL, 'ModelPackage$MetadataProperties' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'Trial$MetadataProperties' => NULL, 'TrialComponent$MetadataProperties' => NULL, ], ], 'MetadataPropertyValue' => [ 'base' => NULL, 'refs' => [ 'MetadataProperties$CommitId' => '

The commit ID.

', 'MetadataProperties$Repository' => '

The repository.

', 'MetadataProperties$GeneratedBy' => '

The entity this entity was generated by.

', 'MetadataProperties$ProjectId' => '

The project ID.

', ], ], 'MetricData' => [ 'base' => '

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

', 'refs' => [ 'FinalMetricDataList$member' => NULL, ], ], 'MetricDataList' => [ 'base' => NULL, 'refs' => [ 'CandidateProperties$CandidateMetrics' => '

Information about the candidate metrics for an AutoML job.

', ], ], 'MetricDatum' => [ 'base' => '

Information about the metric for a candidate produced by an AutoML job.

', 'refs' => [ 'MetricDataList$member' => NULL, ], ], 'MetricDefinition' => [ 'base' => '

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

', 'refs' => [ 'MetricDefinitionList$member' => NULL, ], ], 'MetricDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$MetricDefinitions' => '

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

', 'HyperParameterAlgorithmSpecification$MetricDefinitions' => '

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

', 'TrainingSpecification$MetricDefinitions' => '

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$MetricName' => '

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

', 'HyperParameterTuningJobObjective$MetricName' => '

The name of the metric to use for the objective metric.

', 'MetricData$MetricName' => '

The name of the metric.

', 'MetricDefinition$Name' => '

The name of the metric.

', 'TrialComponentMetricSummary$MetricName' => '

The name of the metric.

', ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'MetricDefinition$Regex' => '

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

', ], ], 'MetricSetSource' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$Set' => '

The dataset split from which the AutoML job produced the metric.

', ], ], 'MetricSpecification' => [ 'base' => '

An object containing information about a metric.

', 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$MetricSpecification' => '

An object containing information about a metric.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Value' => '

The value of the metric with the best result.

', 'FinalHyperParameterTuningJobObjectiveMetric$Value' => '

The value of the objective metric.

', ], ], 'MetricsSource' => [ 'base' => '

Details about the metrics source.

', 'refs' => [ 'Bias$Report' => '

The bias report for a model

', 'Bias$PreTrainingReport' => '

The pre-training bias report for a model.

', 'Bias$PostTrainingReport' => '

The post-training bias report for a model.

', 'DriftCheckBias$PreTrainingConstraints' => '

The pre-training constraints.

', 'DriftCheckBias$PostTrainingConstraints' => '

The post-training constraints.

', 'DriftCheckExplainability$Constraints' => '

The drift check explainability constraints.

', 'DriftCheckModelDataQuality$Statistics' => '

The drift check model data quality statistics.

', 'DriftCheckModelDataQuality$Constraints' => '

The drift check model data quality constraints.

', 'DriftCheckModelQuality$Statistics' => '

The drift check model quality statistics.

', 'DriftCheckModelQuality$Constraints' => '

The drift check model quality constraints.

', 'Explainability$Report' => '

The explainability report for a model.

', 'ModelDataQuality$Statistics' => '

Data quality statistics for a model.

', 'ModelDataQuality$Constraints' => '

Data quality constraints for a model.

', 'ModelQuality$Statistics' => '

Model quality statistics.

', 'ModelQuality$Constraints' => '

Model quality constraints.

', ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion' => '

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

', ], ], 'Model' => [ 'base' => '

The properties of a model as returned by the Search API.

', 'refs' => [ 'ModelDashboardModel$Model' => '

A model displayed in the Model Dashboard.

', ], ], 'ModelAccessConfig' => [ 'base' => '

The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.

', 'refs' => [ 'S3ModelDataSource$ModelAccessConfig' => '

Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', 'TextGenerationJobConfig$ModelAccessConfig' => NULL, ], ], 'ModelApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model.

', 'CreateModelPackageInput$ModelApprovalStatus' => '

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

', 'DescribeModelPackageOutput$ModelApprovalStatus' => '

The approval status of the model package.

', 'ListModelPackagesInput$ModelApprovalStatus' => '

A filter that returns only the model packages with the specified approval status.

', 'ModelPackage$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'ModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'UpdateModelPackageInput$ModelApprovalStatus' => '

The approval status of the model.

', ], ], 'ModelArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelOutput$ModelArn' => '

The ARN of the model created in SageMaker.

', 'DescribeModelOutput$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn' => '

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

', 'LabelingJobOutput$FinalActiveLearningModelArn' => '

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

', 'Model$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'ModelSummary$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelArtifacts' => [ 'base' => '

Provides information about the location that is configured for storing model artifacts.

Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the /opt/ml/model directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelArtifacts' => '

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

', 'DescribeTrainingJobResponse$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', 'TrainingJob$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', ], ], 'ModelBiasAppSpecification' => [ 'base' => '

Docker container image configuration object for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', ], ], 'ModelBiasBaselineConfig' => [ 'base' => '

The configuration for a baseline model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', ], ], 'ModelBiasJobInput' => [ 'base' => '

Inputs for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasJobInput' => '

Inputs for the model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput' => '

Inputs for the model bias job.

', ], ], 'ModelCacheSetting' => [ 'base' => NULL, 'refs' => [ 'MultiModelConfig$ModelCacheSetting' => '

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

', ], ], 'ModelCard' => [ 'base' => '

An Amazon SageMaker Model Card.

', 'refs' => [ 'SearchRecord$ModelCard' => '

An Amazon SageMaker Model Card that documents details about a machine learning model.

', ], ], 'ModelCardArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the successfully created model card.

', 'DescribeModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardVersionSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelDashboardModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) for a model card.

', 'UpdateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the updated model card.

', ], ], 'ModelCardContent' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$Content' => '

The content of the model card. Content must be in model card JSON schema and provided as a string.

', 'DescribeModelCardResponse$Content' => '

The content of the model card.

', 'ModelCard$Content' => '

The content of the model card. Content uses the model card JSON schema and provided as a string.

', 'UpdateModelCardRequest$Content' => '

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

', ], ], 'ModelCardExportArtifacts' => [ 'base' => '

The artifacts of the model card export job.

', 'refs' => [ 'DescribeModelCardExportJobResponse$ExportArtifacts' => '

The exported model card artifacts.

', ], ], 'ModelCardExportJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'DescribeModelCardExportJobRequest$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'ModelCardExportJobSummary$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', ], ], 'ModelCardExportJobSortBy' => [ 'base' => 'Attribute by which to sort returned export jobs.', 'refs' => [ 'ListModelCardExportJobsRequest$SortBy' => '

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardExportJobSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsRequest$SortOrder' => '

Sort model card export jobs by ascending or descending order.

', ], ], 'ModelCardExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardExportJobResponse$Status' => '

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.

  • Completed: The model card export job is complete.

  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

', 'ListModelCardExportJobsRequest$StatusEquals' => '

Only list model card export jobs with the specified status.

', 'ModelCardExportJobSummary$Status' => '

The completion status of the model card export job.

', ], ], 'ModelCardExportJobSummary' => [ 'base' => '

The summary of the Amazon SageMaker Model Card export job.

', 'refs' => [ 'ModelCardExportJobSummaryList$member' => NULL, ], ], 'ModelCardExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsResponse$ModelCardExportJobSummaries' => '

The summaries of the listed model card export jobs.

', ], ], 'ModelCardExportOutputConfig' => [ 'base' => '

Configure the export output details for an Amazon SageMaker Model Card.

', 'refs' => [ 'CreateModelCardExportJobRequest$OutputConfig' => '

The model card output configuration that specifies the Amazon S3 path for exporting.

', 'DescribeModelCardExportJobResponse$OutputConfig' => '

The export output details for the model card.

', ], ], 'ModelCardNameOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to export.

', 'DescribeModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to describe.

', 'ListModelCardVersionsRequest$ModelCardName' => '

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

', 'UpdateModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to update.

', ], ], 'ModelCardProcessingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardResponse$ModelCardProcessingStatus' => '

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

', ], ], 'ModelCardSecurityConfig' => [ 'base' => '

Configure the security settings to protect model card data.

', 'refs' => [ 'CreateModelCardRequest$SecurityConfig' => '

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

', 'DescribeModelCardResponse$SecurityConfig' => '

The security configuration used to protect model card content.

', 'ModelCard$SecurityConfig' => '

The security configuration used to protect model card data.

', 'ModelDashboardModelCard$SecurityConfig' => '

The KMS Key ID (KMSKeyId) for encryption of model card information.

', ], ], 'ModelCardSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsRequest$SortBy' => '

Sort model cards by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortOrder' => '

Sort model card versions by ascending or descending order.

', 'ListModelCardsRequest$SortOrder' => '

Sort model cards by ascending or descending order.

', ], ], 'ModelCardStatus' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'DescribeModelCardResponse$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ListModelCardVersionsRequest$ModelCardStatus' => '

Only list model card versions with the specified approval status.

', 'ListModelCardsRequest$ModelCardStatus' => '

Only list model cards with the specified approval status.

', 'ModelCard$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardSummary$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardVersionSummary$ModelCardStatus' => '

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelDashboardModelCard$ModelCardStatus' => '

The model card status.

', 'UpdateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', ], ], 'ModelCardSummary' => [ 'base' => '

A summary of the model card.

', 'refs' => [ 'ModelCardSummaryList$member' => NULL, ], ], 'ModelCardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsResponse$ModelCardSummaries' => '

The summaries of the listed model cards.

', ], ], 'ModelCardVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortBy' => '

Sort listed model card versions by version. Sorts by version by default.

', ], ], 'ModelCardVersionSummary' => [ 'base' => '

A summary of a specific version of the model card.

', 'refs' => [ 'ModelCardVersionSummaryList$member' => NULL, ], ], 'ModelCardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsResponse$ModelCardVersionSummaryList' => '

The summaries of the listed versions of the model card.

', ], ], 'ModelClientConfig' => [ 'base' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'refs' => [ 'CreateTransformJobRequest$ModelClientConfig' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'DescribeTransformJobResponse$ModelClientConfig' => '

The timeout and maximum number of retries for processing a transform job invocation.

', 'TransformJob$ModelClientConfig' => NULL, ], ], 'ModelCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$CompressionType' => '

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

  • If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.

  • If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.

  • Do not use any of the following as file names or directory names:

    • An empty or blank string

    • A string which contains null bytes

    • A string longer than 255 bytes

    • A single dot (.)

    • A double dot (..)

  • Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).

  • Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

', ], ], 'ModelConfiguration' => [ 'base' => '

Defines the model configuration. Includes the specification name and environment parameters.

', 'refs' => [ 'InferenceRecommendation$ModelConfiguration' => '

Defines the model configuration.

', 'RecommendationJobInferenceBenchmark$ModelConfiguration' => NULL, ], ], 'ModelDashboardEndpoint' => [ 'base' => '

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardEndpoints$member' => NULL, ], ], 'ModelDashboardEndpoints' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$Endpoints' => '

The endpoints that host a model.

', ], ], 'ModelDashboardIndicatorAction' => [ 'base' => '

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

', 'refs' => [ 'MonitoringAlertActions$ModelDashboardIndicator' => '

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

', ], ], 'ModelDashboardModel' => [ 'base' => '

A model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'SearchRecord$Model' => NULL, ], ], 'ModelDashboardModelCard' => [ 'base' => '

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardModel$ModelCard' => '

The model card for a model.

', ], ], 'ModelDashboardMonitoringSchedule' => [ 'base' => '

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardMonitoringSchedules$member' => NULL, ], ], 'ModelDashboardMonitoringSchedules' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$MonitoringSchedules' => '

The monitoring schedules for a model.

', ], ], 'ModelDataQuality' => [ 'base' => '

Data quality constraints and statistics for a model.

', 'refs' => [ 'ModelMetrics$ModelDataQuality' => '

Metrics that measure the quality of the input data for a model.

', ], ], 'ModelDataSource' => [ 'base' => '

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

', 'refs' => [ 'ContainerDefinition$ModelDataSource' => '

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

', 'ModelPackageContainerDefinition$ModelDataSource' => '

Specifies the location of ML model data to deploy during endpoint creation.

', 'SourceAlgorithm$ModelDataSource' => '

Specifies the location of ML model data to deploy during endpoint creation.

', ], ], 'ModelDeployConfig' => [ 'base' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'refs' => [ 'CreateAutoMLJobRequest$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'CreateAutoMLJobV2Request$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'DescribeAutoMLJobResponse$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', 'DescribeAutoMLJobV2Response$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', ], ], 'ModelDeployResult' => [ 'base' => '

Provides information about the endpoint of the model deployment.

', 'refs' => [ 'DescribeAutoMLJobResponse$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', 'DescribeAutoMLJobV2Response$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', ], ], 'ModelDigests' => [ 'base' => '

Provides information to verify the integrity of stored model artifacts.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelDigests' => '

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

', ], ], 'ModelExplainabilityAppSpecification' => [ 'base' => '

Docker container image configuration object for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', ], ], 'ModelExplainabilityBaselineConfig' => [ 'base' => '

The configuration for a baseline model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', ], ], 'ModelExplainabilityJobInput' => [ 'base' => '

Inputs for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', ], ], 'ModelInfrastructureConfig' => [ 'base' => '

The configuration for the infrastructure that the model will be deployed to.

', 'refs' => [ 'ModelVariantConfig$InfrastructureConfig' => '

The configuration for the infrastructure that the model will be deployed to.

', 'ModelVariantConfigSummary$InfrastructureConfig' => '

The configuration of the infrastructure that the model has been deployed to.

', ], ], 'ModelInfrastructureType' => [ 'base' => NULL, 'refs' => [ 'ModelInfrastructureConfig$InfrastructureType' => '

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

', ], ], 'ModelInput' => [ 'base' => '

Input object for the model.

', 'refs' => [ 'ModelPackageContainerDefinition$ModelInput' => '

A structure with Model Input details.

', ], ], 'ModelInsightsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$ModelInsights' => '

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

', ], ], 'ModelLatencyThreshold' => [ 'base' => '

The model latency threshold.

', 'refs' => [ 'ModelLatencyThresholds$member' => NULL, ], ], 'ModelLatencyThresholds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$ModelLatencyThresholds' => '

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', ], ], 'ModelMetadataFilter' => [ 'base' => '

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

', 'refs' => [ 'ModelMetadataFilters$member' => NULL, ], ], 'ModelMetadataFilterType' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataFilter$Name' => '

The name of the of the model to filter by.

', ], ], 'ModelMetadataFilters' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataSearchExpression$Filters' => '

A list of filter objects.

', ], ], 'ModelMetadataSearchExpression' => [ 'base' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results

', 'refs' => [ 'ListModelMetadataRequest$SearchExpression' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

', ], ], 'ModelMetadataSummaries' => [ 'base' => NULL, 'refs' => [ 'ListModelMetadataResponse$ModelMetadataSummaries' => '

A structure that holds model metadata.

', ], ], 'ModelMetadataSummary' => [ 'base' => '

A summary of the model metadata.

', 'refs' => [ 'ModelMetadataSummaries$member' => NULL, ], ], 'ModelMetrics' => [ 'base' => '

Contains metrics captured from a model.

', 'refs' => [ 'CreateModelPackageInput$ModelMetrics' => '

A structure that contains model metrics reports.

', 'DescribeModelPackageOutput$ModelMetrics' => '

Metrics for the model.

', 'ModelPackage$ModelMetrics' => '

Metrics for the model.

', ], ], 'ModelName' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$ModelName' => '

The name of the new model.

', 'CreateTransformJobRequest$ModelName' => '

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

', 'DeleteModelInput$ModelName' => '

The name of the model to delete.

', 'DescribeModelInput$ModelName' => '

The name of the model.

', 'DescribeModelOutput$ModelName' => '

Name of the SageMaker model.

', 'DescribeTransformJobResponse$ModelName' => '

The name of the model used in the transform job.

', 'InferenceComponentSpecification$ModelName' => '

The name of an existing SageMaker model object in your account that you want to deploy with the inference component.

', 'InferenceComponentSpecificationSummary$ModelName' => '

The name of the SageMaker model object that is deployed with the inference component.

', 'InferenceRecommendationsJob$ModelName' => '

The name of the created model.

', 'ListInferenceRecommendationsJobsRequest$ModelNameEquals' => '

A filter that returns only jobs that were created for this model.

', 'Model$ModelName' => '

The name of the model.

', 'ModelSummary$ModelName' => '

The name of the model that you want a summary for.

', 'ModelVariantConfig$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ModelVariantConfigSummary$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ProductionVariant$ModelName' => '

The name of the model that you want to host. This is the name that you specified when creating the model.

', 'RecommendationJobInputConfig$ModelName' => '

The name of the created model.

', 'TransformJob$ModelName' => '

The name of the model associated with the transform job.

', ], ], 'ModelNameContains' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$NameContains' => '

A string in the model name. This filter returns only models whose name contains the specified string.

', ], ], 'ModelPackage' => [ 'base' => '

A versioned model that can be deployed for SageMaker inference.

', 'refs' => [ 'SearchRecord$ModelPackage' => NULL, ], ], 'ModelPackageArn' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageErrorMap$key' => NULL, 'BatchDescribeModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'CreateCompilationJobRequest$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

', 'CreateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the new model package.

', 'DescribeCompilationJobResponse$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

', 'DescribeModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'InferenceRecommendationsJob$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals' => '

A filter that returns only jobs that were created for this versioned model package.

', 'ModelPackage$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'ModelPackageArnList$member' => NULL, 'ModelPackageSummaries$key' => NULL, 'ModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'RecommendationJobInputConfig$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'UpdateModelPackageInput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'UpdateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelPackageArnList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageInput$ModelPackageArnList' => '

The list of Amazon Resource Name (ARN) of the model package groups.

', ], ], 'ModelPackageContainerDefinition' => [ 'base' => '

Describes the Docker container for the model package.

', 'refs' => [ 'ModelPackageContainerDefinitionList$member' => NULL, ], ], 'ModelPackageContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', 'InferenceSpecification$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', ], ], 'ModelPackageFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$FrameworkVersion' => '

The framework version of the Model Package Container Image.

', ], ], 'ModelPackageGroup' => [ 'base' => '

A group of versioned models in the model registry.

', 'refs' => [ 'SearchRecord$ModelPackageGroup' => NULL, ], ], 'ModelPackageGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroup$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'PutModelPackageGroupPolicyOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model package group.

', ], ], 'ModelPackageGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ModelPackageGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageGroupOutput$ModelPackageGroupStatus' => '

The status of the model group.

', 'ModelPackageGroup$ModelPackageGroupStatus' => '

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.

  • IN_PROGRESS - The model group is in the process of being created.

  • COMPLETED - The model group was successfully created.

  • FAILED - The model group failed.

  • DELETING - The model group is in the process of being deleted.

  • DELETE_FAILED - SageMaker failed to delete the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupStatus' => '

The status of the model group.

', ], ], 'ModelPackageGroupSummary' => [ 'base' => '

Summary information about a model group.

', 'refs' => [ 'ModelPackageGroupSummaryList$member' => NULL, ], ], 'ModelPackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsOutput$ModelPackageGroupSummaryList' => '

A list of summaries of the model groups in your Amazon Web Services account.

', ], ], 'ModelPackageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'ModelPackageSourceUri' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$SourceUri' => '

The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.

', 'DescribeModelPackageOutput$SourceUri' => '

The URI of the source for the model package.

', 'ModelPackage$SourceUri' => '

The URI of the source for the model package.

', 'UpdateModelPackageInput$SourceUri' => '

The URI of the source for the model package.

', ], ], 'ModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageStatus' => '

The status of the mortgage package.

', 'DescribeModelPackageOutput$ModelPackageStatus' => '

The current status of the model package.

', 'ModelPackage$ModelPackageStatus' => '

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

', 'ModelPackageSummary$ModelPackageStatus' => '

The overall status of the model package.

', ], ], 'ModelPackageStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the model package.

', 'refs' => [ 'DescribeModelPackageOutput$ModelPackageStatusDetails' => '

Details about the current status of the model package.

', 'ModelPackage$ModelPackageStatusDetails' => '

Specifies the validation and image scan statuses of the model package.

', ], ], 'ModelPackageStatusItem' => [ 'base' => '

Represents the overall status of a model package.

', 'refs' => [ 'ModelPackageStatusItemList$member' => NULL, ], ], 'ModelPackageStatusItemList' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusDetails$ValidationStatuses' => '

The validation status of the model package.

', 'ModelPackageStatusDetails$ImageScanStatuses' => '

The status of the scan of the Docker image container for the model package.

', ], ], 'ModelPackageSummaries' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$ModelPackageSummaries' => '

The summaries for the model package versions

', ], ], 'ModelPackageSummary' => [ 'base' => '

Provides summary information about a model package.

', 'refs' => [ 'ModelPackageSummaryList$member' => NULL, ], ], 'ModelPackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesOutput$ModelPackageSummaryList' => '

An array of ModelPackageSummary objects, each of which lists a model package.

', ], ], 'ModelPackageType' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$ModelPackageType' => '

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

', ], ], 'ModelPackageValidationProfile' => [ 'base' => '

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'ModelPackageValidationProfiles$member' => NULL, ], ], 'ModelPackageValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'ModelPackageValidationSpecification$ValidationProfiles' => '

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

', ], ], 'ModelPackageValidationSpecification' => [ 'base' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', 'refs' => [ 'CreateModelPackageInput$ValidationSpecification' => '

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'DescribeModelPackageOutput$ValidationSpecification' => '

Configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'ModelPackage$ValidationSpecification' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', ], ], 'ModelPackageVersion' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageVersion' => '

The version number of a versioned model.

', 'DescribeModelPackageOutput$ModelPackageVersion' => '

The version of the model package.

', 'ModelPackage$ModelPackageVersion' => '

The version number of a versioned model.

', 'ModelPackageSummary$ModelPackageVersion' => '

If the model package is a versioned model, the version of the model.

', ], ], 'ModelQuality' => [ 'base' => '

Model quality statistics and constraints.

', 'refs' => [ 'ModelMetrics$ModelQuality' => '

Metrics that measure the quality of a model.

', ], ], 'ModelQualityAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification' => '

The container that runs the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification' => '

Configures the model quality job to run a specified Docker container image.

', ], ], 'ModelQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig' => '

Specifies the constraints and baselines for the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig' => '

The baseline configuration for a model quality job.

', ], ], 'ModelQualityJobInput' => [ 'base' => '

The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityJobInput' => '

A list of the inputs that are monitored. Currently endpoints are supported.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput' => '

Inputs for the model quality job.

', ], ], 'ModelRegisterSettings' => [ 'base' => '

The model registry settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$ModelRegisterSettings' => '

The model registry settings for the SageMaker Canvas application.

', ], ], 'ModelSetupTime' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$ModelSetupTime' => '

The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.

NaN indicates that the value is not available.

', ], ], 'ModelSortKey' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'ModelStepMetadata' => [ 'base' => '

Metadata for Model steps.

', 'refs' => [ 'PipelineExecutionStepMetadata$Model' => '

The Amazon Resource Name (ARN) of the model that was created by this step execution.

', ], ], 'ModelSummary' => [ 'base' => '

Provides summary information about a model.

', 'refs' => [ 'ModelSummaryList$member' => NULL, ], ], 'ModelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelsOutput$Models' => '

An array of ModelSummary objects, each of which lists a model.

', ], ], 'ModelVariantAction' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$value' => NULL, ], ], 'ModelVariantActionMap' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$ModelVariantActions' => '

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant

  • Remove - Delete the variant

  • Retain - Keep the variant as it is

', ], ], 'ModelVariantConfig' => [ 'base' => '

Contains information about the deployment options of a model.

', 'refs' => [ 'ModelVariantConfigList$member' => NULL, ], ], 'ModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

', 'StopInferenceExperimentRequest$DesiredModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

', 'UpdateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

', ], ], 'ModelVariantConfigSummary' => [ 'base' => '

Summary of the deployment configuration of a model.

', 'refs' => [ 'ModelVariantConfigSummaryList$member' => NULL, ], ], 'ModelVariantConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$ModelVariants' => '

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

', ], ], 'ModelVariantName' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$key' => NULL, 'ModelVariantConfig$VariantName' => '

The name of the variant.

', 'ModelVariantConfigSummary$VariantName' => '

The name of the variant.

', 'ShadowModeConfig$SourceModelVariantName' => '

The name of the production variant, which takes all the inference requests.

', 'ShadowModelVariantConfig$ShadowModelVariantName' => '

The name of the shadow variant.

', ], ], 'ModelVariantStatus' => [ 'base' => NULL, 'refs' => [ 'ModelVariantConfigSummary$Status' => '

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.

  • InService - The model variant is running on the hosted inference endpoint.

  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.

  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.

  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

', ], ], 'MonitoringAlertActions' => [ 'base' => '

A list of alert actions taken in response to an alert going into InAlert status.

', 'refs' => [ 'MonitoringAlertSummary$Actions' => '

A list of alert actions taken in response to an alert going into InAlert status.

', ], ], 'MonitoringAlertHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryResponse$MonitoringAlertHistory' => '

An alert history for a model monitoring schedule.

', ], ], 'MonitoringAlertHistorySortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$SortBy' => '

The field used to sort results. The default is CreationTime.

', ], ], 'MonitoringAlertHistorySummary' => [ 'base' => '

Provides summary information of an alert\'s history.

', 'refs' => [ 'MonitoringAlertHistoryList$member' => NULL, ], ], 'MonitoringAlertName' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertHistorySummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertSummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertResponse$MonitoringAlertName' => '

The name of a monitoring alert.

', ], ], 'MonitoringAlertStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$StatusEquals' => '

A filter that retrieves only alerts with a specific status.

', 'MonitoringAlertHistorySummary$AlertStatus' => '

The current alert status of an alert.

', 'MonitoringAlertSummary$AlertStatus' => '

The current status of an alert.

', ], ], 'MonitoringAlertSummary' => [ 'base' => '

Provides summary information about a monitor alert.

', 'refs' => [ 'MonitoringAlertSummaryList$member' => NULL, ], ], 'MonitoringAlertSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertsResponse$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', 'ModelDashboardMonitoringSchedule$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', ], ], 'MonitoringAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'MonitoringJobDefinition$MonitoringAppSpecification' => '

Configures the monitoring job to run a specified Docker container image.

', ], ], 'MonitoringBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'MonitoringJobDefinition$BaselineConfig' => '

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

', ], ], 'MonitoringClusterConfig' => [ 'base' => '

Configuration for the cluster used to run model monitoring jobs.

', 'refs' => [ 'MonitoringResources$ClusterConfig' => '

The configuration for the cluster resources used to run the processing job.

', ], ], 'MonitoringConstraintsResource' => [ 'base' => '

The constraints resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$ConstraintsResource' => NULL, 'ModelBiasBaselineConfig$ConstraintsResource' => NULL, 'ModelExplainabilityBaselineConfig$ConstraintsResource' => NULL, 'ModelQualityBaselineConfig$ConstraintsResource' => NULL, 'MonitoringBaselineConfig$ConstraintsResource' => '

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

', ], ], 'MonitoringContainerArguments' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$ContainerArguments' => '

The arguments to send to the container that the monitoring job runs.

', 'ModelQualityAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', 'MonitoringAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', ], ], 'MonitoringCsvDatasetFormat' => [ 'base' => '

Represents the CSV dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Csv' => '

The CSV dataset used in the monitoring job.

', ], ], 'MonitoringDatapointsToAlert' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', 'UpdateMonitoringAlertRequest$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', ], ], 'MonitoringDatasetFormat' => [ 'base' => '

Represents the dataset format used when running a monitoring job.

', 'refs' => [ 'BatchTransformInput$DatasetFormat' => '

The dataset format for your batch transform job.

', ], ], 'MonitoringEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'ModelBiasAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelExplainabilityAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'MonitoringJobDefinition$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'MonitoringEvaluationPeriod' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', 'UpdateMonitoringAlertRequest$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', ], ], 'MonitoringExecutionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringExecutionSummary' => [ 'base' => '

Summary of information about the last monitoring job to run.

', 'refs' => [ 'DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary' => '

Describes metadata on the last execution to run, if there was one.

', 'ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary' => NULL, 'MonitoringExecutionSummaryList$member' => NULL, 'MonitoringSchedule$LastMonitoringExecutionSummary' => NULL, ], ], 'MonitoringExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsResponse$MonitoringExecutionSummaries' => '

A JSON array in which each element is a summary for a monitoring execution.

', ], ], 'MonitoringGroundTruthS3Input' => [ 'base' => '

The ground truth labels for the dataset used for the monitoring job.

', 'refs' => [ 'ModelBiasJobInput$GroundTruthS3Input' => '

Location of ground truth labels to use in model bias job.

', 'ModelQualityJobInput$GroundTruthS3Input' => '

The ground truth label provided for the model.

', ], ], 'MonitoringInput' => [ 'base' => '

The inputs for a monitoring job.

', 'refs' => [ 'MonitoringInputs$member' => NULL, ], ], 'MonitoringInputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringJobDefinition$MonitoringInputs' => '

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

', ], ], 'MonitoringJobDefinition' => [ 'base' => '

Defines the monitoring job.

', 'refs' => [ 'MonitoringScheduleConfig$MonitoringJobDefinition' => '

Defines the monitoring job.

', ], ], 'MonitoringJobDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the job definition.

', 'CreateModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'CreateModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', ], ], 'MonitoringJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name for the monitoring job definition.

', 'CreateModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the monitoring job definition.

', 'DeleteDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to delete.

', 'DeleteModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition to delete.

', 'DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition to delete.

', 'DeleteModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality monitoring job definition to delete.

', 'DescribeDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to describe.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName' => '

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ListMonitoringExecutionsRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring job runs of the specified monitoring job definitions.

', 'ListMonitoringSchedulesRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring schedules for the specified monitoring job definition.

', 'MonitoringExecutionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringScheduleConfig$MonitoringJobDefinitionName' => '

The name of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job definition that the schedule is for.

', ], ], 'MonitoringJobDefinitionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListModelBiasJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelExplainabilityJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'MonitoringJobDefinitionSummary' => [ 'base' => '

Summary information about a monitoring job.

', 'refs' => [ 'MonitoringJobDefinitionSummaryList$member' => NULL, ], ], 'MonitoringJobDefinitionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of data quality monitoring job definitions.

', 'ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a model bias jobs.

', 'ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a explainability bias jobs.

', 'ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of summaries of model quality monitoring job definitions.

', ], ], 'MonitoringJsonDatasetFormat' => [ 'base' => '

Represents the JSON dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Json' => '

The JSON dataset used in the monitoring job

', ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'MonitoringStoppingCondition$MaxRuntimeInSeconds' => '

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

', ], ], 'MonitoringNetworkConfig' => [ 'base' => '

The networking configuration for the monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$NetworkConfig' => '

Specifies networking configuration for the monitoring job.

', 'CreateModelBiasJobDefinitionRequest$NetworkConfig' => '

Networking options for a model bias job.

', 'CreateModelExplainabilityJobDefinitionRequest$NetworkConfig' => '

Networking options for a model explainability job.

', 'CreateModelQualityJobDefinitionRequest$NetworkConfig' => '

Specifies the network configuration for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$NetworkConfig' => '

The networking configuration for the data quality monitoring job.

', 'DescribeModelBiasJobDefinitionResponse$NetworkConfig' => '

Networking options for a model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model quality job.

', ], ], 'MonitoringOutput' => [ 'base' => '

The output object for a monitoring job.

', 'refs' => [ 'MonitoringOutputs$member' => NULL, ], ], 'MonitoringOutputConfig' => [ 'base' => '

The output configuration for monitoring jobs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig' => NULL, 'CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig' => NULL, 'CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig' => NULL, 'DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig' => NULL, 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig' => NULL, 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig' => NULL, 'MonitoringJobDefinition$MonitoringOutputConfig' => '

The array of outputs from the monitoring job to be uploaded to Amazon S3.

', ], ], 'MonitoringOutputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringOutputConfig$MonitoringOutputs' => '

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

', ], ], 'MonitoringParquetDatasetFormat' => [ 'base' => '

Represents the Parquet dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Parquet' => '

The Parquet dataset used in the monitoring job

', ], ], 'MonitoringProblemType' => [ 'base' => NULL, 'refs' => [ 'ModelQualityAppSpecification$ProblemType' => '

The machine learning problem type of the model that the monitoring job monitors.

', ], ], 'MonitoringResources' => [ 'base' => '

Identifies the resources to deploy for a monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobResources' => NULL, 'CreateModelBiasJobDefinitionRequest$JobResources' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$JobResources' => NULL, 'CreateModelQualityJobDefinitionRequest$JobResources' => NULL, 'DescribeDataQualityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelBiasJobDefinitionResponse$JobResources' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelQualityJobDefinitionResponse$JobResources' => NULL, 'MonitoringJobDefinition$MonitoringResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

', ], ], 'MonitoringS3Output' => [ 'base' => '

Information about where and how you want to store the results of a monitoring job.

', 'refs' => [ 'MonitoringOutput$S3Output' => '

The Amazon S3 storage location where the results of a monitoring job are saved.

', ], ], 'MonitoringS3Uri' => [ 'base' => NULL, 'refs' => [ 'MonitoringGroundTruthS3Input$S3Uri' => '

The address of the Amazon S3 location of the ground truth labels.

', 'MonitoringS3Output$S3Uri' => '

A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

', ], ], 'MonitoringSchedule' => [ 'base' => '

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'refs' => [ 'MonitoringScheduleList$member' => NULL, ], ], 'MonitoringScheduleArn' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeProcessingJobResponse$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of a monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'ProcessingJob$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'UpdateMonitoringAlertResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'UpdateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', ], ], 'MonitoringScheduleConfig' => [ 'base' => '

Configures the monitoring schedule and defines the monitoring job.

', 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleConfig' => NULL, 'MonitoringSchedule$MonitoringScheduleConfig' => NULL, 'UpdateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', ], ], 'MonitoringScheduleList' => [ 'base' => NULL, 'refs' => [ 'Endpoint$MonitoringSchedules' => '

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

', ], ], 'MonitoringScheduleName' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', 'DeleteMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule to delete.

', 'DescribeMonitoringScheduleRequest$MonitoringScheduleName' => '

Name of a previously created monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleName' => '

Name of the monitoring schedule.

', 'ListMonitoringAlertHistoryRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringAlertsRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringExecutionsRequest$MonitoringScheduleName' => '

Name of a specific schedule to fetch jobs for.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringAlertHistorySummary$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringExecutionSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'StartMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to start.

', 'StopMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to stop.

', 'UpdateMonitoringAlertRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'UpdateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', ], ], 'MonitoringScheduleSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringScheduleSummary' => [ 'base' => '

Summarizes the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleSummaryList$member' => NULL, ], ], 'MonitoringScheduleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesResponse$MonitoringScheduleSummaries' => '

A JSON array in which each element is a summary for a monitoring schedule.

', ], ], 'MonitoringStatisticsResource' => [ 'base' => '

The statistics resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$StatisticsResource' => NULL, 'MonitoringBaselineConfig$StatisticsResource' => '

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

', ], ], 'MonitoringStoppingCondition' => [ 'base' => '

A time limit for how long the monitoring job is allowed to run before stopping.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelBiasJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelQualityJobDefinitionRequest$StoppingCondition' => NULL, 'DescribeDataQualityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelBiasJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelQualityJobDefinitionResponse$StoppingCondition' => NULL, 'MonitoringJobDefinition$StoppingCondition' => '

Specifies a time limit for how long the monitoring job is allowed to run.

', ], ], 'MonitoringTimeOffsetString' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'BatchTransformInput$EndTimeOffset' => '

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$EndTimeOffset' => '

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', ], ], 'MonitoringType' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringType' => '

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

', 'ListMonitoringExecutionsRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring job runs of the specified monitoring type.

', 'ListMonitoringSchedulesRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring schedules for the specified monitoring type.

', 'ModelDashboardMonitoringSchedule$MonitoringType' => '

The monitor type of a model monitor.

', 'MonitoringExecutionSummary$MonitoringType' => '

The type of the monitoring job.

', 'MonitoringSchedule$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleConfig$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringType' => '

The type of the monitoring job definition that the schedule is for.

', ], ], 'MountPath' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$MountPath' => '

The path within the image to mount the user\'s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

', ], ], 'MultiModelConfig' => [ 'base' => '

Specifies additional configuration for hosting multi-model endpoints.

', 'refs' => [ 'ContainerDefinition$MultiModelConfig' => '

Specifies additional configuration for multi-model endpoints.

', ], ], 'NameContains' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$NameContains' => '

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

', 'ListClustersRequest$NameContains' => '

Set the maximum number of instances to print in the list.

', 'ListCompilationJobsRequest$NameContains' => '

A filter that returns the model compilation jobs whose name contains a specified string.

', 'ListDataQualityJobDefinitionsRequest$NameContains' => '

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

', 'ListDeviceFleetsRequest$NameContains' => '

Filter for fleets containing this name in their fleet device name.

', 'ListEdgeDeploymentPlansRequest$NameContains' => '

Selects edge deployment plans with names containing this name.

', 'ListEdgeDeploymentPlansRequest$DeviceFleetNameContains' => '

Selects edge deployment plans with a device fleet name containing this name.

', 'ListEdgePackagingJobsRequest$NameContains' => '

Filter for jobs containing this name in their packaging job name.

', 'ListEdgePackagingJobsRequest$ModelNameContains' => '

Filter for jobs where the model name contains this string.

', 'ListHubContentsRequest$NameContains' => '

Only list hub content if the name contains the specified string.

', 'ListHubsRequest$NameContains' => '

Only list hubs with names that contain the specified string.

', 'ListHyperParameterTuningJobsRequest$NameContains' => '

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

', 'ListInferenceExperimentsRequest$NameContains' => '

Selects inference experiments whose names contain this name.

', 'ListInferenceRecommendationsJobsRequest$NameContains' => '

A string in the job name. This filter returns only recommendations whose name contains the specified string.

', 'ListLabelingJobsRequest$NameContains' => '

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

', 'ListModelBiasJobDefinitionsRequest$NameContains' => '

Filter for model bias jobs whose name contains a specified string.

', 'ListModelExplainabilityJobDefinitionsRequest$NameContains' => '

Filter for model explainability jobs whose name contains a specified string.

', 'ListModelPackageGroupsInput$NameContains' => '

A string in the model group name. This filter returns only model groups whose name contains the specified string.

', 'ListModelPackagesInput$NameContains' => '

A string in the model package name. This filter returns only model packages whose name contains the specified string.

', 'ListModelQualityJobDefinitionsRequest$NameContains' => '

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

', 'ListMonitoringSchedulesRequest$NameContains' => '

Filter for monitoring schedules whose name contains a specified string.

', 'ListTrainingJobsRequest$NameContains' => '

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

', 'ListTransformJobsRequest$NameContains' => '

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

', ], ], 'NeoVpcConfig' => [ 'base' => '

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

', 'refs' => [ 'CreateCompilationJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeCompilationJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'NeoVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSecurityGroupIds$member' => NULL, ], ], 'NeoVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'NeoVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSubnets$member' => NULL, ], ], 'NeoVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$Subnets' => '

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

', ], ], 'NestedFilters' => [ 'base' => '

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job\'s InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • \'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}\',

  • \'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}\'

', 'refs' => [ 'NestedFiltersList$member' => NULL, ], ], 'NestedFiltersList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$NestedFilters' => '

A list of nested filter objects.

', ], ], 'NetworkConfig' => [ 'base' => '

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

', 'refs' => [ 'CreateProcessingJobRequest$NetworkConfig' => '

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

', 'DescribeProcessingJobResponse$NetworkConfig' => '

Networking options for a processing job.

', 'MonitoringJobDefinition$NetworkConfig' => '

Specifies networking options for an monitoring job.

', 'ProcessingJob$NetworkConfig' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NetworkInterfaceId' => '

The network interface IDs that SageMaker created at the time of creating the instance.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceRequest$NextToken' => '

Next token of device description.

', 'DescribeDeviceResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'DescribeEdgeDeploymentPlanRequest$NextToken' => '

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

', 'DescribeEdgeDeploymentPlanResponse$NextToken' => '

Token to use when calling the next set of stages in the edge deployment plan.

', 'DescribeFeatureGroupRequest$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

', 'DescribeFeatureGroupResponse$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions).

', 'ListActionsRequest$NextToken' => '

If the previous call to ListActions didn\'t return the full set of actions, the call returns a token for getting the next set of actions.

', 'ListActionsResponse$NextToken' => '

A token for getting the next set of actions, if there are any.

', 'ListAlgorithmsInput$NextToken' => '

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

', 'ListAlgorithmsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListAliasesRequest$NextToken' => '

If the previous call to ListAliases didn\'t return the full set of aliases, the call returns a token for retrieving the next set of aliases.

', 'ListAliasesResponse$NextToken' => '

A token for getting the next set of aliases, if more aliases exist.

', 'ListAppImageConfigsRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

', 'ListAppImageConfigsResponse$NextToken' => '

A token for getting the next set of AppImageConfigs, if there are any.

', 'ListAppsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListAppsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListArtifactsRequest$NextToken' => '

If the previous call to ListArtifacts didn\'t return the full set of artifacts, the call returns a token for getting the next set of artifacts.

', 'ListArtifactsResponse$NextToken' => '

A token for getting the next set of artifacts, if there are any.

', 'ListAssociationsRequest$NextToken' => '

If the previous call to ListAssociations didn\'t return the full set of associations, the call returns a token for getting the next set of associations.

', 'ListAssociationsResponse$NextToken' => '

A token for getting the next set of associations, if there are any.

', 'ListAutoMLJobsRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListAutoMLJobsResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListClusterNodesRequest$NextToken' => '

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

', 'ListClusterNodesResponse$NextToken' => '

The next token specified for listing instances in a SageMaker HyperPod cluster.

', 'ListClustersRequest$NextToken' => '

Set the next token to retrieve the list of SageMaker HyperPod clusters.

', 'ListClustersResponse$NextToken' => '

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

', 'ListCodeRepositoriesInput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCodeRepositoriesOutput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCompilationJobsRequest$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListCompilationJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

', 'ListContextsRequest$NextToken' => '

If the previous call to ListContexts didn\'t return the full set of contexts, the call returns a token for getting the next set of contexts.

', 'ListContextsResponse$NextToken' => '

A token for getting the next set of contexts, if there are any.

', 'ListDataQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

', 'ListDataQualityJobDefinitionsResponse$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.

', 'ListDeviceFleetsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDeviceFleetsResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDomainsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListDomainsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListEdgeDeploymentPlansRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgeDeploymentPlansResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListEdgePackagingJobsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgePackagingJobsResponse$NextToken' => '

Token to use when calling the next page of results.

', 'ListExperimentsRequest$NextToken' => '

If the previous call to ListExperiments didn\'t return the full set of experiments, the call returns a token for getting the next set of experiments.

', 'ListExperimentsResponse$NextToken' => '

A token for getting the next set of experiments, if there are any.

', 'ListFeatureGroupsRequest$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFeatureGroupsResponse$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFlowDefinitionsRequest$NextToken' => '

A token to resume pagination.

', 'ListFlowDefinitionsResponse$NextToken' => '

A token to resume pagination.

', 'ListHubContentVersionsRequest$NextToken' => '

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

', 'ListHubContentVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

', 'ListHubContentsRequest$NextToken' => '

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

', 'ListHubContentsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

', 'ListHubsRequest$NextToken' => '

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

', 'ListHubsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

', 'ListHumanTaskUisRequest$NextToken' => '

A token to resume pagination.

', 'ListHumanTaskUisResponse$NextToken' => '

A token to resume pagination.

', 'ListHyperParameterTuningJobsRequest$NextToken' => '

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListHyperParameterTuningJobsResponse$NextToken' => '

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListImageVersionsRequest$NextToken' => '

If the previous call to ListImageVersions didn\'t return the full set of versions, the call returns a token for getting the next set of versions.

', 'ListImageVersionsResponse$NextToken' => '

A token for getting the next set of versions, if there are any.

', 'ListImagesRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of images, the call returns a token for getting the next set of images.

', 'ListImagesResponse$NextToken' => '

A token for getting the next set of images, if there are any.

', 'ListInferenceExperimentsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListInferenceExperimentsResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListInferenceRecommendationsJobStepsRequest$NextToken' => '

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

', 'ListInferenceRecommendationsJobStepsResponse$NextToken' => '

A token that you can specify in your next request to return more results from the list.

', 'ListInferenceRecommendationsJobsRequest$NextToken' => '

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

', 'ListInferenceRecommendationsJobsResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListLabelingJobsForWorkteamRequest$NextToken' => '

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsForWorkteamResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLabelingJobsRequest$NextToken' => '

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLineageGroupsRequest$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListLineageGroupsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListModelBiasJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelBiasJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelCardExportJobsRequest$NextToken' => '

If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

', 'ListModelCardExportJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.

', 'ListModelCardVersionsRequest$NextToken' => '

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

', 'ListModelCardVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

', 'ListModelCardsRequest$NextToken' => '

If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

', 'ListModelCardsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

', 'ListModelExplainabilityJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelExplainabilityJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelMetadataRequest$NextToken' => '

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

', 'ListModelMetadataResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListModelPackageGroupsInput$NextToken' => '

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

', 'ListModelPackageGroupsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

', 'ListModelPackagesInput$NextToken' => '

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

', 'ListModelPackagesOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

', 'ListModelQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

', 'ListModelQualityJobDefinitionsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

', 'ListMonitoringAlertHistoryRequest$NextToken' => '

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertHistoryResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringAlertsRequest$NextToken' => '

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringExecutionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringExecutionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListNotebookInstanceLifecycleConfigsInput$NextToken' => '

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

', 'ListNotebookInstanceLifecycleConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

', 'ListNotebookInstancesInput$NextToken' => '

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

', 'ListNotebookInstancesOutput$NextToken' => '

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

', 'ListPipelineExecutionStepsRequest$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionStepsResponse$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionsRequest$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineExecutionsResponse$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineParametersForExecutionRequest$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelineParametersForExecutionResponse$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelinesRequest$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListPipelinesResponse$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListProcessingJobsRequest$NextToken' => '

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

', 'ListProcessingJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

', 'ListProjectsInput$NextToken' => '

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

', 'ListProjectsOutput$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListResourceCatalogsRequest$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListResourceCatalogsResponse$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListSpacesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSpacesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListStageDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to neeed tokening.

', 'ListStageDevicesResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListStudioLifecycleConfigsRequest$NextToken' => '

If the previous call to ListStudioLifecycleConfigs didn\'t return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

', 'ListStudioLifecycleConfigsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSubscribedWorkteamsRequest$NextToken' => '

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListSubscribedWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'ListTagsInput$NextToken' => '

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

', 'ListTagsOutput$NextToken' => '

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$NextToken' => '

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsForHyperParameterTuningJobResponse$NextToken' => '

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsRequest$NextToken' => '

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListTransformJobsRequest$NextToken' => '

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

', 'ListTransformJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

', 'ListTrialComponentsRequest$NextToken' => '

If the previous call to ListTrialComponents didn\'t return the full set of components, the call returns a token for getting the next set of components.

', 'ListTrialComponentsResponse$NextToken' => '

A token for getting the next set of components, if there are any.

', 'ListTrialsRequest$NextToken' => '

If the previous call to ListTrials didn\'t return the full set of trials, the call returns a token for getting the next set of trials.

', 'ListTrialsResponse$NextToken' => '

A token for getting the next set of trials, if there are any.

', 'ListUserProfilesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListUserProfilesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListWorkforcesRequest$NextToken' => '

A token to resume pagination.

', 'ListWorkforcesResponse$NextToken' => '

A token to resume pagination.

', 'ListWorkteamsRequest$NextToken' => '

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'SearchRequest$NextToken' => '

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

', 'SearchResponse$NextToken' => '

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

', ], ], 'NonEmptyString256' => [ 'base' => NULL, 'refs' => [ 'CustomImageContainerEntrypoint$member' => NULL, 'CustomImageContainerEnvironmentVariables$key' => NULL, ], ], 'NonEmptyString64' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the SageMaker Studio UI.

', 'CustomImageContainerArguments$member' => NULL, 'DescribeSpaceResponse$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', 'SpaceDetails$SpaceDisplayName' => '

The name of the space that appears in the Studio UI.

', 'UpdateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', ], ], 'NotebookInstanceAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceAcceleratorTypes$member' => NULL, ], ], 'NotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AcceleratorTypes' => '

A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'DescribeNotebookInstanceOutput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'UpdateNotebookInstanceInput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'NotebookInstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'DescribeNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', ], ], 'NotebookInstanceLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceLifecycleHook$Content' => '

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigInput$OnCreate' => '

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'CreateNotebookInstanceLifecycleConfigInput$OnStart' => '

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', ], ], 'NotebookInstanceLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to delete.

', 'DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to describe.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName' => '

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

', 'ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains' => '

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'NotebookInstanceSummary$NotebookInstanceLifecycleConfigName' => '

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$NameContains' => '

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

', ], ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'base' => '

Provides a summary of a notebook instance lifecycle configuration.

', 'refs' => [ 'NotebookInstanceLifecycleConfigSummaryList$member' => NULL, ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs' => '

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleHook' => [ 'base' => '

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'refs' => [ 'NotebookInstanceLifecycleConfigList$member' => NULL, ], ], 'NotebookInstanceName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$NotebookInstanceName' => '

The name of the new notebook instance.

', 'CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName' => '

The name of the notebook instance.

', 'DeleteNotebookInstanceInput$NotebookInstanceName' => '

The name of the SageMaker notebook instance to delete.

', 'DescribeNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance that you want information about.

', 'DescribeNotebookInstanceOutput$NotebookInstanceName' => '

The name of the SageMaker notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceName' => '

The name of the notebook instance that you want a summary for.

', 'StartNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to start.

', 'StopNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to terminate.

', 'UpdateNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to update.

', ], ], 'NotebookInstanceNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$NameContains' => '

A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.

', ], ], 'NotebookInstanceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'NotebookInstanceSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NotebookInstanceStatus' => '

The status of the notebook instance.

', 'ListNotebookInstancesInput$StatusEquals' => '

A filter that returns only notebook instances with the specified status.

', 'NotebookInstanceSummary$NotebookInstanceStatus' => '

The status of the notebook instance.

', ], ], 'NotebookInstanceSummary' => [ 'base' => '

Provides summary information for an SageMaker notebook instance.

', 'refs' => [ 'NotebookInstanceSummaryList$member' => NULL, ], ], 'NotebookInstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesOutput$NotebookInstances' => '

An array of NotebookInstanceSummary objects, one for each notebook instance.

', ], ], 'NotebookInstanceUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedNotebookInstanceUrlOutput$AuthorizedUrl' => '

A JSON object that contains the URL string.

', 'DescribeNotebookInstanceOutput$Url' => '

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

', 'NotebookInstanceSummary$Url' => '

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

', ], ], 'NotebookInstanceVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

', 'DescribeNotebookInstanceOutput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the notebook instance.

', 'UpdateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can\'t determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can\'t decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

', ], ], 'NotebookOutputOption' => [ 'base' => NULL, 'refs' => [ 'SharingSettings$NotebookOutputOption' => '

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

', ], ], 'NotificationConfiguration' => [ 'base' => '

Configures Amazon SNS notifications of available or expiring work items for work teams.

', 'refs' => [ 'CreateWorkteamRequest$NotificationConfiguration' => '

Configures notification of workers regarding available or expiring work items.

', 'UpdateWorkteamRequest$NotificationConfiguration' => '

Configures SNS topic notifications for available or expiring work items

', 'Workteam$NotificationConfiguration' => '

Configures SNS notifications of available or expiring work items for work teams.

', ], ], 'NotificationTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$NotificationTopicArn' => '

The ARN for the Amazon SNS topic to which notifications should be published.

', ], ], 'NumberOfAcceleratorDevices' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfAcceleratorDevicesRequired' => '

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

', ], ], 'NumberOfCpuCores' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfCpuCoresRequired' => '

The number of CPU cores to allocate to run a model that you assign to an inference component.

', ], ], 'NumberOfHumanWorkersPerDataObject' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$NumberOfHumanWorkersPerDataObject' => '

The number of human workers that will label an object.

', 'LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject' => '

The configured number of workers per data object.

', ], ], 'NumberOfSteps' => [ 'base' => NULL, 'refs' => [ 'Stairs$NumberOfSteps' => '

Specifies how many steps to perform during traffic.

', ], ], 'ObjectiveStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$ObjectiveStatus' => '

The objective\'s status.

', 'HyperParameterTrainingJobSummary$ObjectiveStatus' => '

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounter' => [ 'base' => NULL, 'refs' => [ 'ObjectiveStatusCounters$Succeeded' => '

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

', 'ObjectiveStatusCounters$Pending' => '

The number of training jobs that are in progress and pending evaluation of their final objective metric.

', 'ObjectiveStatusCounters$Failed' => '

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounters' => [ 'base' => '

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters' => NULL, 'HyperParameterTuningJobSummary$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

', ], ], 'OfflineStoreConfig' => [ 'base' => '

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

', 'refs' => [ 'CreateFeatureGroupRequest$OfflineStoreConfig' => '

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

', 'DescribeFeatureGroupResponse$OfflineStoreConfig' => '

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.

  • Configuration of the Glue data catalog.

  • Table format of the offline store.

  • Option to disable the automatic creation of a Glue table for the offline store.

  • Encryption configuration.

', 'FeatureGroup$OfflineStoreConfig' => NULL, ], ], 'OfflineStoreStatus' => [ 'base' => '

The status of OfflineStore.

', 'refs' => [ 'DescribeFeatureGroupResponse$OfflineStoreStatus' => '

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

', 'FeatureGroup$OfflineStoreStatus' => NULL, 'FeatureGroupSummary$OfflineStoreStatus' => '

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

', ], ], 'OfflineStoreStatusValue' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$OfflineStoreStatusEquals' => '

An OfflineStore status. Filters by OfflineStore status.

', 'OfflineStoreStatus$Status' => '

An OfflineStore status.

', ], ], 'OidcConfig' => [ 'base' => '

Use this parameter to configure your OIDC Identity Provider (IdP).

', 'refs' => [ 'CreateWorkforceRequest$OidcConfig' => '

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

', 'UpdateWorkforceRequest$OidcConfig' => '

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

', ], ], 'OidcConfigForResponse' => [ 'base' => '

Your OIDC IdP workforce configuration.

', 'refs' => [ 'Workforce$OidcConfig' => '

The configuration of an OIDC Identity Provider (IdP) private workforce.

', ], ], 'OidcEndpoint' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfig$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfig$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfig$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfig$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfig$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', 'OidcConfigForResponse$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfigForResponse$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfigForResponse$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfigForResponse$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfigForResponse$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfigForResponse$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', ], ], 'OidcMemberDefinition' => [ 'base' => '

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', 'refs' => [ 'MemberDefinition$OidcMemberDefinition' => '

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', ], ], 'OnlineStoreConfig' => [ 'base' => '

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

', 'refs' => [ 'CreateFeatureGroupRequest$OnlineStoreConfig' => '

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

', 'DescribeFeatureGroupResponse$OnlineStoreConfig' => '

The configuration for the OnlineStore.

', 'FeatureGroup$OnlineStoreConfig' => NULL, ], ], 'OnlineStoreConfigUpdate' => [ 'base' => '

Updates the feature group online store configuration.

', 'refs' => [ 'UpdateFeatureGroupRequest$OnlineStoreConfig' => '

Updates the feature group online store configuration.

', ], ], 'OnlineStoreSecurityConfig' => [ 'base' => '

The security configuration for OnlineStore.

', 'refs' => [ 'OnlineStoreConfig$SecurityConfig' => '

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

', ], ], 'OnlineStoreTotalSizeBytes' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$OnlineStoreTotalSizeBytes' => '

The size of the OnlineStore in bytes.

', ], ], 'Operator' => [ 'base' => NULL, 'refs' => [ 'Filter$Operator' => '

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn\'t equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "\'CONTAINS\' operator usage limit of 1 exceeded."

', ], ], 'OptionalDouble' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Max' => '

The maximum value of the metric.

', 'TrialComponentMetricSummary$Min' => '

The minimum value of the metric.

', 'TrialComponentMetricSummary$Last' => '

The most recent value of the metric.

', 'TrialComponentMetricSummary$Avg' => '

The average value of the metric.

', 'TrialComponentMetricSummary$StdDev' => '

The standard deviation of the metric.

', ], ], 'OptionalInteger' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Count' => '

The number of samples used to generate the metric.

', ], ], 'OptionalVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', 'HyperParameterTuningResourceConfig$VolumeSizeInGB' => '

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

', 'ProfilerRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', ], ], 'OrderKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListEndpointsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListInferenceComponentsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListModelsInput$SortOrder' => '

The sort order for results. The default is Descending.

', ], ], 'OutputCompressionType' => [ 'base' => NULL, 'refs' => [ 'OutputDataConfig$CompressionType' => '

The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

', ], ], 'OutputConfig' => [ 'base' => '

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

', 'refs' => [ 'CreateCompilationJobRequest$OutputConfig' => '

Provides information about the output location for the compiled model and the target device the model runs on.

', 'DescribeCompilationJobResponse$OutputConfig' => '

Information about the output location for the compiled model and the target device that the model runs on.

', ], ], 'OutputDataConfig' => [ 'base' => '

Provides information about how to store model training results (model artifacts).

', 'refs' => [ 'CreateTrainingJobRequest$OutputDataConfig' => '

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', 'DescribeTrainingJobResponse$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'HyperParameterTrainingJobDefinition$OutputDataConfig' => '

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

', 'TrainingJob$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'TrainingJobDefinition$OutputDataConfig' => '

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', ], ], 'OutputParameter' => [ 'base' => '

An output parameter of a pipeline step.

', 'refs' => [ 'OutputParameterList$member' => NULL, ], ], 'OutputParameterList' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$OutputParameters' => '

A list of the output parameters of the callback step.

', 'LambdaStepMetadata$OutputParameters' => '

A list of the output parameters of the Lambda step.

', 'SendPipelineExecutionStepSuccessRequest$OutputParameters' => '

A list of the output parameters of the callback step.

', ], ], 'OwnershipSettings' => [ 'base' => '

The collection of ownership settings for a space.

', 'refs' => [ 'CreateSpaceRequest$OwnershipSettings' => '

A collection of ownership settings.

', 'DescribeSpaceResponse$OwnershipSettings' => '

The collection of ownership settings for a space.

', ], ], 'OwnershipSettingsSummary' => [ 'base' => '

Specifies summary information about the ownership settings.

', 'refs' => [ 'SpaceDetails$OwnershipSettingsSummary' => '

Specifies summary information about the ownership settings.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NextToken' => '

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

', 'ListEndpointConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

', 'ListEndpointsInput$NextToken' => '

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

', 'ListEndpointsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListInferenceComponentsInput$NextToken' => '

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

', 'ListInferenceComponentsOutput$NextToken' => '

The token to use in a subsequent request to get the next set of results following a truncated response.

', 'ListModelsInput$NextToken' => '

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

', 'ListModelsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

', ], ], 'ParallelismConfiguration' => [ 'base' => '

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

', 'refs' => [ 'CreatePipelineRequest$ParallelismConfiguration' => '

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

', 'DescribePipelineExecutionResponse$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'DescribePipelineResponse$ParallelismConfiguration' => '

Lists the parallelism configuration applied to the pipeline.

', 'Pipeline$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'PipelineExecution$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline execution.

', 'RetryPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

', 'StartPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineRequest$ParallelismConfiguration' => '

If specified, it applies to all executions of this pipeline by default.

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

Assigns a value to a named Pipeline parameter.

', 'refs' => [ 'ParameterList$member' => NULL, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$Name' => '

The name of the hyperparameter to optimize using Autotune.

', 'CategoricalParameterRange$Name' => '

The name of the categorical hyperparameter to tune.

', 'ContinuousParameterRange$Name' => '

The name of the continuous hyperparameter to tune.

', 'IntegerParameterRange$Name' => '

The name of the hyperparameter to search.

', ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineParametersForExecutionResponse$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'PipelineExecution$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'StartPipelineExecutionRequest$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Name' => '

The name of this hyperparameter. The name must be unique.

', ], ], 'ParameterRange' => [ 'base' => '

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecification$Range' => '

The allowed range for this hyperparameter.

', ], ], 'ParameterRanges' => [ 'base' => '

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can\'t exceed the maximum number specified.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterRanges' => NULL, 'HyperParameterTuningJobConfig$ParameterRanges' => '

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Type' => '

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$ValueHint' => '

An example value of the hyperparameter to optimize using Autotune.

', 'ContinuousParameterRange$MinValue' => '

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

', 'ContinuousParameterRange$MaxValue' => '

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

', 'ContinuousParameterRangeSpecification$MinValue' => '

The minimum floating-point value allowed.

', 'ContinuousParameterRangeSpecification$MaxValue' => '

The maximum floating-point value allowed.

', 'IntegerParameterRange$MinValue' => '

The minimum value of the hyperparameter to search.

', 'IntegerParameterRange$MaxValue' => '

The maximum value of the hyperparameter to search.

', 'IntegerParameterRangeSpecification$MinValue' => '

The minimum integer value allowed.

', 'IntegerParameterRangeSpecification$MaxValue' => '

The maximum integer value allowed.

', 'ParameterValues$member' => NULL, ], ], 'ParameterValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRange$Values' => '

A list of the categories for the hyperparameter.

', 'CategoricalParameterRangeSpecification$Values' => '

The allowed categories for the hyperparameter.

', ], ], 'Parent' => [ 'base' => '

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

', 'refs' => [ 'Parents$member' => NULL, ], ], 'ParentHyperParameterTuningJob' => [ 'base' => '

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'refs' => [ 'ParentHyperParameterTuningJobs$member' => NULL, ], ], 'ParentHyperParameterTuningJobs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs' => '

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

', ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'TrialComponent$Parents' => '

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

', ], ], 'PendingDeploymentSummary' => [ 'base' => '

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

', 'refs' => [ 'DescribeEndpointOutput$PendingDeploymentSummary' => '

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

', ], ], 'PendingProductionVariantSummary' => [ 'base' => '

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

', 'refs' => [ 'PendingProductionVariantSummaryList$member' => NULL, ], ], 'PendingProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'PendingDeploymentSummary$ProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

', 'PendingDeploymentSummary$ShadowProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$Percentage' => '

Percentage of devices in the fleet to deploy to the current stage.

', 'ShadowModelVariantConfig$SamplingPercentage' => '

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

', ], ], 'Phase' => [ 'base' => '

Defines the traffic pattern.

', 'refs' => [ 'Phases$member' => NULL, ], ], 'Phases' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$Phases' => '

Defines the phases traffic specification.

', ], ], 'Pipeline' => [ 'base' => '

A SageMaker Model Building Pipeline instance.

', 'refs' => [ 'SearchRecord$Pipeline' => NULL, ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the created pipeline.

', 'DeletePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline to delete.

', 'DescribePipelineExecutionResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'DescribePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'Pipeline$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'PipelineExecution$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline that was executed.

', 'PipelineSummary$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'UpdatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the updated pipeline.

', ], ], 'PipelineDefinition' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition of the pipeline.

', 'DescribePipelineDefinitionForExecutionResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'DescribePipelineResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'UpdatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition.

', ], ], 'PipelineDefinitionS3Location' => [ 'base' => '

The location of the pipeline definition stored in Amazon S3.

', 'refs' => [ 'CreatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', 'UpdatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', ], ], 'PipelineDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDescription' => '

A description of the pipeline.

', 'DescribePipelineResponse$PipelineDescription' => '

The description of the pipeline.

', 'Pipeline$PipelineDescription' => '

The description of the pipeline.

', 'PipelineSummary$PipelineDescription' => '

The description of the pipeline.

', 'UpdatePipelineRequest$PipelineDescription' => '

The description of the pipeline.

', ], ], 'PipelineExecution' => [ 'base' => '

An execution of a pipeline.

', 'refs' => [ 'SearchRecord$PipelineExecution' => NULL, ], ], 'PipelineExecutionArn' => [ 'base' => NULL, 'refs' => [ 'CacheHitResult$SourcePipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineExecutionStepsRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineParametersForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecution$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SelectiveExecutionConfig$SourcePipelineExecutionArn' => '

The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.

', 'SelectiveExecutionResult$SourcePipelineExecutionArn' => '

The ARN from an execution of the current pipeline.

', 'SendPipelineExecutionStepFailureResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StartPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the updated pipeline execution.

', ], ], 'PipelineExecutionDescription' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', ], ], 'PipelineExecutionFailureReason' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$FailureReason' => '

If the execution failed, a message describing why.

', 'PipelineExecution$FailureReason' => '

If the execution failed, a message describing why.

', ], ], 'PipelineExecutionName' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', ], ], 'PipelineExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionStatus' => '

The status of the pipeline execution.

', 'PipelineExecution$PipelineExecutionStatus' => '

The status of the pipeline status.

', 'PipelineExecutionSummary$PipelineExecutionStatus' => '

The status of the pipeline execution.

', ], ], 'PipelineExecutionStep' => [ 'base' => '

An execution of a step in a pipeline.

', 'refs' => [ 'PipelineExecutionStepList$member' => NULL, ], ], 'PipelineExecutionStepList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionStepsResponse$PipelineExecutionSteps' => '

A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

', ], ], 'PipelineExecutionStepMetadata' => [ 'base' => '

Metadata for a step execution.

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

Metadata to run the pipeline step.

', ], ], 'PipelineExecutionSummary' => [ 'base' => '

A pipeline execution summary.

', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsResponse$PipelineExecutionSummaries' => '

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

', ], ], 'PipelineExperimentConfig' => [ 'base' => '

Specifies the names of the experiment and trial created by a pipeline.

', 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExperimentConfig' => NULL, 'PipelineExecution$PipelineExperimentConfig' => NULL, ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => '

The name of the pipeline.

', 'CreatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', 'DeletePipelineRequest$PipelineName' => '

The name of the pipeline to delete.

', 'DescribePipelineResponse$PipelineName' => '

The name of the pipeline.

', 'DescribePipelineResponse$PipelineDisplayName' => '

The display name of the pipeline.

', 'ListPipelinesRequest$PipelineNamePrefix' => '

The prefix of the pipeline name.

', 'Pipeline$PipelineName' => '

The name of the pipeline.

', 'Pipeline$PipelineDisplayName' => '

The display name of the pipeline.

', 'PipelineSummary$PipelineName' => '

The name of the pipeline.

', 'PipelineSummary$PipelineDisplayName' => '

The display name of the pipeline.

', 'UpdatePipelineRequest$PipelineName' => '

The name of the pipeline to update.

', 'UpdatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', ], ], 'PipelineNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline to describe.

', 'ListPipelineExecutionsRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', 'StartPipelineExecutionRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', ], ], 'PipelineParameterName' => [ 'base' => NULL, 'refs' => [ 'Parameter$Name' => '

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineResponse$PipelineStatus' => '

The status of the pipeline execution.

', 'Pipeline$PipelineStatus' => '

The status of the pipeline.

', ], ], 'PipelineSummary' => [ 'base' => '

A summary of a pipeline.

', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$PipelineSummaries' => '

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

', ], ], 'PlatformIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', 'DescribeNotebookInstanceOutput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetModelPackageGroupPolicyOutput$ResourcePolicy' => '

The resource policy for the model group.

', 'PutModelPackageGroupPolicyInput$ResourcePolicy' => '

The resource policy for the model group.

', ], ], 'PredefinedMetricSpecification' => [ 'base' => '

A specification for a predefined metric.

', 'refs' => [ 'MetricSpecification$Predefined' => '

Information about a predefined metric.

', ], ], 'PresignedDomainUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlResponse$AuthorizedUrl' => '

The presigned URL.

', ], ], 'ProbabilityThresholdAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', 'EndpointInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', ], ], 'ProblemType' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$ProblemType' => '

Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.

', 'DescribeAutoMLJobResponse$ProblemType' => '

Returns the job\'s problem type.

', 'ResolvedAttributes$ProblemType' => '

The problem type.

', 'TabularJobConfig$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see SageMaker Autopilot problem types.

You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.

', 'TabularResolvedAttributes$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see SageMaker Autopilot problem types.

', ], ], 'ProcessingClusterConfig' => [ 'base' => '

Configuration for the cluster used to run a processing job.

', 'refs' => [ 'ProcessingResources$ClusterConfig' => '

The configuration for the resources in a cluster used to run the processing job.

', ], ], 'ProcessingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$key' => NULL, 'ProcessingEnvironmentMap$key' => NULL, ], ], 'ProcessingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$Environment' => '

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

', 'DescribeProcessingJobResponse$Environment' => '

The environment variables set in the Docker container.

', 'ProcessingJob$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'ProcessingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$value' => NULL, 'ProcessingEnvironmentMap$value' => NULL, ], ], 'ProcessingFeatureStoreOutput' => [ 'base' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store.

', 'refs' => [ 'ProcessingOutput$FeatureStoreOutput' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

', ], ], 'ProcessingInput' => [ 'base' => '

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

', 'refs' => [ 'ProcessingInputs$member' => NULL, ], ], 'ProcessingInputs' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingInputs' => '

An array of inputs configuring the data to download into the processing container.

', 'DescribeProcessingJobResponse$ProcessingInputs' => '

The inputs for a processing job.

', 'ProcessingJob$ProcessingInputs' => '

List of input configurations for the processing job.

', ], ], 'ProcessingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', 'ProcessingClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', ], ], 'ProcessingInstanceType' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for debugging a training job.

', 'MonitoringClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProcessingClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProfilerRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for profiling a training job.

', ], ], 'ProcessingJob' => [ 'base' => '

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

', 'refs' => [ 'TrialComponentSourceDetail$ProcessingJob' => '

Information about a processing job that\'s the source of a trial component.

', ], ], 'ProcessingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'DebugRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', 'DescribeProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'MonitoringExecutionSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', 'ProcessingJob$ProcessingJobArn' => '

The ARN of the processing job.

', 'ProcessingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'ProcessingJobSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job..

', 'ProfilerRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', ], ], 'ProcessingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DataQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the data quality monitoring job.

', 'DescribeProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeProcessingJobResponse$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ModelBiasBaselineConfig$BaseliningJobName' => '

The name of the baseline model bias job.

', 'ModelExplainabilityBaselineConfig$BaseliningJobName' => '

The name of the baseline model explainability job.

', 'ModelQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'MonitoringBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'ProcessingJob$ProcessingJobName' => '

The name of the processing job.

', 'ProcessingJobSummary$ProcessingJobName' => '

The name of the processing job.

', 'StopProcessingJobRequest$ProcessingJobName' => '

The name of the processing job to stop.

', ], ], 'ProcessingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ProcessingJobStatus' => '

Provides the status of a processing job.

', 'ListProcessingJobsRequest$StatusEquals' => '

A filter that retrieves only processing jobs with a specific status.

', 'ProcessingJob$ProcessingJobStatus' => '

The status of the processing job.

', 'ProcessingJobSummary$ProcessingJobStatus' => '

The status of the processing job.

', ], ], 'ProcessingJobStepMetadata' => [ 'base' => '

Metadata for a processing job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$ProcessingJob' => '

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

', ], ], 'ProcessingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProcessingJobsResponse$ProcessingJobSummaries' => '

An array of ProcessingJobSummary objects, each listing a processing job.

', ], ], 'ProcessingJobSummary' => [ 'base' => '

Summary of information about a processing job.

', 'refs' => [ 'ProcessingJobSummaries$member' => NULL, ], ], 'ProcessingLocalPath' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$LocalPath' => '

Path to the filesystem where the batch transform data is available to the container.

', 'DatasetDefinition$LocalPath' => '

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

', 'EndpointInput$LocalPath' => '

Path to the filesystem where the endpoint data is available to the container.

', 'MonitoringS3Output$LocalPath' => '

The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

', 'ProcessingS3Input$LocalPath' => '

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

', 'ProcessingS3Output$LocalPath' => '

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container\'s entrypoint is invoked.

', ], ], 'ProcessingMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ProcessingStoppingCondition$MaxRuntimeInSeconds' => '

Specifies the maximum runtime in seconds.

', ], ], 'ProcessingOutput' => [ 'base' => '

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

', 'refs' => [ 'ProcessingOutputs$member' => NULL, ], ], 'ProcessingOutputConfig' => [ 'base' => '

Configuration for uploading output from the processing container.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'DescribeProcessingJobResponse$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'ProcessingJob$ProcessingOutputConfig' => NULL, ], ], 'ProcessingOutputs' => [ 'base' => NULL, 'refs' => [ 'ProcessingOutputConfig$Outputs' => '

An array of outputs configuring the data to upload from the processing container.

', ], ], 'ProcessingResources' => [ 'base' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'DescribeProcessingJobResponse$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'ProcessingJob$ProcessingResources' => NULL, ], ], 'ProcessingS3CompressionType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3CompressionType' => '

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

', ], ], 'ProcessingS3DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

', 'EndpointInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

', 'ProcessingS3Input$S3DataDistributionType' => '

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

', ], ], 'ProcessingS3DataType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3DataType' => '

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

', ], ], 'ProcessingS3Input' => [ 'base' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', 'refs' => [ 'ProcessingInput$S3Input' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', ], ], 'ProcessingS3InputMode' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'EndpointInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'ProcessingS3Input$S3InputMode' => '

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

', ], ], 'ProcessingS3Output' => [ 'base' => '

Configuration for uploading output data to Amazon S3 from the processing container.

', 'refs' => [ 'ProcessingOutput$S3Output' => '

Configuration for processing job outputs in Amazon S3.

', ], ], 'ProcessingS3UploadMode' => [ 'base' => NULL, 'refs' => [ 'MonitoringS3Output$S3UploadMode' => '

Whether to upload the results of the monitoring job continuously or after the job completes.

', 'ProcessingS3Output$S3UploadMode' => '

Whether to upload the results of the processing job continuously or after the job completes.

', ], ], 'ProcessingStoppingCondition' => [ 'base' => '

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

', 'refs' => [ 'CreateProcessingJobRequest$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'DescribeProcessingJobResponse$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'ProcessingJob$StoppingCondition' => NULL, ], ], 'ProcessingVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

', 'ProcessingClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can\'t request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

', ], ], 'Processor' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'DescribeImageVersionResponse$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'UpdateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', ], ], 'ProductId' => [ 'base' => NULL, 'refs' => [ 'DescribeAlgorithmOutput$ProductId' => '

The product identifier of the algorithm.

', 'ModelPackageContainerDefinition$ProductId' => '

The Amazon Web Services Marketplace product ID of the model package.

', ], ], 'ProductListings' => [ 'base' => NULL, 'refs' => [ 'Workteam$ProductListingIds' => '

The Amazon Marketplace identifier for a vendor\'s work team.

', ], ], 'ProductionVariant' => [ 'base' => '

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

', 'refs' => [ 'ProductionVariantList$member' => NULL, ], ], 'ProductionVariantAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'ProductionVariant$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', 'ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', ], ], 'ProductionVariantCoreDumpConfig' => [ 'base' => '

Specifies configuration for a core dump from the model container when the process crashes.

', 'refs' => [ 'ProductionVariant$CoreDumpConfig' => '

Specifies configuration for a core dump from the model container when the process crashes.

', ], ], 'ProductionVariantInstanceType' => [ 'base' => NULL, 'refs' => [ 'EndpointInputConfiguration$InstanceType' => '

The instance types to use for the load test.

', 'EndpointOutputConfiguration$InstanceType' => '

The instance type recommended by Amazon SageMaker Inference Recommender.

', 'PendingProductionVariantSummary$InstanceType' => '

The type of instances associated with the variant.

', 'ProductionVariant$InstanceType' => '

The ML compute instance type.

', 'RealTimeInferenceRecommendation$InstanceType' => '

The recommended instance type for Real-Time Inference.

', 'RealtimeInferenceInstanceTypes$member' => NULL, ], ], 'ProductionVariantList' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'CreateEndpointConfigInput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

', 'DescribeEndpointConfigOutput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'DescribeEndpointConfigOutput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', ], ], 'ProductionVariantManagedInstanceScaling' => [ 'base' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'refs' => [ 'PendingProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariant$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

', 'ProductionVariant$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

', ], ], 'ProductionVariantRoutingConfig' => [ 'base' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'refs' => [ 'PendingProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariant$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', ], ], 'ProductionVariantSSMAccess' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$EnableSSMAccess' => '

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

', ], ], 'ProductionVariantServerlessConfig' => [ 'base' => '

Specifies the serverless configuration for an endpoint variant.

', 'refs' => [ 'EndpointInputConfiguration$ServerlessConfig' => NULL, 'EndpointOutputConfiguration$ServerlessConfig' => NULL, 'PendingProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'PendingProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

', 'ProductionVariant$ServerlessConfig' => '

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

', 'ProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'ProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for the endpoint update.

', ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'base' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', 'refs' => [ 'DesiredWeightAndCapacity$ServerlessUpdateConfig' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', ], ], 'ProductionVariantStatus' => [ 'base' => '

Describes the status of the production variant.

', 'refs' => [ 'ProductionVariantStatusList$member' => NULL, ], ], 'ProductionVariantStatusList' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', 'ProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', ], ], 'ProductionVariantSummary' => [ 'base' => '

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

', 'refs' => [ 'ProductionVariantSummaryList$member' => NULL, ], ], 'ProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$ProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

', 'DescribeEndpointOutput$ShadowProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', 'Endpoint$ProductionVariants' => '

A list of the production variants hosted on the endpoint. Each production variant is a model.

', 'Endpoint$ShadowProductionVariants' => '

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

', ], ], 'ProductionVariantVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

', ], ], 'ProfilerConfig' => [ 'base' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', 'refs' => [ 'CreateTrainingJobRequest$ProfilerConfig' => NULL, 'DescribeTrainingJobResponse$ProfilerConfig' => NULL, 'TrainingJob$ProfilerConfig' => NULL, ], ], 'ProfilerConfigForUpdate' => [ 'base' => '

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

', 'refs' => [ 'UpdateTrainingJobRequest$ProfilerConfig' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', ], ], 'ProfilerRuleConfiguration' => [ 'base' => '

Configuration information for profiling rules.

', 'refs' => [ 'ProfilerRuleConfigurations$member' => NULL, ], ], 'ProfilerRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'DescribeTrainingJobResponse$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'UpdateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', ], ], 'ProfilerRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'ProfilerRuleEvaluationStatuses$member' => NULL, ], ], 'ProfilerRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

', ], ], 'ProfilingIntervalInMilliseconds' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', 'ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', ], ], 'ProfilingParameters' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'ProfilerConfigForUpdate$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'ProfilingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilingStatus' => '

Profiling status of a training job.

', ], ], 'ProgrammingLang' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', 'DescribeImageVersionResponse$ProgrammingLang' => '

The supported programming language and its version.

', 'UpdateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', ], ], 'Project' => [ 'base' => '

The properties of a project as returned by the Search API.

', 'refs' => [ 'SearchRecord$Project' => '

The properties of a project.

', ], ], 'ProjectArn' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'DescribeProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'Project$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'ProjectSummary$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'UpdateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', ], ], 'ProjectEntityName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$ProjectName' => '

The name of the project.

', 'DeleteProjectInput$ProjectName' => '

The name of the project to delete.

', 'DescribeProjectInput$ProjectName' => '

The name of the project to describe.

', 'DescribeProjectOutput$ProjectName' => '

The name of the project.

', 'ListProjectsInput$NameContains' => '

A filter that returns the projects whose name contains a specified string.

', 'Project$ProjectName' => '

The name of the project.

', 'ProjectSummary$ProjectName' => '

The name of the project.

', 'UpdateProjectInput$ProjectName' => '

The name of the project.

', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectId' => '

The ID of the new project.

', 'DescribeProjectOutput$ProjectId' => '

The ID of the project.

', 'Project$ProjectId' => '

The ID of the project.

', 'ProjectSummary$ProjectId' => '

The ID of the project.

', ], ], 'ProjectSortBy' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ProjectSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'ProjectStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProjectOutput$ProjectStatus' => '

The status of the project.

', 'Project$ProjectStatus' => '

The status of the project.

', 'ProjectSummary$ProjectStatus' => '

The status of the project.

', ], ], 'ProjectSummary' => [ 'base' => '

Information about a project.

', 'refs' => [ 'ProjectSummaryList$member' => NULL, ], ], 'ProjectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListProjectsOutput$ProjectSummaryList' => '

A list of summaries of projects.

', ], ], 'PropertyNameHint' => [ 'base' => NULL, 'refs' => [ 'PropertyNameQuery$PropertyNameHint' => '

Text that begins a property\'s name.

', ], ], 'PropertyNameQuery' => [ 'base' => '

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

', 'refs' => [ 'SuggestionQuery$PropertyNameQuery' => '

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

', ], ], 'PropertyNameSuggestion' => [ 'base' => '

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

', 'refs' => [ 'PropertyNameSuggestionList$member' => NULL, ], ], 'PropertyNameSuggestionList' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsResponse$PropertyNameSuggestions' => '

A list of property names for a Resource that match a SuggestionQuery.

', ], ], 'ProvisionedProductStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductStatusMessage' => '

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', ], ], 'ProvisioningParameter' => [ 'base' => '

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Key' => '

The key that identifies a provisioning parameter.

', ], ], 'ProvisioningParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => '

The value of the provisioning parameter.

', ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisioningDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', ], ], 'PublicWorkforceTaskPrice' => [ 'base' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

', 'refs' => [ 'HumanLoopConfig$PublicWorkforceTaskPrice' => NULL, 'HumanTaskConfig$PublicWorkforceTaskPrice' => '

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

', ], ], 'PutModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'QualityCheckStepMetadata' => [ 'base' => '

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$QualityCheck' => '

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The Boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'QueryFilters' => [ 'base' => '

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

', 'refs' => [ 'QueryLineageRequest$Filters' => '

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities\' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

', ], ], 'QueryLineageMaxDepth' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxDepth' => '

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

', ], ], 'QueryLineageMaxResults' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxResults' => '

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'QueryLineageRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageStartArns' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$StartArns' => '

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

', ], ], 'QueryLineageTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$LineageTypes' => '

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

', ], ], 'QueryProperties' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Properties' => '

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

', ], ], 'QueryTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Types' => '

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

', ], ], 'RSessionAppSettings' => [ 'base' => '

A collection of settings that apply to an RSessionGateway app.

', 'refs' => [ 'UserSettings$RSessionAppSettings' => '

A collection of settings that configure the RSessionGateway app.

', ], ], 'RStudioServerProAccessStatus' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$AccessStatus' => '

Indicates whether the current user has access to the RStudioServerPro app.

', ], ], 'RStudioServerProAppSettings' => [ 'base' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', 'refs' => [ 'UserSettings$RStudioServerProAppSettings' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', ], ], 'RStudioServerProDomainSettings' => [ 'base' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettings$RStudioServerProDomainSettings' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'base' => '

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettingsForUpdate$RStudioServerProDomainSettingsForUpdate' => '

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

', ], ], 'RStudioServerProUserGroup' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$UserGroup' => '

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

', ], ], 'RandomSeed' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$RandomSeed' => '

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

', ], ], 'RealTimeInferenceConfig' => [ 'base' => '

The infrastructure configuration for deploying the model to a real-time inference endpoint.

', 'refs' => [ 'ModelInfrastructureConfig$RealTimeInferenceConfig' => '

The infrastructure configuration for deploying the model to real-time inference.

', ], ], 'RealTimeInferenceRecommendation' => [ 'base' => '

The recommended configuration to use for Real-Time Inference.

', 'refs' => [ 'RealTimeInferenceRecommendations$member' => NULL, ], ], 'RealTimeInferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RealTimeInferenceRecommendations' => '

A list of RealTimeInferenceRecommendation items.

', ], ], 'RealtimeInferenceInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', 'InferenceSpecification$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'RecommendationFailureReason' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInferenceBenchmark$FailureReason' => '

The reason why a benchmark failed.

', ], ], 'RecommendationJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'InferenceRecommendationsJob$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', ], ], 'RecommendationJobCompilationJobName' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$CompilationJobName' => '

The name of the compilation job used to create the recommended model artifacts.

', ], ], 'RecommendationJobCompiledOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'RecommendationJobOutputConfig$CompiledOutputConfig' => '

Provides information about the output configuration for the compiled model.

', ], ], 'RecommendationJobContainerConfig' => [ 'base' => '

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don\'t want to edit them in your model package.

', 'refs' => [ 'RecommendationJobInputConfig$ContainerConfig' => '

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

', ], ], 'RecommendationJobDataInputConfig' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

', ], ], 'RecommendationJobDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobDescription' => '

Description of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobDescription' => '

The job description that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobDescription' => '

The job description.

', ], ], 'RecommendationJobFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$FrameworkVersion' => '

The framework version of the container image.

', ], ], 'RecommendationJobInferenceBenchmark' => [ 'base' => '

The details for a specific benchmark from an Inference Recommender job.

', 'refs' => [ 'InferenceRecommendationsJobStep$InferenceBenchmark' => '

The details for a specific benchmark.

', ], ], 'RecommendationJobInputConfig' => [ 'base' => '

The input configuration of the recommendation job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$InputConfig' => '

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

', 'DescribeInferenceRecommendationsJobResponse$InputConfig' => '

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

', ], ], 'RecommendationJobName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobName' => '

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

', 'DescribeInferenceRecommendationsJobRequest$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeInferenceRecommendationsJobResponse$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'InferenceRecommendationsJob$JobName' => '

The name of the job.

', 'InferenceRecommendationsJobStep$JobName' => '

The name of the Inference Recommender job.

', 'ListInferenceRecommendationsJobStepsRequest$JobName' => '

The name for the Inference Recommender job.

', 'StopInferenceRecommendationsJobRequest$JobName' => '

The name of the job you want to stop.

', ], ], 'RecommendationJobOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$OutputConfig' => '

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

', ], ], 'RecommendationJobPayloadConfig' => [ 'base' => '

The configuration for the payload for a recommendation job.

', 'refs' => [ 'RecommendationJobContainerConfig$PayloadConfig' => '

Specifies the SamplePayloadUrl and all other sample payload-related fields.

', ], ], 'RecommendationJobResourceLimit' => [ 'base' => '

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

', 'refs' => [ 'RecommendationJobInputConfig$ResourceLimit' => '

Defines the resource limit of the job.

', ], ], 'RecommendationJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$Status' => '

The status of the job.

', 'InferenceRecommendationsJob$Status' => '

The status of the job.

', 'InferenceRecommendationsJobStep$Status' => '

The current status of the benchmark.

', 'ListInferenceRecommendationsJobStepsRequest$Status' => '

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

', 'ListInferenceRecommendationsJobsRequest$StatusEquals' => '

A filter that retrieves only inference recommendations jobs with a specific status.

', ], ], 'RecommendationJobStoppingConditions' => [ 'base' => '

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$StoppingConditions' => '

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

', 'DescribeInferenceRecommendationsJobResponse$StoppingConditions' => '

The stopping conditions that you provided when you initiated the job.

', ], ], 'RecommendationJobSupportedContentType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedContentTypes$member' => NULL, ], ], 'RecommendationJobSupportedContentTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobPayloadConfig$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'RecommendationJobSupportedEndpointType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedEndpointType' => '

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedResponseMIMETypes$member' => NULL, ], ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RecommendationJobType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobType' => '

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

', 'DescribeInferenceRecommendationsJobResponse$JobType' => '

The job type that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobType' => '

The recommendation job type.

', ], ], 'RecommendationJobVpcConfig' => [ 'base' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', 'refs' => [ 'RecommendationJobInputConfig$VpcConfig' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSecurityGroupIds$member' => NULL, ], ], 'RecommendationJobVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'RecommendationJobVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSubnets$member' => NULL, ], ], 'RecommendationJobVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your model.

', ], ], 'RecommendationMetrics' => [ 'base' => '

The metrics of recommendations.

', 'refs' => [ 'InferenceRecommendation$Metrics' => '

The metrics used to decide what recommendation to make.

', 'RecommendationJobInferenceBenchmark$Metrics' => NULL, ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RecommendationStatus' => '

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

', ], ], 'RecommendationStepType' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendationsJobStep$StepType' => '

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobStepsRequest$StepType' => '

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', ], ], 'RecordWrapper' => [ 'base' => NULL, 'refs' => [ 'Channel$RecordWrapperType' => '

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don\'t need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

', ], ], 'RedshiftClusterId' => [ 'base' => '

The Redshift cluster Identifier.

', 'refs' => [ 'RedshiftDatasetDefinition$ClusterId' => NULL, ], ], 'RedshiftDatabase' => [ 'base' => '

The name of the Redshift database used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$Database' => NULL, ], ], 'RedshiftDatasetDefinition' => [ 'base' => '

Configuration for Redshift Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$RedshiftDatasetDefinition' => NULL, ], ], 'RedshiftQueryString' => [ 'base' => '

The SQL query statements to be executed.

', 'refs' => [ 'RedshiftDatasetDefinition$QueryString' => NULL, ], ], 'RedshiftResultCompressionType' => [ 'base' => '

The compression used for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputCompression' => NULL, ], ], 'RedshiftResultFormat' => [ 'base' => '

The data storage format for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputFormat' => NULL, ], ], 'RedshiftUserName' => [ 'base' => '

The database user name used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$DbUser' => NULL, ], ], 'RegisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterModelStepMetadata' => [ 'base' => '

Metadata for a register model job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$RegisterModel' => '

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', 'DescribeImageVersionResponse$ReleaseNotes' => '

The maintainer description of the image version.

', 'UpdateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', ], ], 'RemoteDebugConfig' => [ 'base' => '

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'CreateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'DescribeTrainingJobResponse$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RemoteDebugConfigForUpdate' => [ 'base' => '

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'UpdateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RenderUiTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RenderUiTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderableTask' => [ 'base' => '

Contains input values for a task.

', 'refs' => [ 'RenderUiTemplateRequest$Task' => '

A RenderableTask object containing a representative task to render.

', ], ], 'RenderingError' => [ 'base' => '

A description of an error that occurred while rendering the template.

', 'refs' => [ 'RenderingErrorList$member' => NULL, ], ], 'RenderingErrorList' => [ 'base' => NULL, 'refs' => [ 'RenderUiTemplateResponse$Errors' => '

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

', ], ], 'RepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'ImageConfig$RepositoryAccessMode' => '

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.

  • Vpc - The model image is hosted in a private Docker registry in your VPC.

', ], ], 'RepositoryAuthConfig' => [ 'base' => '

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

', 'refs' => [ 'ImageConfig$RepositoryAuthConfig' => '

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

', ], ], 'RepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'RepositoryAuthConfig$RepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

', ], ], 'RepositoryUrl' => [ 'base' => NULL, 'refs' => [ 'CodeRepository$RepositoryUrl' => '

The URL of the Git repository.

', ], ], 'ResolvedAttributes' => [ 'base' => '

The resolved attributes.

', 'refs' => [ 'DescribeAutoMLJobResponse$ResolvedAttributes' => '

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to tag.

', 'DeleteTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

', 'ListTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

', ], ], 'ResourceCatalog' => [ 'base' => '

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'ResourceCatalogList$member' => NULL, ], ], 'ResourceCatalogArn' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$ResourceCatalogArn' => '

The Amazon Resource Name (ARN) of the ResourceCatalog.

', ], ], 'ResourceCatalogDescription' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$Description' => '

A free form description of the ResourceCatalog.

', ], ], 'ResourceCatalogList' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsResponse$ResourceCatalogs' => '

A list of the requested ResourceCatalogs.

', ], ], 'ResourceCatalogName' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$NameContains' => '

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

', 'ResourceCatalog$ResourceCatalogName' => '

The name of the ResourceCatalog.

', ], ], 'ResourceCatalogSortBy' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortBy' => '

The value on which the resource catalog list is sorted.

', ], ], 'ResourceCatalogSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortOrder' => '

The order in which the resource catalogs are listed.

', ], ], 'ResourceConfig' => [ 'base' => '

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

', 'refs' => [ 'CreateTrainingJobRequest$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

', 'DescribeTrainingJobResponse$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'HyperParameterTrainingJobDefinition$ResourceConfig' => '

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

', 'TrainingJob$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'TrainingJobDefinition$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

', ], ], 'ResourceConfigForUpdate' => [ 'base' => '

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

', 'refs' => [ 'UpdateTrainingJobRequest$ResourceConfig' => '

The training job ResourceConfig to update warm pool retention length.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$HomeEfsFileSystemId' => '

The ID of the Amazon Elastic File System managed by this Domain.

', ], ], 'ResourceInUse' => [ 'base' => '

Resource being accessed is in use.

', 'refs' => [], ], 'ResourceLimitExceeded' => [ 'base' => '

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

', 'refs' => [], ], 'ResourceLimits' => [ 'base' => '

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

', 'refs' => [ 'HyperParameterTuningJobConfig$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

', ], ], 'ResourceNotFound' => [ 'base' => '

Resource being access is not found.

', 'refs' => [], ], 'ResourcePolicyString' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyResponse$ResourcePolicy' => '

The resource policy that gives access to the lineage group in another account.

', ], ], 'ResourcePropertyName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

', 'NestedFilters$NestedPropertyName' => '

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

', 'PropertyNameSuggestion$PropertyName' => '

A suggested property name based on what you entered in the search textbox in the SageMaker console.

', 'SearchRequest$SortBy' => '

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

', ], ], 'ResourceRetainedBillableTimeInSeconds' => [ 'base' => 'Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.', 'refs' => [ 'WarmPoolStatus$ResourceRetainedBillableTimeInSeconds' => '

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

', ], ], 'ResourceSpec' => [ 'base' => '

Specifies the ARN\'s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

', 'refs' => [ 'AppDetails$ResourceSpec' => NULL, 'CodeEditorAppSettings$DefaultResourceSpec' => NULL, 'CreateAppRequest$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

', 'DescribeAppResponse$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', 'JupyterLabAppSettings$DefaultResourceSpec' => NULL, 'JupyterServerAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

', 'KernelGatewayAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

', 'RSessionAppSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettingsForUpdate$DefaultResourceSpec' => NULL, 'SpaceCodeEditorAppSettings$DefaultResourceSpec' => NULL, 'SpaceJupyterLabAppSettings$DefaultResourceSpec' => NULL, 'TensorBoardAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsRequest$Resource' => '

The name of the SageMaker resource to search for.

', 'SearchRequest$Resource' => '

The name of the SageMaker resource to search for.

', ], ], 'ResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'ResponseMIMETypes$member' => NULL, ], ], 'ResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', 'InferenceSpecification$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RetentionPolicy' => [ 'base' => '

The retention policy for data stored on an Amazon Elastic File System volume.

', 'refs' => [ 'DeleteDomainRequest$RetentionPolicy' => '

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

', ], ], 'RetentionType' => [ 'base' => NULL, 'refs' => [ 'RetentionPolicy$HomeEfsFileSystem' => '

The default is Retain, which specifies to keep the data stored on the Amazon EFS volume.

Specify Delete to delete the data stored on the Amazon EFS volume.

', ], ], 'RetryPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetryPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetryStrategy' => [ 'base' => '

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

', 'refs' => [ 'CreateTrainingJobRequest$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'DescribeTrainingJobResponse$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'HyperParameterTrainingJobDefinition$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'TrainingJob$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationRole' => '

The IAM roles that SageMaker uses to run the training jobs.

', 'ClusterInstanceGroupDetails$ExecutionRole' => '

The execution role for the instance group to assume.

', 'ClusterInstanceGroupSpecification$ExecutionRole' => '

Specifies an IAM execution role to be assumed by the instance group.

', 'CreateAutoMLJobRequest$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateAutoMLJobV2Request$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateCompilationJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

', 'CreateDataQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'CreateEdgePackagingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

', 'CreateEndpointConfigInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

', 'CreateFeatureGroupRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'CreateFlowDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

', 'CreateImageRequest$RoleArn' => '

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateInferenceExperimentRequest$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'CreateInferenceRecommendationsJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateLabelingJobRequest$RoleArn' => '

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

', 'CreateModelBiasJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelExplainabilityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreateModelQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateNotebookInstanceInput$RoleArn' => '

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

', 'CreateProcessingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateTrainingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'DefaultSpaceSettings$ExecutionRole' => '

The ARN of the execution role for the space.

', 'DescribeAutoMLJobResponse$RoleArn' => '

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeAutoMLJobV2Response$RoleArn' => '

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeCompilationJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

', 'DescribeDataQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeDeviceFleetResponse$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'DescribeEdgePackagingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

', 'DescribeEndpointConfigOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

', 'DescribeFeatureGroupResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'DescribeFlowDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

', 'DescribeImageResponse$RoleArn' => '

The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'DescribeInferenceExperimentResponse$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'DescribeInferenceRecommendationsJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

', 'DescribeLabelingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

', 'DescribeModelBiasJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelExplainabilityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'DescribeModelQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeNotebookInstanceOutput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

', 'DescribePipelineResponse$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'DescribeProcessingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeTrainingJobResponse$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'FeatureGroup$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

', 'GenerativeAiSettings$AmazonBedrockRoleArn' => '

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

', 'HyperParameterTrainingJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

', 'InferenceExperimentSummary$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'InferenceRecommendationsJob$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'Model$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'ModelPackageValidationSpecification$ValidationRole' => '

The IAM roles to be used for the validation of the model package.

', 'ModelRegisterSettings$CrossAccountModelRegisterRoleArn' => '

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

', 'MonitoringJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'Pipeline$RoleArn' => '

The Amazon Resource Name (ARN) of the role that created the pipeline.

', 'PipelineSummary$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline used to execute.

', 'ProcessingJob$RoleArn' => '

The ARN of the role used to create the processing job.

', 'RStudioServerProDomainSettings$DomainExecutionRoleArn' => '

The ARN of the execution role for the RStudioServerPro Domain-level app.

', 'RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn' => '

The execution role for the RStudioServerPro Domain-level app.

', 'RedshiftDatasetDefinition$ClusterRoleArn' => '

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

', 'RenderUiTemplateRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

', 'TimeSeriesForecastingSettings$AmazonForecastRoleArn' => '

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

', 'TrainingJob$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'UpdateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the device.

', 'UpdateImageRequest$RoleArn' => '

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'UpdateNotebookInstanceInput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'UpdatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'UserSettings$ExecutionRole' => '

The execution role for the user.

', ], ], 'RollingUpdatePolicy' => [ 'base' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', 'refs' => [ 'DeploymentConfig$RollingUpdatePolicy' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', ], ], 'RootAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'DescribeNotebookInstanceOutput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'UpdateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don\'t have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

', ], ], 'RoutingStrategy' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantRoutingConfig$RoutingStrategy' => '

Sets how the endpoint routes incoming traffic:

  • LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.

  • RANDOM: The endpoint routes each request to a randomly chosen instance.

', ], ], 'RuleConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'DebugRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', 'ProfilerRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'ProfilerRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', ], ], 'RuleEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', 'ProfilerRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', ], ], 'RuleParameters' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', 'ProfilerRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', ], ], 'S3DataDistribution' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataDistributionType' => '

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don\'t choose more ML compute instances for training than available S3 objects. If you do, some nodes won\'t get any data and you will pay for nodes that aren\'t getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

', ], ], 'S3DataSource' => [ 'base' => '

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

', 'refs' => [ 'DataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'S3DataType' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel\'s input mode is Pipe.

', 'TransformS3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

', ], ], 'S3ModelDataSource' => [ 'base' => '

Specifies the S3 location of ML model data to deploy.

', 'refs' => [ 'ModelDataSource$S3DataSource' => '

Specifies the S3 location of ML model data to deploy.

', ], ], 'S3ModelDataType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3DataType' => '

Specifies the type of ML model data to deploy.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.

', ], ], 'S3ModelUri' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3Uri' => '

Specifies the S3 path of ML model data to deploy.

', ], ], 'S3OutputPath' => [ 'base' => NULL, 'refs' => [ 'HubS3StorageConfig$S3OutputPath' => '

The Amazon S3 bucket prefix for hosting hub content.

', ], ], 'S3StorageConfig' => [ 'base' => '

The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$S3StorageConfig' => '

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3Uri' => '

The uniform resource identifier (URI) used to identify an additional data source used in inference or training.

', 'AthenaDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where Athena query results are stored.

', 'AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'AutoMLOutputDataConfig$S3OutputPath' => '

The Amazon S3 output path. Must be 128 characters or less.

', 'AutoMLS3DataSource$S3Uri' => '

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.

', 'BatchDataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'CheckpointConfig$S3Uri' => '

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

', 'ClusterLifeCycleConfig$SourceS3Uri' => '

An Amazon S3 bucket path where your lifecycle scripts are stored.

Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.

', 'CreateLabelingJobRequest$LabelCategoryConfigS3Uri' => '

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to "labels", you must provide worker instructions in the label category configuration file using the "instructions" parameter: "instructions": {"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

"document-version": "2018-11-28",

"labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.

  • Each label category must be unique, you cannot specify duplicate label categories.

  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

', 'CreateModelPackageInput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

', 'DataQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'DataQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'DebugHookConfig$S3OutputPath' => '

Path to Amazon S3 storage location for metrics and tensors.

', 'DebugRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'DescribeEdgePackagingJobResponse$ModelArtifact' => '

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

', 'DescribeLabelingJobResponse$LabelCategoryConfigS3Uri' => '

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

', 'EdgeOutputConfig$S3OutputLocation' => '

The Amazon Simple Storage (S3) bucker URI.

', 'FileSource$S3Uri' => '

The Amazon S3 URI for the file source.

', 'FlowDefinitionOutputConfig$S3OutputPath' => '

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

', 'InferenceRecommendationsJob$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InputConfig$S3Uri' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'LabelingJobOutput$OutputDatasetS3Uri' => '

The Amazon S3 bucket location of the manifest file for labeled data.

', 'LabelingJobOutputConfig$S3OutputPath' => '

The Amazon S3 location to write output data.

', 'LabelingJobS3DataSource$ManifestS3Uri' => '

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.

  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

', 'MetricsSource$S3Uri' => '

The S3 URI for the metrics source.

', 'ModelArtifacts$S3ModelArtifacts' => '

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

', 'ModelBiasAppSpecification$ConfigUri' => '

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

', 'ModelCardExportArtifacts$S3ExportArtifacts' => '

The Amazon S3 URI of the exported model artifacts.

', 'ModelCardExportOutputConfig$S3OutputPath' => '

The Amazon S3 output path to export your model card PDF.

', 'ModelExplainabilityAppSpecification$ConfigUri' => '

JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

', 'ModelQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringConstraintsResource$S3Uri' => '

The Amazon S3 URI for the constraints resource.

', 'MonitoringStatisticsResource$S3Uri' => '

The Amazon S3 URI for the statistics resource.

', 'OutputConfig$S3OutputLocation' => '

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'OutputDataConfig$S3OutputPath' => '

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'ProcessingS3Input$S3Uri' => '

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

', 'ProcessingS3Output$S3Uri' => '

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

', 'ProfilerConfig$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerConfigForUpdate$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'RecommendationJobCompiledOutputConfig$S3OutputUri' => '

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

', 'RecommendationJobPayloadConfig$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'RedshiftDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where the Redshift query results are stored.

', 'S3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same Amazon Web Services region as your training job.

', 'S3StorageConfig$S3Uri' => '

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

', 'S3StorageConfig$ResolvedOutputS3Uri' => '

The S3 path where offline records are written.

', 'SharingSettings$S3OutputPath' => '

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

', 'TabularJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'TensorBoardOutputConfig$S3OutputPath' => '

Path to Amazon S3 storage location for TensorBoard output.

', 'TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.

You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

Autopilot supports the following data types: numeric, categorical, text, and datetime.

These column keys must not include any column set in TimeSeriesConfig.

', 'TransformOutput$S3OutputPath' => '

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn\'t upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

', 'TransformS3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

', 'UiConfig$UiTemplateS3Uri' => '

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

', 'WorkspaceSettings$S3ArtifactPath' => '

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

', ], ], 'SageMakerImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'DeleteImageVersionRequest$Alias' => '

The alias of the image to delete.

', 'DescribeImageVersionRequest$Alias' => '

The alias of the image version.

', 'ListAliasesRequest$Alias' => '

The alias of the image version.

', 'SageMakerImageVersionAliases$member' => NULL, 'UpdateImageVersionRequest$Alias' => '

The alias of the image version.

', ], ], 'SageMakerImageVersionAliases' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Aliases' => '

A list of aliases created with the image version.

', 'ListAliasesResponse$SageMakerImageVersionAliases' => '

A list of SageMaker image version aliases.

', 'UpdateImageVersionRequest$AliasesToAdd' => '

A list of aliases to add.

', 'UpdateImageVersionRequest$AliasesToDelete' => '

A list of aliases to delete.

', ], ], 'SagemakerServicecatalogStatus' => [ 'base' => NULL, 'refs' => [ 'GetSagemakerServicecatalogPortfolioStatusOutput$Status' => '

Whether Service Catalog is enabled or disabled in SageMaker.

', ], ], 'SampleWeightAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', 'TabularJobConfig$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', ], ], 'SamplingPercentage' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$InitialSamplingPercentage' => '

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

', 'DataCaptureConfigSummary$CurrentSamplingPercentage' => '

The percentage of requests being captured by your Endpoint.

', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'DynamicScalingConfiguration$ScalingPolicies' => '

An object of the scaling policies for each metric.

', ], ], 'ScalingPolicy' => [ 'base' => '

An object containing a recommended scaling policy.

', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingPolicyMetric' => [ 'base' => '

The metric for a scaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$Metric' => '

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

', ], ], 'ScalingPolicyObjective' => [ 'base' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'refs' => [ 'GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective' => '

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

', ], ], 'ScheduleConfig' => [ 'base' => '

Configuration details about the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleConfig$ScheduleConfig' => '

Configures the monitoring schedule.

', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduleConfig$ScheduleExpression' => '

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

    NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)

  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

  • Every two hours starting at midnight: cron(0 0/2 ? * * *)

  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

', ], ], 'ScheduleStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringScheduleStatus' => '

The status of an monitoring job.

', 'ListMonitoringSchedulesRequest$StatusEquals' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

', 'MonitoringScheduleSummary$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', ], ], 'SearchExpression' => [ 'base' => '

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

', 'refs' => [ 'SearchExpressionList$member' => NULL, 'SearchRequest$SearchExpression' => '

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

', ], ], 'SearchExpressionList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$SubExpressions' => '

A list of search expression objects.

', ], ], 'SearchRecord' => [ 'base' => '

A single resource returned as part of the Search API response.

', 'refs' => [ 'SearchResultsList$member' => NULL, ], ], 'SearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResultsList' => [ 'base' => NULL, 'refs' => [ 'SearchResponse$Results' => '

A list of SearchRecord objects.

', ], ], 'SearchSortOrder' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$SortOrder' => '

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

', ], ], 'SecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

', 'SecondaryStatusTransition$Status' => '

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', 'TrainingJob$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', ], ], 'SecondaryStatusTransition' => [ 'base' => '

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job\'s secondary status.

', 'refs' => [ 'SecondaryStatusTransitions$member' => NULL, ], ], 'SecondaryStatusTransitions' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', 'TrainingJob$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'GitConfig$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'GitConfigForUpdate$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'IdentityProviderOAuthSetting$SecretArn' => '

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SecurityGroupIdForDomainBoundary' => '

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

', 'DomainSecurityGroupIds$member' => NULL, 'SecurityGroupIds$member' => NULL, 'VpcSecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'DefaultSpaceSettings$SecurityGroups' => '

The security group IDs for the Amazon VPC that the space uses for communication.

', 'DescribeNotebookInstanceOutput$SecurityGroups' => '

The IDs of the VPC security groups.

', 'UserSettings$SecurityGroups' => '

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

', ], ], 'Seed' => [ 'base' => NULL, 'refs' => [ 'ShuffleConfig$Seed' => '

Determines the shuffling order in ShuffleConfig value.

', ], ], 'SelectedStep' => [ 'base' => '

A step selected to run in selective execution mode.

', 'refs' => [ 'SelectedStepList$member' => NULL, ], ], 'SelectedStepList' => [ 'base' => NULL, 'refs' => [ 'SelectiveExecutionConfig$SelectedSteps' => '

A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

', ], ], 'SelectiveExecutionConfig' => [ 'base' => '

The selective execution configuration applied to the pipeline run.

', 'refs' => [ 'DescribePipelineExecutionResponse$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'PipelineExecution$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'StartPipelineExecutionRequest$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', ], ], 'SelectiveExecutionResult' => [ 'base' => '

The ARN from an execution of the current pipeline.

', 'refs' => [ 'PipelineExecutionStep$SelectiveExecutionResult' => '

The ARN from an execution of the current pipeline from which results are reused for this step.

', ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepFailureResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerlessMaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MaxConcurrency' => '

The maximum number of concurrent invocations your serverless endpoint can process.

', 'ProductionVariantServerlessUpdateConfig$MaxConcurrency' => '

The updated maximum number of concurrent invocations your serverless endpoint can process.

', ], ], 'ServerlessMemorySizeInMB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MemorySizeInMB' => '

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

', ], ], 'ServerlessProvisionedConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$ProvisionedConcurrency' => '

The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.

', 'ProductionVariantServerlessUpdateConfig$ProvisionedConcurrency' => '

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

', ], ], 'ServiceCatalogEntityId' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductId' => '

The ID of the provisioned product.

', 'ServiceCatalogProvisioningDetails$ProductId' => '

The ID of the product to provision.

', 'ServiceCatalogProvisioningDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', 'ServiceCatalogProvisioningDetails$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', ], ], 'ServiceCatalogProvisionedProductDetails' => [ 'base' => '

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'DescribeProjectOutput$ServiceCatalogProvisionedProductDetails' => '

Information about a provisioned service catalog product.

', 'Project$ServiceCatalogProvisionedProductDetails' => NULL, ], ], 'ServiceCatalogProvisioningDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'CreateProjectInput$ServiceCatalogProvisioningDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', 'DescribeProjectOutput$ServiceCatalogProvisioningDetails' => '

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'Project$ServiceCatalogProvisioningDetails' => NULL, ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', ], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds' => '

The session expiration duration in seconds. This value defaults to 43200.

', 'CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds' => '

The duration of the session, in seconds. The default is 12 hours.

', ], ], 'ShadowModeConfig' => [ 'base' => '

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

', 'refs' => [ 'CreateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', 'DescribeInferenceExperimentResponse$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

', 'UpdateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', ], ], 'ShadowModelVariantConfig' => [ 'base' => '

The name and sampling percentage of a shadow variant.

', 'refs' => [ 'ShadowModelVariantConfigList$member' => NULL, ], ], 'ShadowModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'ShadowModeConfig$ShadowModelVariants' => '

List of shadow variant configurations.

', ], ], 'SharingSettings' => [ 'base' => '

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn\'t allowed.

', 'refs' => [ 'UserSettings$SharingSettings' => '

Specifies options for sharing Amazon SageMaker Studio notebooks.

', ], ], 'SharingType' => [ 'base' => NULL, 'refs' => [ 'SpaceSharingSettings$SharingType' => '

Specifies the sharing type of the space.

', 'SpaceSharingSettingsSummary$SharingType' => '

Specifies the sharing type of the space.

', ], ], 'ShuffleConfig' => [ 'base' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', 'refs' => [ 'Channel$ShuffleConfig' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', ], ], 'SingleSignOnApplicationArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SingleSignOnApplicationArn' => '

The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

', ], ], 'SingleSignOnUserIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileRequest$SingleSignOnUserIdentifier' => '

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain\'s AuthMode is IAM Identity Center, this field is required. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'DescribeUserProfileResponse$SingleSignOnUserIdentifier' => '

The IAM Identity Center user identifier.

', ], ], 'SkipModelValidation' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'DescribeModelPackageOutput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'ModelPackage$SkipModelValidation' => '

Indicates if you want to skip model validation.

', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$SuccessTopic' => '

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

', 'AsyncInferenceNotificationConfig$ErrorTopic' => '

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

', 'LabelingJobOutputConfig$SnsTopicArn' => '

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

', 'LabelingJobSnsDataSource$SnsTopicArn' => '

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

', ], ], 'SortActionsBy' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortArtifactsBy' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortAssociationsBy' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortBy' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListProcessingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTrainingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTransformJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'SortContextsBy' => [ 'base' => NULL, 'refs' => [ 'ListContextsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortInferenceExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsRequest$SortBy' => '

The column by which to sort the listed inference experiments.

', ], ], 'SortLineageGroupsBy' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAlgorithmsInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListAppImageConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAppsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListArtifactsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAssociationsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListClusterNodesRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListClustersRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListCompilationJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListContextsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListDataQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListDeviceFleetsRequest$SortOrder' => '

What direction to sort in.

', 'ListEdgeDeploymentPlansRequest$SortOrder' => '

The direction of the sorting (ascending or descending).

', 'ListEdgePackagingJobsRequest$SortOrder' => '

What direction to sort by.

', 'ListExperimentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListFlowDefinitionsRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHubContentVersionsRequest$SortOrder' => '

Sort hub content versions by ascending or descending order.

', 'ListHubContentsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHubsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHumanTaskUisRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHyperParameterTuningJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListInferenceExperimentsRequest$SortOrder' => '

The direction of sorting (ascending or descending).

', 'ListInferenceRecommendationsJobsRequest$SortOrder' => '

The sort order for the results.

', 'ListLabelingJobsForWorkteamRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLabelingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLineageGroupsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelBiasJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelExplainabilityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelPackageGroupsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListModelPackagesInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringAlertHistoryRequest$SortOrder' => '

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

', 'ListMonitoringExecutionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringSchedulesRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListPipelineExecutionStepsRequest$SortOrder' => '

The field by which to sort results. The default is CreatedTime.

', 'ListPipelineExecutionsRequest$SortOrder' => '

The sort order for results.

', 'ListPipelinesRequest$SortOrder' => '

The sort order for results.

', 'ListProcessingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListSpacesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListStudioLifecycleConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTrainingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTransformJobsRequest$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListTrialComponentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrialsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListUserProfilesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListWorkforcesRequest$SortOrder' => '

Sort workforces in ascending or descending order.

', 'ListWorkteamsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'SortPipelineExecutionsBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortPipelinesBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortTrialComponentsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortTrialsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SourceAlgorithm' => [ 'base' => '

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', 'refs' => [ 'SourceAlgorithmList$member' => NULL, ], ], 'SourceAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'SourceAlgorithmSpecification$SourceAlgorithms' => '

A list of the algorithms that were used to create a model package.

', ], ], 'SourceAlgorithmSpecification' => [ 'base' => '

A list of algorithms that were used to create a model package.

', 'refs' => [ 'CreateModelPackageInput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'DescribeModelPackageOutput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'ModelPackage$SourceAlgorithmSpecification' => '

A list of algorithms that were used to create a model package.

', ], ], 'SourceIpConfig' => [ 'base' => '

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn\'t restricted to specific IP addresses.

', 'refs' => [ 'CreateWorkforceRequest$SourceIpConfig' => NULL, 'UpdateWorkforceRequest$SourceIpConfig' => '

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

', 'Workforce$SourceIpConfig' => '

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn\'t restricted to specific IP addresses.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceType' => '

The source type.

', 'TrialComponentSource$SourceType' => '

The source job type.

', 'TrialSource$SourceType' => '

The source job type.

', ], ], 'SourceUri' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceUri' => '

The URI of the source.

', 'ArtifactSource$SourceUri' => '

The URI of the source.

', 'ContextSource$SourceUri' => '

The URI of the source.

', 'ListActionsRequest$SourceUri' => '

A filter that returns only actions with the specified source URI.

', 'ListArtifactsRequest$SourceUri' => '

A filter that returns only artifacts with the specified source URI.

', 'ListContextsRequest$SourceUri' => '

A filter that returns only contexts with the specified source URI.

', ], ], 'SpaceArn' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'DescribeSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'UpdateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', ], ], 'SpaceCodeEditorAppSettings' => [ 'base' => '

The application settings for a Code Editor space.

', 'refs' => [ 'SpaceSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'SpaceDetails' => [ 'base' => '

The space\'s details.

', 'refs' => [ 'SpaceList$member' => NULL, ], ], 'SpaceEbsVolumeSizeInGb' => [ 'base' => NULL, 'refs' => [ 'DefaultEbsStorageSettings$DefaultEbsVolumeSizeInGb' => '

The default size of the EBS storage volume for a space.

', 'DefaultEbsStorageSettings$MaximumEbsVolumeSizeInGb' => '

The maximum size of the EBS storage volume for a space.

', 'EbsStorageSettings$EbsVolumeSizeInGb' => '

The size of an EBS storage volume for a space.

', ], ], 'SpaceJupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application within a space.

', 'refs' => [ 'SpaceSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'SpaceList' => [ 'base' => NULL, 'refs' => [ 'ListSpacesResponse$Spaces' => '

The list of spaces.

', ], ], 'SpaceName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$SpaceName' => '

The name of the space.

', 'CreateAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'CreatePresignedDomainUrlRequest$SpaceName' => '

The name of the space.

', 'CreateSpaceRequest$SpaceName' => '

The name of the space.

', 'DeleteAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DeleteSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeAppRequest$SpaceName' => '

The name of the space.

', 'DescribeAppResponse$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DescribeSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeSpaceResponse$SpaceName' => '

The name of the space.

', 'ListAppsRequest$SpaceNameEquals' => '

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

', 'ListSpacesRequest$SpaceNameContains' => '

A parameter by which to filter the results.

', 'SpaceDetails$SpaceName' => '

The name of the space.

', 'UpdateSpaceRequest$SpaceName' => '

The name of the space.

', ], ], 'SpaceSettings' => [ 'base' => '

A collection of space settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', 'DescribeSpaceResponse$SpaceSettings' => '

A collection of space settings.

', 'UpdateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', ], ], 'SpaceSettingsSummary' => [ 'base' => '

Specifies summary information about the space settings.

', 'refs' => [ 'SpaceDetails$SpaceSettingsSummary' => '

Specifies summary information about the space settings.

', ], ], 'SpaceSharingSettings' => [ 'base' => '

A collection of space sharing settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSharingSettings' => '

A collection of space sharing settings.

', 'DescribeSpaceResponse$SpaceSharingSettings' => '

The collection of space sharing settings for a space.

', ], ], 'SpaceSharingSettingsSummary' => [ 'base' => '

Specifies summary information about the space sharing settings.

', 'refs' => [ 'SpaceDetails$SpaceSharingSettingsSummary' => '

Specifies summary information about the space sharing settings.

', ], ], 'SpaceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListSpacesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SpaceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$Status' => '

The status.

', 'SpaceDetails$Status' => '

The status.

', ], ], 'SpaceStorageSettings' => [ 'base' => '

The storage settings for a space.

', 'refs' => [ 'SpaceSettings$SpaceStorageSettings' => '

The storage settings for a space.

', 'SpaceSettingsSummary$SpaceStorageSettings' => '

The storage settings for a space.

', ], ], 'SpawnRate' => [ 'base' => NULL, 'refs' => [ 'Phase$SpawnRate' => '

Specified how many new users to spawn in a minute.

', ], ], 'SplitType' => [ 'base' => NULL, 'refs' => [ 'TransformInput$SplitType' => '

The method to use to split the transform job\'s data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO

  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

', ], ], 'StageStatus' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentStatus$StageStatus' => '

The general status of the current stage.

', ], ], 'Stairs' => [ 'base' => '

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

', 'refs' => [ 'TrafficPattern$Stairs' => '

Defines the stairs traffic pattern.

', ], ], 'StartEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => '

The statistic of the customized metric.

', ], ], 'StatusDetails' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', 'ProfilerRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'SecondaryStatusTransition$StatusMessage' => '

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

  • Starting the training job.

  • Launching requested ML instances.

  • Insufficient capacity error from EC2 while launching instances, retrying!

  • Launched instance was unhealthy, replacing it!

  • Preparing the instances for training.

Training

  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don\'t use status messages in if statements.

To have an overview of your training job\'s progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress

  • SecondaryStatus - Training

  • StatusMessage - Downloading the training image

', ], ], 'StepDescription' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDescription' => '

The description of the step.

', ], ], 'StepDisplayName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDisplayName' => '

The display name of the step.

', ], ], 'StepName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepName' => '

The name of the step that is executed.

', ], ], 'StepStatus' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepStatus' => '

The status of the step execution.

', ], ], 'StopAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StoppingCondition' => [ 'base' => '

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

', 'refs' => [ 'CreateCompilationJobRequest$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'CreateTrainingJobRequest$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'DescribeCompilationJobResponse$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'DescribeTrainingJobResponse$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'HyperParameterTrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

', 'TrainingJob$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'TrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

', ], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'OnlineStoreConfig$StorageType' => '

Option for different tiers of low latency storage for real-time data retrieval.

  • Standard: A managed low latency data store for feature groups.

  • InMemory: A managed data store for feature groups that supports very low latency retrieval.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'BatchDescribeModelPackageError$ErrorCode' => '

', 'BatchDescribeModelPackageError$ErrorResponse' => '

', 'BatchTransformInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'BatchTransformInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'BatchTransformInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'ClusterInstanceStatusDetails$Message' => '

The message from an instance in a SageMaker HyperPod cluster.

', 'ClusterNodeDetails$InstanceId' => '

The ID of the instance.

', 'ClusterNodeSummary$InstanceId' => '

The ID of the instance.

', 'CreateModelPackageInput$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'CreateModelPackageInput$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

Specify "OTHER" if none of the tasks listed fit your use case.

', 'CustomizedMetricSpecification$MetricName' => '

The name of the customized metric.

', 'CustomizedMetricSpecification$Namespace' => '

The namespace of the customized metric.

', 'DescribeClusterResponse$FailureMessage' => '

The failure message of the SageMaker HyperPod cluster.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage' => '

Returns a message describing the job status and error messages.

', 'DescribeEdgePackagingJobResponse$ModelSignature' => '

The signature document of files in the model artifact.

', 'DescribeModelPackageOutput$Domain' => '

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

', 'DescribeModelPackageOutput$Task' => '

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'DescribeModelPackageOutput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

', 'DeviceDeploymentSummary$DeviceDeploymentStatusMessage' => '

The detailed error message for the deployoment status result.

', 'EdgeDeploymentStatus$EdgeDeploymentStatusMessage' => '

A detailed message about deployment status in current stage.

', 'EdgeOutputConfig$PresetDeploymentConfig' => '

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

', 'EdgePresetDeploymentOutput$StatusMessage' => '

Returns a message describing the status of the deployed resource.

', 'EndpointInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'EndpointInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'EndpointInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'EndpointOutputConfiguration$EndpointName' => '

The name of the endpoint made during a recommendation job.

', 'EndpointOutputConfiguration$VariantName' => '

The name of the production variant (deployed model) made during a recommendation job.

', 'EnvironmentParameter$Key' => '

The environment key suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$ValueType' => '

The value type suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$Value' => '

The value suggested by the Amazon SageMaker Inference Recommender.

', 'GetScalingConfigurationRecommendationRequest$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the EndpointName field.

', 'GetScalingConfigurationRecommendationResponse$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation.

', 'IamIdentity$Arn' => '

The Amazon Resource Name (ARN) of the IAM identity.

', 'IamIdentity$PrincipalId' => '

The ID of the principal that assumes the IAM identity.

', 'IamIdentity$SourceIdentity' => '

The person or application which assumes the IAM identity.

', 'InferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'ListProcessingJobsRequest$NameContains' => '

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

', 'ModelCard$ModelId' => '

The unique name (ID) of the model.

', 'ModelCard$RiskRating' => '

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

', 'ModelCard$ModelPackageGroupName' => '

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

', 'ModelDashboardModelCard$ModelId' => '

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

', 'ModelDashboardModelCard$RiskRating' => '

A model card\'s risk rating. Can be low, medium, or high.

', 'ModelMetadataSummary$Domain' => '

The machine learning domain of the model.

', 'ModelMetadataSummary$Framework' => '

The machine learning framework of the model.

', 'ModelMetadataSummary$Task' => '

The machine learning task of the model.

', 'ModelMetadataSummary$Model' => '

The name of the model.

', 'ModelMetadataSummary$FrameworkVersion' => '

The framework version of the model.

', 'ModelPackage$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'ModelPackage$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'ModelPackage$SamplePayloadUrl' => '

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'ModelPackageContainerDefinition$Framework' => '

The machine learning framework of the model package container image.

', 'ModelPackageContainerDefinition$NearestModelName' => '

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

', 'ModelPackageStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'PredefinedMetricSpecification$PredefinedMetricType' => '

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

', 'ProcessingInput$InputName' => '

The name for the processing job input.

', 'ProcessingOutput$OutputName' => '

The name for the processing job output.

', 'ProductListings$member' => NULL, 'RStudioServerProDomainSettings$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettings$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RealTimeInferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'RecommendationJobContainerConfig$Domain' => '

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

', 'RecommendationJobContainerConfig$Task' => '

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

', 'RecommendationJobContainerConfig$Framework' => '

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

', 'RecommendationJobContainerConfig$NearestModelName' => '

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

', 'RecommendationJobSupportedInstanceTypes$member' => NULL, 'RenderUiTemplateResponse$RenderedContent' => '

A Liquid template that renders the HTML for the worker UI.

', 'RenderingError$Code' => '

A unique identifier for a specific class of errors.

', 'RenderingError$Message' => '

A human-readable message describing the error.

', 'ScheduleConfig$DataAnalysisStartTime' => '

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'ScheduleConfig$DataAnalysisEndTime' => '

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'SubscribedWorkteam$SellerName' => '

The name of the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$ListingId' => '

Marketplace product listing ID.

', 'UserContext$UserProfileArn' => '

The Amazon Resource Name (ARN) of the user\'s profile.

', 'UserContext$UserProfileName' => '

The name of the user\'s profile.

', 'UserContext$DomainId' => '

The domain associated with the user.

', 'Workforce$SubDomain' => '

The subdomain for your OIDC Identity Provider.

', 'Workteam$SubDomain' => '

The URI of the labeling job\'s user interface. Workers open this URI to start labeling your data objects.

', ], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of baseline constraints file to be used for the drift check.

', 'ClarifyCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'ClarifyCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of the violation report if violations are detected.

', 'CreateDomainResponse$Url' => '

The URL to the created domain.

', 'DescribeDomainResponse$Url' => '

The domain\'s URL.

', 'DescribeSpaceResponse$Url' => '

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

', 'DomainDetails$Url' => '

The domain\'s URL.

', 'EMRStepMetadata$LogFilePath' => '

The path to the log file where the cluster step\'s failure root cause is recorded.

', 'OutputParameter$Value' => '

The value of the output parameter.

', 'Parameter$Value' => '

The literal value for the parameter.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics' => '

The Amazon S3 URI of the baseline statistics file used for the drift check.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of the baseline constraints file used for the drift check.

', 'QualityCheckStepMetadata$CalculatedBaselineStatistics' => '

The Amazon S3 URI of the newly calculated baseline statistics file.

', 'QualityCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'QualityCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of violation report if violations are detected.

', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRangeValues$member' => NULL, ], ], 'String200' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$Description' => '

A description of the work team.

', 'SubscribedWorkteam$MarketplaceTitle' => '

The title of the service provided by the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$MarketplaceDescription' => '

The description of the vendor from the Amazon Marketplace.

', 'UpdateWorkteamRequest$Description' => '

An updated description for the work team.

', 'Workteam$Description' => '

A description of the work team.

', ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceType' => '

The type of the source.

', 'ActionSource$SourceId' => '

The ID of the source.

', 'ArtifactSourceType$Value' => '

The ID.

', 'ArtifactSummary$ArtifactType' => '

The type of the artifact.

', 'AssociationSummary$SourceType' => '

The source type.

', 'AssociationSummary$DestinationType' => '

The destination type.

', 'CallbackStepMetadata$SqsQueueUrl' => '

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

', 'ClarifyCheckStepMetadata$CheckType' => '

The type of the Clarify Check step

', 'ClarifyCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'ClarifyCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the check processing job that was run by this step\'s execution.

', 'ContextSource$SourceType' => '

The type of the source.

', 'ContextSource$SourceId' => '

The ID of the source.

', 'ContextSummary$ContextType' => '

The type of the context.

', 'CreateActionRequest$ActionType' => '

The action type.

', 'CreateArtifactRequest$ArtifactType' => '

The artifact type.

', 'CreateContextRequest$ContextType' => '

The context type.

', 'CreateUserProfileRequest$SingleSignOnUserValue' => '

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain\'s AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'CustomImageContainerEnvironmentVariables$value' => NULL, 'DescribeActionResponse$ActionType' => '

The type of the action.

', 'DescribeArtifactResponse$ArtifactType' => '

The type of the artifact.

', 'DescribeContextResponse$ContextType' => '

The type of the context.

', 'DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId' => '

The IAM Identity Center managed application instance ID.

', 'DescribeUserProfileResponse$SingleSignOnUserValue' => '

The IAM Identity Center user value.

', 'EMRStepMetadata$ClusterId' => '

The identifier of the EMR cluster.

', 'EMRStepMetadata$StepId' => '

The identifier of the EMR cluster step.

', 'EMRStepMetadata$StepName' => '

The name of the EMR cluster step.

', 'LambdaStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

', 'ListActionsRequest$ActionType' => '

A filter that returns only actions of the specified type.

', 'ListArtifactsRequest$ArtifactType' => '

A filter that returns only artifacts of the specified type.

', 'ListAssociationsRequest$SourceType' => '

A filter that returns only associations with the specified source type.

', 'ListAssociationsRequest$DestinationType' => '

A filter that returns only associations with the specified destination type.

', 'ListContextsRequest$ContextType' => '

A filter that returns only contexts of the specified type.

', 'ListTrialComponentsRequest$SourceArn' => '

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can\'t filter by ExperimentName or TrialName.

', 'ModelMetadataFilter$Value' => '

The value to filter the model metadata.

', 'ModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the created model.

', 'OutputParameter$Name' => '

The name of the output parameter.

', 'QualityCheckStepMetadata$CheckType' => '

The type of the Quality check step.

', 'QualityCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'QualityCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

', 'QueryProperties$key' => NULL, 'QueryProperties$value' => NULL, 'RegisterModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the model package.

', 'SelectedStep$StepName' => '

The name of the pipeline step.

', 'SendPipelineExecutionStepFailureRequest$FailureReason' => '

A message describing why the step failed.

', ], ], 'String3072' => [ 'base' => NULL, 'refs' => [ 'FailStepMetadata$ErrorMessage' => '

A message that you define and then is processed and rendered by the Fail step when the error occurs.

', 'PipelineExecutionSummary$PipelineExecutionFailureReason' => '

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

', ], ], 'String40' => [ 'base' => NULL, 'refs' => [ 'QueryTypes$member' => NULL, 'Vertex$Type' => '

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

', ], ], 'String64' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionType' => '

The type of the action.

', 'CategoricalParameter$Name' => '

The Name of the environment variable.

', 'ModelLatencyThreshold$Percentile' => '

The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.

', ], ], 'String8192' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$NextToken' => '

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

', 'QueryLineageResponse$NextToken' => '

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'StringParameterValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$key' => NULL, 'LineageEntityParameters$key' => NULL, 'LineageEntityParameters$value' => NULL, 'ListLineageEntityParameterKey$member' => NULL, 'TrialComponentParameterValue$StringValue' => '

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can\'t specify the NumberValue parameter.

', ], ], 'StudioLifecycleConfigAppType' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'ListStudioLifecycleConfigsRequest$AppTypeEquals' => '

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigAppType' => '

The App type to which the Lifecycle Configuration is attached.

', ], ], 'StudioLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of your created Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of the Lifecycle Configuration to describe.

', 'LifecycleConfigArns$member' => NULL, 'ResourceSpec$LifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script.

', ], ], 'StudioLifecycleConfigDetails' => [ 'base' => '

Details of the Amazon SageMaker Studio Lifecycle Configuration.

', 'refs' => [ 'StudioLifecycleConfigsList$member' => NULL, ], ], 'StudioLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

', 'DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

', 'DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

', 'ListStudioLifecycleConfigsRequest$NameContains' => '

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'StudioLifecycleConfigsList' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs' => '

A list of Lifecycle Configurations and their properties.

', ], ], 'StudioWebPortal' => [ 'base' => NULL, 'refs' => [ 'UserSettings$StudioWebPortal' => '

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SubnetId' => '

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

', 'DescribeNotebookInstanceOutput$SubnetId' => '

The ID of the VPC subnet.

', 'Subnets$member' => NULL, ], ], 'Subnets' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'DescribeDomainResponse$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'UpdateDomainRequest$SubnetIds' => '

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

', 'VpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

', ], ], 'SubscribedWorkteam' => [ 'base' => '

Describes a work team of a vendor that does the a labelling job.

', 'refs' => [ 'DescribeSubscribedWorkteamResponse$SubscribedWorkteam' => '

A Workteam instance that contains information about the work team.

', 'SubscribedWorkteams$member' => NULL, ], ], 'SubscribedWorkteams' => [ 'base' => NULL, 'refs' => [ 'ListSubscribedWorkteamsResponse$SubscribedWorkteams' => '

An array of Workteam objects, each describing a work team.

', ], ], 'Success' => [ 'base' => NULL, 'refs' => [ 'DeleteWorkteamResponse$Success' => '

Returns true if the work team was successfully deleted; otherwise, returns false.

', ], ], 'SuggestionQuery' => [ 'base' => '

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

', 'refs' => [ 'GetSearchSuggestionsRequest$SuggestionQuery' => '

Limits the property names that are included in the response.

', ], ], 'TableFormat' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreConfig$TableFormat' => '

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$TableName' => '

The name of the Glue table.

', ], ], 'TabularJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TabularJobConfig' => '

Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).

', ], ], 'TabularResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TabularResolvedAttributes' => '

The resolved attributes for the tabular problem type.

', ], ], 'Tag' => [ 'base' => '

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique per resource.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'DeleteTagsInput$TagKeys' => '

An array or one or more tag keys to delete.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'AddTagsOutput$Tags' => '

A list of tags associated with the SageMaker resource.

', 'CreateActionRequest$Tags' => '

A list of tags to apply to the action.

', 'CreateAlgorithmInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateAppImageConfigRequest$Tags' => '

A list of tags to apply to the AppImageConfig.

', 'CreateAppRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

', 'CreateArtifactRequest$Tags' => '

A list of tags to apply to the artifact.

', 'CreateAutoMLJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateAutoMLJobV2Request$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateClusterRequest$Tags' => '

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

', 'CreateCodeRepositoryInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateCompilationJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateContextRequest$Tags' => '

A list of tags to apply to the context.

', 'CreateDataQualityJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateDeviceFleetRequest$Tags' => '

Creates tags for the specified fleet.

', 'CreateDomainRequest$Tags' => '

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

', 'CreateEdgeDeploymentPlanRequest$Tags' => '

List of tags with which to tag the edge deployment plan.

', 'CreateEdgePackagingJobRequest$Tags' => '

Creates tags for the packaging job.

', 'CreateEndpointConfigInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateEndpointInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateExperimentRequest$Tags' => '

A list of tags to associate with the experiment. You can use Search API to search on the tags.

', 'CreateFeatureGroupRequest$Tags' => '

Tags used to identify Features in each FeatureGroup.

', 'CreateFlowDefinitionRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

', 'CreateHubRequest$Tags' => '

Any tags to associate with the hub.

', 'CreateHumanTaskUiRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

', 'CreateHyperParameterTuningJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

', 'CreateImageRequest$Tags' => '

A list of tags to apply to the image.

', 'CreateInferenceComponentInput$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

', 'CreateInferenceExperimentRequest$Tags' => '

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

', 'CreateInferenceRecommendationsJobRequest$Tags' => '

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

', 'CreateLabelingJobRequest$Tags' => '

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.

', 'CreateModelBiasJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateModelCardRequest$Tags' => '

Key-value pairs used to manage metadata for model cards.

', 'CreateModelExplainabilityJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateModelInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateModelPackageGroupInput$Tags' => '

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateModelPackageInput$Tags' => '

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

', 'CreateModelQualityJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateMonitoringScheduleRequest$Tags' => '

(Optional) 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.

', 'CreateNotebookInstanceInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreatePipelineRequest$Tags' => '

A list of tags to apply to the created pipeline.

', 'CreateProcessingJobRequest$Tags' => '

(Optional) 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.

', 'CreateProjectInput$Tags' => '

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateSpaceRequest$Tags' => '

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

', 'CreateStudioLifecycleConfigRequest$Tags' => '

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

', 'CreateTrainingJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateTransformJobRequest$Tags' => '

(Optional) 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.

', 'CreateTrialComponentRequest$Tags' => '

A list of tags to associate with the component. You can use Search API to search on the tags.

', 'CreateTrialRequest$Tags' => '

A list of tags to associate with the trial. You can use Search API to search on the tags.

', 'CreateUserProfileRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

', 'CreateWorkforceRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

', 'CreateWorkteamRequest$Tags' => '

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'DescribeLabelingJobResponse$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'Endpoint$Tags' => '

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Experiment$Tags' => '

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

', 'FeatureGroup$Tags' => '

Tags used to define a FeatureGroup.

', 'HyperParameterTuningJobSearchEntity$Tags' => '

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

', 'ImportHubContentRequest$Tags' => '

Any tags associated with the hub content.

', 'ListTagsOutput$Tags' => '

An array of Tag objects, each with a tag key and a value.

', 'Model$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelCard$Tags' => '

Key-value pairs used to manage metadata for the model card.

', 'ModelDashboardModelCard$Tags' => '

The tags associated with a model card.

', 'ModelPackage$Tags' => '

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelPackageGroup$Tags' => '

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'MonitoringSchedule$Tags' => '

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Pipeline$Tags' => '

A list of tags that apply to the pipeline.

', 'ProcessingJob$Tags' => '

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.

', 'Project$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'RegisterDevicesRequest$Tags' => '

The tags associated with devices.

', 'TrainingJob$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'TransformJob$Tags' => '

A list of tags associated with the transform job.

', 'Trial$Tags' => '

The list of tags that are associated with the trial. You can use Search API to search on the tags.

', 'TrialComponent$Tags' => '

The list of tags that are associated with the component. You can use Search API to search on the tags.

', 'UpdateProjectInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag value.

', ], ], 'TargetAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TabularJobConfig$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TimeSeriesConfig$TargetAttributeName' => '

The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

', ], ], 'TargetDevice' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetDevice' => '

The type of device that the model will run on after the compilation job has completed.

', 'OutputConfig$TargetDevice' => '

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.

', ], ], 'TargetLabelColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$TargetLabelColumn' => '

The name of the column used to provide the class labels. It should not be same as the content column.

', ], ], 'TargetObjectiveMetricValue' => [ 'base' => NULL, 'refs' => [ 'TuningJobCompletionCriteria$TargetObjectiveMetricValue' => '

The value of the objective metric.

', ], ], 'TargetPlatform' => [ 'base' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

', 'refs' => [ 'OutputConfig$TargetPlatform' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"},

    "CompilerOptions": {\'mattr\': [\'+neon\']}

  • Jetson TX2

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'gpu-code\': \'sm_62\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.0\'}

  • EC2 m5.2xlarge instance OS

    "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'mcpu\': \'skylake-avx512\'}

  • RK3399

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}

  • ARMv7 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 25, \'mattr\': [\'+neon\']}

  • ARMv8 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 29}

', ], ], 'TargetPlatformAccelerator' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformAccelerator' => '

The type of accelerator that the model will run on after the compilation job has completed.

', 'TargetPlatform$Accelerator' => '

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options

  • MALI: ARM Mali graphics processor

  • INTEL_GRAPHICS: Integrated Intel graphics

', ], ], 'TargetPlatformArch' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformArch' => '

The type of architecture that the model will run on after the compilation job has completed.

', 'TargetPlatform$Arch' => '

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.

  • X86: 32-bit version of the x86 instruction set.

  • ARM64: ARMv8 64-bit CPU.

  • ARM_EABIHF: ARMv7 32-bit, Hard Float.

  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

', ], ], 'TargetPlatformOs' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformOs' => '

The type of OS that the model will run on after the compilation job has completed.

', 'TargetPlatform$Os' => '

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.

  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {\'ANDROID_PLATFORM\': 28}

', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'base' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

', 'refs' => [ 'ScalingPolicy$TargetTracking' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

', ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).

  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskCount' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredInstanceCount' => '

The variant\'s capacity.

', 'PendingProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'PendingProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'ProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

', 'RealTimeInferenceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType.

', ], ], 'TaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskDescription' => '

A description of the task for your human workers.

', ], ], 'TaskInput' => [ 'base' => NULL, 'refs' => [ 'RenderableTask$Input' => '

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

', ], ], 'TaskKeyword' => [ 'base' => NULL, 'refs' => [ 'TaskKeywords$member' => NULL, ], ], 'TaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskKeywords' => '

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

', ], ], 'TaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).

  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTitle' => '

A title for the task for your human workers.

', ], ], 'TemplateContent' => [ 'base' => NULL, 'refs' => [ 'UiTemplate$Content' => '

The content of the Liquid template for the worker user interface.

', ], ], 'TemplateContentSha256' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$ContentSha256' => '

The SHA-256 digest of the contents of the template.

', ], ], 'TemplateUrl' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$Url' => '

The URL for the user interface template.

', ], ], 'TensorBoardAppSettings' => [ 'base' => '

The TensorBoard app settings.

', 'refs' => [ 'UserSettings$TensorBoardAppSettings' => '

The TensorBoard app settings.

', ], ], 'TensorBoardOutputConfig' => [ 'base' => '

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

', 'refs' => [ 'CreateTrainingJobRequest$TensorBoardOutputConfig' => NULL, 'DescribeTrainingJobResponse$TensorBoardOutputConfig' => NULL, 'TrainingJob$TensorBoardOutputConfig' => NULL, ], ], 'TenthFractionsOfACent' => [ 'base' => NULL, 'refs' => [ 'USD$TenthFractionsOfACent' => '

Fractions of a cent, in tenths.

', ], ], 'TerminationWaitInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$TerminationWaitInSeconds' => '

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

', ], ], 'TextClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the text classification problem type.

', ], ], 'TextGenerationHyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$key' => NULL, ], ], 'TextGenerationHyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$value' => NULL, ], ], 'TextGenerationHyperParameters' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$TextGenerationHyperParameters' => '

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

  • "epochCount": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of "1" to "10".

  • "batchSize": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of "1" to "64".

  • "learningRate": The step size at which a model\'s parameters are updated during training. Its value should be a string containing a floating-point value within the range of "0" to "1".

  • "learningRateWarmupSteps": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of "0" to "250".

Here is an example where all four hyperparameters are configured.

{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", "learningRateWarmupSteps": "10" }

', ], ], 'TextGenerationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextGenerationJobConfig' => '

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', ], ], 'TextGenerationResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the text generation problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TextGenerationResolvedAttributes' => '

The resolved attributes for the text generation problem type.

', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

', 'Device$IotThingName' => '

Amazon Web Services Internet of Things (IoT) object name.

', 'DeviceSummary$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

', ], ], 'ThroughputConfig' => [ 'base' => '

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

', 'refs' => [ 'CreateFeatureGroupRequest$ThroughputConfig' => NULL, ], ], 'ThroughputConfigDescription' => [ 'base' => '

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

', 'refs' => [ 'DescribeFeatureGroupResponse$ThroughputConfig' => NULL, ], ], 'ThroughputConfigUpdate' => [ 'base' => '

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

', 'refs' => [ 'UpdateFeatureGroupRequest$ThroughputConfig' => NULL, ], ], 'ThroughputMode' => [ 'base' => NULL, 'refs' => [ 'ThroughputConfig$ThroughputMode' => '

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

', 'ThroughputConfigDescription$ThroughputMode' => '

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

', 'ThroughputConfigUpdate$ThroughputMode' => '

Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group\'s throughput while another update is in progress.

', ], ], 'TimeSeriesConfig' => [ 'base' => '

The collection of components that defines the time-series.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$TimeSeriesConfig' => '

The collection of components that defines the time-series.

', ], ], 'TimeSeriesForecastingJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TimeSeriesForecastingJobConfig' => '

Settings used to configure an AutoML job V2 for the time-series forecasting problem type.

', ], ], 'TimeSeriesForecastingSettings' => [ 'base' => '

Time series forecast settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$TimeSeriesForecastingSettings' => '

Time series forecast settings for the SageMaker Canvas application.

', ], ], 'TimeSeriesTransformations' => [ 'base' => '

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$Transformations' => '

The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$CreationTime' => '

When the action was created.

', 'ActionSummary$LastModifiedTime' => '

When the action was last modified.

', 'AppImageConfigDetails$CreationTime' => '

When the AppImageConfig was created.

', 'AppImageConfigDetails$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'ArtifactSummary$CreationTime' => '

When the artifact was created.

', 'ArtifactSummary$LastModifiedTime' => '

When the artifact was last modified.

', 'AssociationSummary$CreationTime' => '

When the association was created.

', 'AutoMLCandidate$CreationTime' => '

The creation time.

', 'AutoMLCandidate$EndTime' => '

The end time.

', 'AutoMLCandidate$LastModifiedTime' => '

The last modified time.

', 'AutoMLJobSummary$CreationTime' => '

When the AutoML job was created.

', 'AutoMLJobSummary$EndTime' => '

The end time of an AutoML job.

', 'AutoMLJobSummary$LastModifiedTime' => '

When the AutoML job was last modified.

', 'ClusterNodeDetails$LaunchTime' => '

The time when the instance is launched.

', 'ClusterNodeSummary$LaunchTime' => '

The time when the instance is launched.

', 'ClusterSummary$CreationTime' => '

The time when the SageMaker HyperPod cluster is created.

', 'CompilationJobSummary$CompilationStartTime' => '

The time when the model compilation job started.

', 'CompilationJobSummary$CompilationEndTime' => '

The time when the model compilation job completed.

', 'ContextSummary$CreationTime' => '

When the context was created.

', 'ContextSummary$LastModifiedTime' => '

When the context was last modified.

', 'CreateTrialComponentRequest$StartTime' => '

When the component started.

', 'CreateTrialComponentRequest$EndTime' => '

When the component ended.

', 'DebugRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'DeployedImage$ResolutionTime' => '

The date and time when the image path for the model resolved to the ResolvedImage

', 'DescribeActionResponse$CreationTime' => '

When the action was created.

', 'DescribeActionResponse$LastModifiedTime' => '

When the action was last modified.

', 'DescribeAppImageConfigResponse$CreationTime' => '

When the AppImageConfig was created.

', 'DescribeAppImageConfigResponse$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'DescribeAppResponse$LastHealthCheckTimestamp' => '

The timestamp of the last health check.

', 'DescribeAppResponse$LastUserActivityTimestamp' => '

The timestamp of the last user\'s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

', 'DescribeAppResponse$CreationTime' => '

The creation time of the application.

After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

', 'DescribeArtifactResponse$CreationTime' => '

When the artifact was created.

', 'DescribeArtifactResponse$LastModifiedTime' => '

When the artifact was last modified.

', 'DescribeAutoMLJobResponse$CreationTime' => '

Returns the creation time of the AutoML job.

', 'DescribeAutoMLJobResponse$EndTime' => '

Returns the end time of the AutoML job.

', 'DescribeAutoMLJobResponse$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeAutoMLJobV2Response$CreationTime' => '

Returns the creation time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$EndTime' => '

Returns the end time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeClusterResponse$CreationTime' => '

The time when the SageMaker Cluster is created.

', 'DescribeCompilationJobResponse$CompilationStartTime' => '

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That\'s because it takes time to download the compilation job, which depends on the size of the compilation job container.

', 'DescribeCompilationJobResponse$CompilationEndTime' => '

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job\'s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

', 'DescribeContextResponse$CreationTime' => '

When the context was created.

', 'DescribeContextResponse$LastModifiedTime' => '

When the context was last modified.

', 'DescribeDataQualityJobDefinitionResponse$CreationTime' => '

The time that the data quality monitoring job definition was created.

', 'DescribeDeviceFleetResponse$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DescribeDeviceFleetResponse$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DescribeDeviceResponse$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DescribeDeviceResponse$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'DescribeEdgeDeploymentPlanResponse$CreationTime' => '

The time when the edge deployment plan was created.

', 'DescribeEdgeDeploymentPlanResponse$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'DescribeEdgePackagingJobResponse$CreationTime' => '

The timestamp of when the packaging job was created.

', 'DescribeEdgePackagingJobResponse$LastModifiedTime' => '

The timestamp of when the job was last updated.

', 'DescribeEndpointConfigOutput$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'DescribeEndpointOutput$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'DescribeEndpointOutput$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'DescribeExperimentResponse$CreationTime' => '

When the experiment was created.

', 'DescribeExperimentResponse$LastModifiedTime' => '

When the experiment was last modified.

', 'DescribeFlowDefinitionResponse$CreationTime' => '

The timestamp when the flow definition was created.

', 'DescribeHubContentResponse$CreationTime' => '

The date and time that hub content was created.

', 'DescribeHubResponse$CreationTime' => '

The date and time that the hub was created.

', 'DescribeHubResponse$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'DescribeHumanTaskUiResponse$CreationTime' => '

The timestamp when the human task user interface was created.

', 'DescribeHyperParameterTuningJobResponse$CreationTime' => '

The date and time that the tuning job started.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'DescribeHyperParameterTuningJobResponse$LastModifiedTime' => '

The date and time that the status of the tuning job was modified.

', 'DescribeImageResponse$CreationTime' => '

When the image was created.

', 'DescribeImageResponse$LastModifiedTime' => '

When the image was last modified.

', 'DescribeImageVersionResponse$CreationTime' => '

When the version was created.

', 'DescribeImageVersionResponse$LastModifiedTime' => '

When the version was last modified.

', 'DescribeInferenceComponentOutput$CreationTime' => '

The time when the inference component was created.

', 'DescribeInferenceComponentOutput$LastModifiedTime' => '

The time when the inference component was last updated.

', 'DescribeInferenceExperimentResponse$CreationTime' => '

The timestamp at which you created the inference experiment.

', 'DescribeInferenceExperimentResponse$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'DescribeInferenceExperimentResponse$LastModifiedTime' => '

The timestamp at which you last modified the inference experiment.

', 'DescribeInferenceRecommendationsJobResponse$CompletionTime' => '

A timestamp that shows when the job completed.

', 'DescribeLabelingJobResponse$CreationTime' => '

The date and time that the labeling job was created.

', 'DescribeLabelingJobResponse$LastModifiedTime' => '

The date and time that the labeling job was last updated.

', 'DescribeLineageGroupResponse$CreationTime' => '

The creation time of lineage group.

', 'DescribeLineageGroupResponse$LastModifiedTime' => '

The last modified time of the lineage group.

', 'DescribeModelBiasJobDefinitionResponse$CreationTime' => '

The time at which the model bias job was created.

', 'DescribeModelCardExportJobResponse$CreatedAt' => '

The date and time that the model export job was created.

', 'DescribeModelCardExportJobResponse$LastModifiedAt' => '

The date and time that the model export job was last modified.

', 'DescribeModelCardResponse$CreationTime' => '

The date and time the model card was created.

', 'DescribeModelCardResponse$LastModifiedTime' => '

The date and time the model card was last modified.

', 'DescribeModelExplainabilityJobDefinitionResponse$CreationTime' => '

The time at which the model explainability job was created.

', 'DescribeModelOutput$CreationTime' => '

A timestamp that shows when the model was created.

', 'DescribeModelPackageOutput$LastModifiedTime' => '

The last time that the model package was modified.

', 'DescribeModelQualityJobDefinitionResponse$CreationTime' => '

The time at which the model quality job was created.

', 'DescribeMonitoringScheduleResponse$CreationTime' => '

The time at which the monitoring job was created.

', 'DescribeMonitoringScheduleResponse$LastModifiedTime' => '

The time at which the monitoring job was last modified.

', 'DescribePipelineDefinitionForExecutionResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineExecutionResponse$CreationTime' => '

The time when the pipeline execution was created.

', 'DescribePipelineExecutionResponse$LastModifiedTime' => '

The time when the pipeline execution was modified last.

', 'DescribePipelineResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineResponse$LastModifiedTime' => '

The time when the pipeline was last modified.

', 'DescribePipelineResponse$LastRunTime' => '

The time when the pipeline was last run.

', 'DescribeProcessingJobResponse$ProcessingEndTime' => '

The time at which the processing job completed.

', 'DescribeProcessingJobResponse$ProcessingStartTime' => '

The time at which the processing job started.

', 'DescribeProcessingJobResponse$LastModifiedTime' => '

The time at which the processing job was last modified.

', 'DescribeProcessingJobResponse$CreationTime' => '

The time at which the processing job was created.

', 'DescribeProjectOutput$CreationTime' => '

The time when the project was created.

', 'DescribeProjectOutput$LastModifiedTime' => '

The timestamp when project was last modified.

', 'DescribeStudioLifecycleConfigResponse$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'DescribeTrainingJobResponse$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'DescribeTrainingJobResponse$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'DescribeTrainingJobResponse$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'DescribeTrainingJobResponse$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'DescribeTransformJobResponse$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'DescribeTransformJobResponse$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'DescribeTransformJobResponse$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'DescribeTrialComponentResponse$StartTime' => '

When the component started.

', 'DescribeTrialComponentResponse$EndTime' => '

When the component ended.

', 'DescribeTrialComponentResponse$CreationTime' => '

When the component was created.

', 'DescribeTrialComponentResponse$LastModifiedTime' => '

When the component was last modified.

', 'DescribeTrialResponse$CreationTime' => '

When the trial was created.

', 'DescribeTrialResponse$LastModifiedTime' => '

When the trial was last modified.

', 'DeviceDeploymentSummary$DeploymentStartTime' => '

The time when the deployment on the device started.

', 'DeviceFleetSummary$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DeviceFleetSummary$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DeviceSummary$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DeviceSummary$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'EdgeDeploymentPlanSummary$CreationTime' => '

The time when the edge deployment plan was created.

', 'EdgeDeploymentPlanSummary$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'EdgeDeploymentStatus$EdgeDeploymentStageStartTime' => '

The time when the deployment API started.

', 'EdgeModel$LatestSampleTime' => '

The timestamp of the last data sample taken.

', 'EdgeModel$LatestInference' => '

The timestamp of the last inference that was made.

', 'EdgePackagingJobSummary$CreationTime' => '

The timestamp of when the job was created.

', 'EdgePackagingJobSummary$LastModifiedTime' => '

The timestamp of when the edge packaging job was last updated.

', 'Endpoint$CreationTime' => '

The time that the endpoint was created.

', 'Endpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'EndpointConfigSummary$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'EndpointSummary$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'EndpointSummary$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'Experiment$CreationTime' => '

When the experiment was created.

', 'Experiment$LastModifiedTime' => '

When the experiment was last modified.

', 'ExperimentSummary$CreationTime' => '

When the experiment was created.

', 'ExperimentSummary$LastModifiedTime' => '

When the experiment was last modified.

', 'FeatureGroupSummary$CreationTime' => '

A timestamp indicating the time of creation time of the FeatureGroup.

', 'FlowDefinitionSummary$CreationTime' => '

The timestamp when SageMaker created the flow definition.

', 'GetDeviceFleetReportResponse$ReportGenerated' => '

Timestamp of when the report was generated.

', 'HubContentInfo$CreationTime' => '

The date and time that the hub content was created.

', 'HubInfo$CreationTime' => '

The date and time that the hub was created.

', 'HubInfo$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'HumanTaskUiSummary$CreationTime' => '

A timestamp when SageMaker created the human task user interface.

', 'HyperParameterTrainingJobSummary$CreationTime' => '

The date and time that the training job was created.

', 'HyperParameterTrainingJobSummary$TrainingStartTime' => '

The date and time that the training job started.

', 'HyperParameterTrainingJobSummary$TrainingEndTime' => '

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'HyperParameterTuningJobCompletionDetails$ConvergenceDetectedTime' => '

The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.

', 'HyperParameterTuningJobSearchEntity$CreationTime' => '

The time that a hyperparameter tuning job was created.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime' => '

The time that a hyperparameter tuning job ended.

', 'HyperParameterTuningJobSearchEntity$LastModifiedTime' => '

The time that a hyperparameter tuning job was last modified.

', 'HyperParameterTuningJobSummary$CreationTime' => '

The date and time that the tuning job was created.

', 'HyperParameterTuningJobSummary$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'HyperParameterTuningJobSummary$LastModifiedTime' => '

The date and time that the tuning job was modified.

', 'Image$CreationTime' => '

When the image was created.

', 'Image$LastModifiedTime' => '

When the image was last modified.

', 'ImageVersion$CreationTime' => '

When the version was created.

', 'ImageVersion$LastModifiedTime' => '

When the version was last modified.

', 'InferenceComponentSummary$CreationTime' => '

The time when the inference component was created.

', 'InferenceComponentSummary$LastModifiedTime' => '

The time when the inference component was last updated.

', 'InferenceExperimentSchedule$StartTime' => '

The timestamp at which the inference experiment started or will start.

', 'InferenceExperimentSchedule$EndTime' => '

The timestamp at which the inference experiment ended or will end.

', 'InferenceExperimentSummary$CreationTime' => '

The timestamp at which the inference experiment was created.

', 'InferenceExperimentSummary$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'InferenceExperimentSummary$LastModifiedTime' => '

The timestamp when you last modified the inference experiment.

', 'InferenceRecommendationsJob$CompletionTime' => '

A timestamp that shows when the job completed.

', 'LabelingJobForWorkteamSummary$CreationTime' => '

The date and time that the labeling job was created.

', 'LabelingJobSummary$CreationTime' => '

The date and time that the job was created (timestamp).

', 'LabelingJobSummary$LastModifiedTime' => '

The date and time that the job was last modified (timestamp).

', 'LineageGroupSummary$CreationTime' => '

The creation time of the lineage group summary.

', 'LineageGroupSummary$LastModifiedTime' => '

The last modified time of the lineage group summary.

', 'ListActionsRequest$CreatedAfter' => '

A filter that returns only actions created on or after the specified time.

', 'ListActionsRequest$CreatedBefore' => '

A filter that returns only actions created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeBefore' => '

A filter that returns only AppImageConfigs created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeAfter' => '

A filter that returns only AppImageConfigs created on or after the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only AppImageConfigs modified on or before the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only AppImageConfigs modified on or after the specified time.

', 'ListArtifactsRequest$CreatedAfter' => '

A filter that returns only artifacts created on or after the specified time.

', 'ListArtifactsRequest$CreatedBefore' => '

A filter that returns only artifacts created on or before the specified time.

', 'ListAssociationsRequest$CreatedAfter' => '

A filter that returns only associations created on or after the specified time.

', 'ListAssociationsRequest$CreatedBefore' => '

A filter that returns only associations created on or before the specified time.

', 'ListAutoMLJobsRequest$CreationTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$CreationTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListClusterNodesRequest$CreationTimeAfter' => '

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClusterNodesRequest$CreationTimeBefore' => '

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeAfter' => '

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeBefore' => '

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListCodeRepositoriesInput$LastModifiedTimeAfter' => '

A filter that returns only Git repositories that were last modified after the specified time.

', 'ListCodeRepositoriesInput$LastModifiedTimeBefore' => '

A filter that returns only Git repositories that were last modified before the specified time.

', 'ListContextsRequest$CreatedAfter' => '

A filter that returns only contexts created on or after the specified time.

', 'ListContextsRequest$CreatedBefore' => '

A filter that returns only contexts created on or before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only data quality monitoring job definitions created before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only data quality monitoring job definitions created after the specified time.

', 'ListDeviceFleetsRequest$CreationTimeAfter' => '

Filter fleets where packaging job was created after specified time.

', 'ListDeviceFleetsRequest$CreationTimeBefore' => '

Filter fleets where the edge packaging job was created before specified time.

', 'ListDeviceFleetsRequest$LastModifiedTimeAfter' => '

Select fleets where the job was updated after X

', 'ListDeviceFleetsRequest$LastModifiedTimeBefore' => '

Select fleets where the job was updated before X

', 'ListDevicesRequest$LatestHeartbeatAfter' => '

Select fleets where the job was updated after X

', 'ListEdgeDeploymentPlansRequest$CreationTimeAfter' => '

Selects edge deployment plans created after this time.

', 'ListEdgeDeploymentPlansRequest$CreationTimeBefore' => '

Selects edge deployment plans created before this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter' => '

Selects edge deployment plans that were last updated after this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore' => '

Selects edge deployment plans that were last updated before this time.

', 'ListEdgePackagingJobsRequest$CreationTimeAfter' => '

Select jobs where the job was created after specified time.

', 'ListEdgePackagingJobsRequest$CreationTimeBefore' => '

Select jobs where the job was created before specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeAfter' => '

Select jobs where the job was updated after specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeBefore' => '

Select jobs where the job was updated before specified time.

', 'ListEndpointConfigsInput$CreationTimeBefore' => '

A filter that returns only endpoint configurations created before the specified time (timestamp).

', 'ListEndpointConfigsInput$CreationTimeAfter' => '

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeBefore' => '

A filter that returns only endpoints that were created before the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeAfter' => '

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$LastModifiedTimeBefore' => '

A filter that returns only endpoints that were modified before the specified timestamp.

', 'ListEndpointsInput$LastModifiedTimeAfter' => '

A filter that returns only endpoints that were modified after the specified timestamp.

', 'ListExperimentsRequest$CreatedAfter' => '

A filter that returns only experiments created after the specified time.

', 'ListExperimentsRequest$CreatedBefore' => '

A filter that returns only experiments created before the specified time.

', 'ListFlowDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

', 'ListFlowDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only flow definitions that were created before the specified timestamp.

', 'ListHubContentVersionsRequest$CreationTimeBefore' => '

Only list hub content versions that were created before the time specified.

', 'ListHubContentVersionsRequest$CreationTimeAfter' => '

Only list hub content versions that were created after the time specified.

', 'ListHubContentsRequest$CreationTimeBefore' => '

Only list hub content that was created before the time specified.

', 'ListHubContentsRequest$CreationTimeAfter' => '

Only list hub content that was created after the time specified.

', 'ListHubsRequest$CreationTimeBefore' => '

Only list hubs that were created before the time specified.

', 'ListHubsRequest$CreationTimeAfter' => '

Only list hubs that were created after the time specified.

', 'ListHubsRequest$LastModifiedTimeBefore' => '

Only list hubs that were last modified before the time specified.

', 'ListHubsRequest$LastModifiedTimeAfter' => '

Only list hubs that were last modified after the time specified.

', 'ListHumanTaskUisRequest$CreationTimeAfter' => '

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

', 'ListHumanTaskUisRequest$CreationTimeBefore' => '

A filter that returns only human task user interfaces that were created before the specified timestamp.

', 'ListHyperParameterTuningJobsRequest$CreationTimeAfter' => '

A filter that returns only tuning jobs that were created after the specified time.

', 'ListHyperParameterTuningJobsRequest$CreationTimeBefore' => '

A filter that returns only tuning jobs that were created before the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only tuning jobs that were modified after the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only tuning jobs that were modified before the specified time.

', 'ListImageVersionsRequest$CreationTimeAfter' => '

A filter that returns only versions created on or after the specified time.

', 'ListImageVersionsRequest$CreationTimeBefore' => '

A filter that returns only versions created on or before the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeAfter' => '

A filter that returns only versions modified on or after the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeBefore' => '

A filter that returns only versions modified on or before the specified time.

', 'ListImagesRequest$CreationTimeAfter' => '

A filter that returns only images created on or after the specified time.

', 'ListImagesRequest$CreationTimeBefore' => '

A filter that returns only images created on or before the specified time.

', 'ListImagesRequest$LastModifiedTimeAfter' => '

A filter that returns only images modified on or after the specified time.

', 'ListImagesRequest$LastModifiedTimeBefore' => '

A filter that returns only images modified on or before the specified time.

', 'ListInferenceComponentsInput$CreationTimeBefore' => '

Filters the results to only those inference components that were created before the specified time.

', 'ListInferenceComponentsInput$CreationTimeAfter' => '

Filters the results to only those inference components that were created after the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeBefore' => '

Filters the results to only those inference components that were updated before the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeAfter' => '

Filters the results to only those inference components that were updated after the specified time.

', 'ListInferenceExperimentsRequest$CreationTimeAfter' => '

Selects inference experiments which were created after this timestamp.

', 'ListInferenceExperimentsRequest$CreationTimeBefore' => '

Selects inference experiments which were created before this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeAfter' => '

Selects inference experiments which were last modified after this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeBefore' => '

Selects inference experiments which were last modified before this timestamp.

', 'ListLabelingJobsForWorkteamRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsForWorkteamRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only labeling jobs modified after the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only labeling jobs modified before the specified time (timestamp).

', 'ListLineageGroupsRequest$CreatedAfter' => '

A timestamp to filter against lineage groups created after a certain point in time.

', 'ListLineageGroupsRequest$CreatedBefore' => '

A timestamp to filter against lineage groups created before a certain point in time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model bias jobs created before a specified time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model bias jobs created after a specified time.

', 'ListModelCardExportJobsRequest$CreationTimeAfter' => '

Only list model card export jobs that were created after the time specified.

', 'ListModelCardExportJobsRequest$CreationTimeBefore' => '

Only list model card export jobs that were created before the time specified.

', 'ListModelCardVersionsRequest$CreationTimeAfter' => '

Only list model card versions that were created after the time specified.

', 'ListModelCardVersionsRequest$CreationTimeBefore' => '

Only list model card versions that were created before the time specified.

', 'ListModelCardsRequest$CreationTimeAfter' => '

Only list model cards that were created after the time specified.

', 'ListModelCardsRequest$CreationTimeBefore' => '

Only list model cards that were created before the time specified.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model explainability jobs created before a specified time.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model explainability jobs created after a specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model quality monitoring job definitions created before the specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model quality monitoring job definitions created after the specified time.

', 'ListModelsInput$CreationTimeBefore' => '

A filter that returns only models created before the specified time (timestamp).

', 'ListModelsInput$CreationTimeAfter' => '

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

', 'ListMonitoringAlertHistoryRequest$CreationTimeBefore' => '

A filter that returns only alerts created on or before the specified time.

', 'ListMonitoringAlertHistoryRequest$CreationTimeAfter' => '

A filter that returns only alerts created on or after the specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeBefore' => '

Filter for jobs scheduled before a specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeAfter' => '

Filter for jobs scheduled after a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs modified after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs modified before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeBefore' => '

A filter that returns only monitoring schedules created before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeAfter' => '

A filter that returns only monitoring schedules created after a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeBefore' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeAfter' => '

A filter that returns only monitoring schedules modified after a specified time.

', 'ListPipelineExecutionsRequest$CreatedAfter' => '

A filter that returns the pipeline executions that were created after a specified time.

', 'ListPipelineExecutionsRequest$CreatedBefore' => '

A filter that returns the pipeline executions that were created before a specified time.

', 'ListPipelinesRequest$CreatedAfter' => '

A filter that returns the pipelines that were created after a specified time.

', 'ListPipelinesRequest$CreatedBefore' => '

A filter that returns the pipelines that were created before a specified time.

', 'ListProcessingJobsRequest$CreationTimeAfter' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$CreationTimeBefore' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only processing jobs modified after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only processing jobs modified before the specified time.

', 'ListProjectsInput$CreationTimeAfter' => '

A filter that returns the projects that were created after a specified time.

', 'ListProjectsInput$CreationTimeBefore' => '

A filter that returns the projects that were created before a specified time.

', 'ListResourceCatalogsRequest$CreationTimeAfter' => '

Use this parameter to search for ResourceCatalogs created after a specific date and time.

', 'ListResourceCatalogsRequest$CreationTimeBefore' => '

Use this parameter to search for ResourceCatalogs created before a specific date and time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeBefore' => '

A filter that returns only Lifecycle Configurations created on or before the specified time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeAfter' => '

A filter that returns only Lifecycle Configurations created on or after the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only Lifecycle Configurations modified before the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only Lifecycle Configurations modified after the specified time.

', 'ListTrainingJobsRequest$CreationTimeAfter' => '

A filter that returns only training jobs created after the specified time (timestamp).

', 'ListTrainingJobsRequest$CreationTimeBefore' => '

A filter that returns only training jobs created before the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only training jobs modified after the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only training jobs modified before the specified time (timestamp).

', 'ListTransformJobsRequest$CreationTimeAfter' => '

A filter that returns only transform jobs created after the specified time.

', 'ListTransformJobsRequest$CreationTimeBefore' => '

A filter that returns only transform jobs created before the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only transform jobs modified after the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only transform jobs modified before the specified time.

', 'ListTrialComponentsRequest$CreatedAfter' => '

A filter that returns only components created after the specified time.

', 'ListTrialComponentsRequest$CreatedBefore' => '

A filter that returns only components created before the specified time.

', 'ListTrialsRequest$CreatedAfter' => '

A filter that returns only trials created after the specified time.

', 'ListTrialsRequest$CreatedBefore' => '

A filter that returns only trials created before the specified time.

', 'MetricData$Timestamp' => '

The date and time that the algorithm emitted the metric.

', 'Model$CreationTime' => '

A timestamp that indicates when the model was created.

', 'ModelCard$CreationTime' => '

The date and time that the model card was created.

', 'ModelCard$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardExportJobSummary$CreatedAt' => '

The date and time that the model card export job was created.

', 'ModelCardExportJobSummary$LastModifiedAt' => '

The date and time that the model card export job was last modified..

', 'ModelCardSummary$CreationTime' => '

The date and time that the model card was created.

', 'ModelCardSummary$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardVersionSummary$CreationTime' => '

The date and time that the model card version was created.

', 'ModelCardVersionSummary$LastModifiedTime' => '

The time date and time that the model card version was last modified.

', 'ModelDashboardEndpoint$CreationTime' => '

A timestamp that indicates when the endpoint was created.

', 'ModelDashboardEndpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'ModelDashboardModelCard$CreationTime' => '

A timestamp that indicates when the model card was created.

', 'ModelDashboardModelCard$LastModifiedTime' => '

A timestamp that indicates when the model card was last updated.

', 'ModelDashboardMonitoringSchedule$CreationTime' => '

A timestamp that indicates when the monitoring schedule was created.

', 'ModelDashboardMonitoringSchedule$LastModifiedTime' => '

A timestamp that indicates when the monitoring schedule was last updated.

', 'ModelPackage$LastModifiedTime' => '

The last time the model package was modified.

', 'ModelSummary$CreationTime' => '

A timestamp that indicates when the model was created.

', 'MonitoringAlertHistorySummary$CreationTime' => '

A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

', 'MonitoringAlertSummary$CreationTime' => '

A timestamp that indicates when a monitor alert was created.

', 'MonitoringAlertSummary$LastModifiedTime' => '

A timestamp that indicates when a monitor alert was last updated.

', 'MonitoringExecutionSummary$ScheduledTime' => '

The time the monitoring job was scheduled.

', 'MonitoringExecutionSummary$CreationTime' => '

The time at which the monitoring job was created.

', 'MonitoringExecutionSummary$LastModifiedTime' => '

A timestamp that indicates the last time the monitoring job was modified.

', 'MonitoringJobDefinitionSummary$CreationTime' => '

The time that the monitoring job was created.

', 'MonitoringSchedule$CreationTime' => '

The time that the monitoring schedule was created.

', 'MonitoringSchedule$LastModifiedTime' => '

The last time the monitoring schedule was changed.

', 'MonitoringScheduleSummary$CreationTime' => '

The creation time of the monitoring schedule.

', 'MonitoringScheduleSummary$LastModifiedTime' => '

The last time the monitoring schedule was modified.

', 'PendingDeploymentSummary$StartTime' => '

The start time of the deployment.

', 'Pipeline$CreationTime' => '

The creation time of the pipeline.

', 'Pipeline$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'Pipeline$LastRunTime' => '

The time when the pipeline was last run.

', 'PipelineExecution$CreationTime' => '

The creation time of the pipeline execution.

', 'PipelineExecution$LastModifiedTime' => '

The time that the pipeline execution was last modified.

', 'PipelineExecutionStep$StartTime' => '

The time that the step started executing.

', 'PipelineExecutionStep$EndTime' => '

The time that the step stopped executing.

', 'PipelineExecutionSummary$StartTime' => '

The start time of the pipeline execution.

', 'PipelineSummary$CreationTime' => '

The creation time of the pipeline.

', 'PipelineSummary$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'PipelineSummary$LastExecutionTime' => '

The last time that a pipeline execution began.

', 'ProcessingJob$ProcessingEndTime' => '

The time that the processing job ended.

', 'ProcessingJob$ProcessingStartTime' => '

The time that the processing job started.

', 'ProcessingJob$LastModifiedTime' => '

The time the processing job was last modified.

', 'ProcessingJob$CreationTime' => '

The time the processing job was created.

', 'ProcessingJobSummary$CreationTime' => '

The time at which the processing job was created.

', 'ProcessingJobSummary$ProcessingEndTime' => '

The time at which the processing job completed.

', 'ProcessingJobSummary$LastModifiedTime' => '

A timestamp that indicates the last time the processing job was modified.

', 'ProductionVariantStatus$StartTime' => '

The start time of the current status change.

', 'ProfilerRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'Project$CreationTime' => '

A timestamp specifying when the project was created.

', 'Project$LastModifiedTime' => '

A timestamp container for when the project was last modified.

', 'ProjectSummary$CreationTime' => '

The time that the project was created.

', 'QueryFilters$CreatedBefore' => '

Filter the lineage entities connected to the StartArn(s) by created date.

', 'QueryFilters$CreatedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the create date.

', 'QueryFilters$ModifiedBefore' => '

Filter the lineage entities connected to the StartArn(s) before the last modified date.

', 'QueryFilters$ModifiedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the last modified date.

', 'ResourceCatalog$CreationTime' => '

The time the ResourceCatalog was created.

', 'SecondaryStatusTransition$StartTime' => '

A timestamp that shows when the training job transitioned to the current secondary status state.

', 'SecondaryStatusTransition$EndTime' => '

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

', 'StudioLifecycleConfigDetails$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'StudioLifecycleConfigDetails$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'TrainingJob$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'TrainingJob$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'TrainingJob$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'TrainingJob$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'TrainingJobSummary$CreationTime' => '

A timestamp that shows when the training job was created.

', 'TrainingJobSummary$TrainingEndTime' => '

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

', 'TrainingJobSummary$LastModifiedTime' => '

Timestamp when the training job was last modified.

', 'TransformJob$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJob$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'TransformJob$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'TransformJobSummary$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJobSummary$TransformEndTime' => '

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

', 'TransformJobSummary$LastModifiedTime' => '

Indicates when the transform job was last modified.

', 'Trial$CreationTime' => '

When the trial was created.

', 'Trial$LastModifiedTime' => '

Who last modified the trial.

', 'TrialComponent$StartTime' => '

When the component started.

', 'TrialComponent$EndTime' => '

When the component ended.

', 'TrialComponent$CreationTime' => '

When the component was created.

', 'TrialComponent$LastModifiedTime' => '

When the component was last modified.

', 'TrialComponentMetricSummary$TimeStamp' => '

When the metric was last updated.

', 'TrialComponentSimpleSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$StartTime' => '

When the component started.

', 'TrialComponentSummary$EndTime' => '

When the component ended.

', 'TrialComponentSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$LastModifiedTime' => '

When the component was last modified.

', 'TrialSummary$CreationTime' => '

When the trial was created.

', 'TrialSummary$LastModifiedTime' => '

When the trial was last modified.

', 'UpdateTrialComponentRequest$StartTime' => '

When the component started.

', 'UpdateTrialComponentRequest$EndTime' => '

When the component ended.

', 'Workforce$LastUpdatedDate' => '

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce\'s allow list.

', 'Workforce$CreateDate' => '

The date that the workforce is created.

', 'Workteam$CreateDate' => '

The date and time that the work team was created (timestamp).

', 'Workteam$LastUpdatedDate' => '

The date and time that the work team was last updated (timestamp).

', ], ], 'TimestampAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$TimestampAttributeName' => '

The name of the column indicating a point in time at which the target value of a given item is recorded.

', ], ], 'TrafficDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Phase$DurationInSeconds' => '

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.

', 'Stairs$DurationInSeconds' => '

Defines how long each traffic step should be.

', ], ], 'TrafficPattern' => [ 'base' => '

Defines the traffic pattern of the load test.

', 'refs' => [ 'RecommendationJobInputConfig$TrafficPattern' => '

Specifies the traffic pattern of the job.

', ], ], 'TrafficRoutingConfig' => [ 'base' => '

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

', 'refs' => [ 'BlueGreenUpdatePolicy$TrafficRoutingConfiguration' => '

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

', ], ], 'TrafficRoutingConfigType' => [ 'base' => NULL, 'refs' => [ 'TrafficRoutingConfig$Type' => '

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

', ], ], 'TrafficType' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$TrafficType' => '

Defines the traffic patterns. Choose either PHASES or STAIRS.

', ], ], 'TrainingContainerArgument' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerArguments$member' => NULL, ], ], 'TrainingContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerArguments' => '

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

', ], ], 'TrainingContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerEntrypoint' => '

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

', ], ], 'TrainingContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerEntrypoint$member' => NULL, ], ], 'TrainingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$key' => NULL, ], ], 'TrainingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$Environment' => '

The environment variables to set in the Docker container.

', 'DescribeTrainingJobResponse$Environment' => '

The environment variables to set in the Docker container.

', 'TrainingJob$Environment' => '

The environment variables to set in the Docker container.

', ], ], 'TrainingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$value' => NULL, ], ], 'TrainingImageConfig' => [ 'base' => '

The configuration to use an image from a private Docker registry for a training job.

', 'refs' => [ 'AlgorithmSpecification$TrainingImageConfig' => '

The configuration to use an image from a private Docker registry for a training job.

', ], ], 'TrainingInputMode' => [ 'base' => '

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won\'t be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren\'t supported. The startup time is lower when there are fewer files in the S3 bucket provided.

', 'refs' => [ 'AlgorithmSpecification$TrainingInputMode' => NULL, 'Channel$InputMode' => '

(Optional) The input mode to use for the data channel in a training job. If you don\'t set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job\'s general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

', 'HyperParameterAlgorithmSpecification$TrainingInputMode' => NULL, 'InputModes$member' => NULL, 'TrainingJobDefinition$TrainingInputMode' => NULL, ], ], 'TrainingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.

', 'HyperParameterTuningResourceConfig$InstanceCount' => '

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

', 'InstanceGroup$InstanceCount' => '

Specifies the number of instances of the instance group.

', 'ResourceConfig$InstanceCount' => '

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

', ], ], 'TrainingInstanceType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceType' => '

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

', 'HyperParameterTuningResourceConfig$InstanceType' => '

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

', 'InstanceGroup$InstanceType' => '

Specifies the instance type of the instance group.

', 'ResourceConfig$InstanceType' => '

The ML compute instance type.

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.

Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to reduce model training time. The ml.p4de.24xlarge instances are available in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.

', 'TrainingInstanceTypes$member' => NULL, ], ], 'TrainingInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTrainingInstanceTypes' => '

A list of the instance types that this algorithm can use for training.

', ], ], 'TrainingJob' => [ 'base' => '

Contains information about a training job.

', 'refs' => [ 'SearchRecord$TrainingJob' => '

The properties of a training job.

', 'TrialComponentSourceDetail$TrainingJob' => '

Information about a training job that\'s the source of a trial component.

', ], ], 'TrainingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'DescribeProcessingJobResponse$TrainingJobArn' => '

The ARN of a training job associated with this processing job.

', 'DescribeTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'HyperParameterTrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'ProcessingJob$TrainingJobArn' => '

The ARN of the training job associated with this processing job.

', 'TrainingJob$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'TrainingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', 'TrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'UpdateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', ], ], 'TrainingJobDefinition' => [ 'base' => '

Defines the input needed to run a training job using the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TrainingJobDefinition' => '

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

', ], ], 'TrainingJobEarlyStoppingType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType' => '

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

', ], ], 'TrainingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$TrainingJobName' => '

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTrainingJobRequest$TrainingJobName' => '

The name of the training job.

', 'DescribeTrainingJobResponse$TrainingJobName' => '

Name of the model training job.

', 'HyperParameterTrainingJobSummary$TrainingJobName' => '

The name of the training job.

', 'StopTrainingJobRequest$TrainingJobName' => '

The name of the training job to stop.

', 'TrainingJob$TrainingJobName' => '

The name of the training job.

', 'TrainingJobSummary$TrainingJobName' => '

The name of the training job that you want a summary for.

', 'UpdateTrainingJobRequest$TrainingJobName' => '

The name of a training job to update the Debugger profiling configuration.

', 'WarmPoolStatus$ReusedByJob' => '

The name of the matching training job that reused the warm pool.

', ], ], 'TrainingJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobRequest$SortBy' => '

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

', ], ], 'TrainingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingJobStatus' => '

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'HyperParameterTrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals' => '

A filter that returns only training jobs with the specified status.

', 'ListTrainingJobsRequest$StatusEquals' => '

A filter that retrieves only training jobs with a specific status.

', 'TrainingJob$TrainingJobStatus' => '

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'TrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', ], ], 'TrainingJobStatusCounter' => [ 'base' => NULL, 'refs' => [ 'TrainingJobStatusCounters$Completed' => '

The number of completed training jobs launched by the hyperparameter tuning job.

', 'TrainingJobStatusCounters$InProgress' => '

The number of in-progress training jobs launched by a hyperparameter tuning job.

', 'TrainingJobStatusCounters$RetryableError' => '

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

', 'TrainingJobStatusCounters$NonRetryableError' => '

The number of training jobs that failed and can\'t be retried. A failed training job can\'t be retried if it failed because a client error occurred.

', 'TrainingJobStatusCounters$Stopped' => '

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

', ], ], 'TrainingJobStatusCounters' => [ 'base' => '

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters' => NULL, 'HyperParameterTuningJobSummary$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

', ], ], 'TrainingJobStepMetadata' => [ 'base' => '

Metadata for a training job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TrainingJob' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', ], ], 'TrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsResponse$TrainingJobSummaries' => '

An array of TrainingJobSummary objects, each listing a training job.

', ], ], 'TrainingJobSummary' => [ 'base' => '

Provides summary information about a training job.

', 'refs' => [ 'TrainingJobSummaries$member' => NULL, ], ], 'TrainingRepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAccessMode' => '

The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.

', ], ], 'TrainingRepositoryAuthConfig' => [ 'base' => '

An object containing authentication information for a private Docker registry.

', 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAuthConfig' => '

An object containing authentication information for a private Docker registry containing your training images.

', ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.

', ], ], 'TrainingSpecification' => [ 'base' => '

Defines how the algorithm is used for a training job.

', 'refs' => [ 'CreateAlgorithmInput$TrainingSpecification' => '

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

', 'DescribeAlgorithmOutput$TrainingSpecification' => '

Details about training jobs run by this algorithm.

', ], ], 'TrainingTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingTimeInSeconds' => '

The training time in seconds.

', 'TrainingJob$TrainingTimeInSeconds' => '

The training time in seconds.

', ], ], 'TransformDataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'TransformInput$DataSource' => '

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

', ], ], 'TransformEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$key' => NULL, ], ], 'TransformEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'DescribeTransformJobResponse$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJob$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJobDefinition$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', ], ], 'TransformEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$value' => NULL, ], ], 'TransformInput' => [ 'base' => '

Describes the input source of a transform job and the way the transform job consumes it.

', 'refs' => [ 'CreateTransformJobRequest$TransformInput' => '

Describes the input source and the way the transform job consumes it.

', 'DescribeTransformJobResponse$TransformInput' => '

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

', 'TransformJob$TransformInput' => NULL, 'TransformJobDefinition$TransformInput' => '

A description of the input source and the way the transform job consumes it.

', ], ], 'TransformInstanceCount' => [ 'base' => NULL, 'refs' => [ 'TransformResources$InstanceCount' => '

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

', ], ], 'TransformInstanceType' => [ 'base' => NULL, 'refs' => [ 'TransformInstanceTypes$member' => NULL, 'TransformResources$InstanceType' => '

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

', ], ], 'TransformInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

', 'InferenceSpecification$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'TransformJob' => [ 'base' => '

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

', 'refs' => [ 'ModelDashboardModel$LastBatchTransformJob' => NULL, 'TrialComponentSourceDetail$TransformJob' => '

Information about a transform job that\'s the source of a trial component.

', ], ], 'TransformJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'DescribeTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJob$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', 'TransformJobSummary$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', ], ], 'TransformJobDefinition' => [ 'base' => '

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

', 'ModelPackageValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

', ], ], 'TransformJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$TransformJobName' => '

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTransformJobRequest$TransformJobName' => '

The name of the transform job that you want to view details of.

', 'DescribeTransformJobResponse$TransformJobName' => '

The name of the transform job.

', 'StopTransformJobRequest$TransformJobName' => '

The name of the batch transform job to stop.

', 'TransformJob$TransformJobName' => '

The name of the transform job.

', 'TransformJobSummary$TransformJobName' => '

The name of the transform job.

', ], ], 'TransformJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTransformJobResponse$TransformJobStatus' => '

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

', 'ListTransformJobsRequest$StatusEquals' => '

A filter that retrieves only transform jobs with a specific status.

', 'TransformJob$TransformJobStatus' => '

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.

  • Completed - The job has completed.

  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

  • Stopping - The transform job is stopping.

  • Stopped - The transform job has stopped.

', 'TransformJobSummary$TransformJobStatus' => '

The status of the transform job.

', ], ], 'TransformJobStepMetadata' => [ 'base' => '

Metadata for a transform job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TransformJob' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', ], ], 'TransformJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTransformJobsResponse$TransformJobSummaries' => '

An array of TransformJobSummary objects.

', ], ], 'TransformJobSummary' => [ 'base' => '

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

', 'refs' => [ 'TransformJobSummaries$member' => NULL, ], ], 'TransformOutput' => [ 'base' => '

Describes the results of a transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformOutput' => '

Describes the results of the transform job.

', 'DescribeTransformJobResponse$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', 'TransformJob$TransformOutput' => NULL, 'TransformJobDefinition$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', ], ], 'TransformResources' => [ 'base' => '

Describes the resources, including ML instance types and ML instance count, to use for transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'DescribeTransformJobResponse$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'TransformJob$TransformResources' => NULL, 'TransformJobDefinition$TransformResources' => '

Identifies the ML compute instances for the transform job.

', ], ], 'TransformS3DataSource' => [ 'base' => '

Describes the S3 data source.

', 'refs' => [ 'TransformDataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'TransformationAttributeName' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$key' => NULL, 'FillingTransformations$key' => NULL, ], ], 'Trial' => [ 'base' => '

The properties of a trial as returned by the Search API.

', 'refs' => [ 'SearchRecord$Trial' => '

The properties of a trial.

', ], ], 'TrialArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'CreateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DeleteTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial that is being deleted.

', 'DescribeTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DisassociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'Trial$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'TrialSummary$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'UpdateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', ], ], 'TrialComponent' => [ 'base' => '

The properties of a trial component as returned by the Search API.

', 'refs' => [ 'SearchRecord$TrialComponent' => '

The properties of a trial component.

', ], ], 'TrialComponentArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'CreateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DeleteTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the component is being deleted.

', 'DescribeTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DisassociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponent$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSimpleSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'UpdateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', ], ], 'TrialComponentArtifact' => [ 'base' => '

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'refs' => [ 'TrialComponentArtifacts$value' => NULL, ], ], 'TrialComponentArtifactValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$Value' => '

The location of the artifact.

', ], ], 'TrialComponentArtifacts' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$InputArtifacts' => '

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

', 'CreateTrialComponentRequest$OutputArtifacts' => '

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'DescribeTrialComponentResponse$InputArtifacts' => '

The input artifacts of the component.

', 'DescribeTrialComponentResponse$OutputArtifacts' => '

The output artifacts of the component.

', 'TrialComponent$InputArtifacts' => '

The input artifacts of the component.

', 'TrialComponent$OutputArtifacts' => '

The output artifacts of the component.

', 'UpdateTrialComponentRequest$InputArtifacts' => '

Replaces all of the component\'s input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

', 'UpdateTrialComponentRequest$OutputArtifacts' => '

Replaces all of the component\'s output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

', ], ], 'TrialComponentKey128' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifacts$key' => NULL, ], ], 'TrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentKey256$member' => NULL, ], ], 'TrialComponentKey320' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameters$key' => NULL, ], ], 'TrialComponentMetricSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Metrics' => '

The metrics for the component.

', 'TrialComponent$Metrics' => '

The metrics for the component.

', ], ], 'TrialComponentMetricSummary' => [ 'base' => '

A summary of the metrics of a trial component.

', 'refs' => [ 'TrialComponentMetricSummaries$member' => NULL, ], ], 'TrialComponentParameterValue' => [ 'base' => '

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

', 'refs' => [ 'TrialComponentParameters$value' => NULL, ], ], 'TrialComponentParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$Parameters' => '

The hyperparameters for the component.

', 'DescribeTrialComponentResponse$Parameters' => '

The hyperparameters of the component.

', 'TrialComponent$Parameters' => '

The hyperparameters of the component.

', 'UpdateTrialComponentRequest$Parameters' => '

Replaces all of the component\'s hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

', ], ], 'TrialComponentPrimaryStatus' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$PrimaryStatus' => '

The status of the trial component.

', ], ], 'TrialComponentSimpleSummaries' => [ 'base' => NULL, 'refs' => [ 'Trial$TrialComponentSummaries' => '

A list of the components associated with the trial. For each component, a summary of the component\'s properties is included.

', ], ], 'TrialComponentSimpleSummary' => [ 'base' => '

A short summary of a trial component.

', 'refs' => [ 'TrialComponentSimpleSummaries$member' => NULL, ], ], 'TrialComponentSource' => [ 'base' => '

The Amazon Resource Name (ARN) and job type of the source of a trial component.

', 'refs' => [ 'DescribeTrialComponentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'TrialComponent$Source' => '

The Amazon Resource Name (ARN) and job type of the source of the component.

', 'TrialComponentSimpleSummary$TrialComponentSource' => NULL, 'TrialComponentSources$member' => NULL, 'TrialComponentSummary$TrialComponentSource' => NULL, ], ], 'TrialComponentSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', 'TrialComponentSource$SourceArn' => '

The source Amazon Resource Name (ARN).

', 'TrialComponentSourceDetail$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialComponentSourceDetail' => [ 'base' => '

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

', 'refs' => [ 'TrialComponent$SourceDetail' => '

Details of the source of the component.

', ], ], 'TrialComponentSources' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Sources' => '

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

', ], ], 'TrialComponentStatus' => [ 'base' => '

The status of the trial component.

', 'refs' => [ 'CreateTrialComponentRequest$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'DescribeTrialComponentResponse$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'TrialComponent$Status' => NULL, 'TrialComponentSummary$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'UpdateTrialComponentRequest$Status' => '

The new status of the component.

', ], ], 'TrialComponentStatusMessage' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$Message' => '

If the component failed, a message describing why.

', ], ], 'TrialComponentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsResponse$TrialComponentSummaries' => '

A list of the summaries of your trial components.

', ], ], 'TrialComponentSummary' => [ 'base' => '

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

', 'refs' => [ 'TrialComponentSummaries$member' => NULL, ], ], 'TrialSource' => [ 'base' => '

The source of the trial.

', 'refs' => [ 'DescribeTrialResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'Trial$Source' => NULL, 'TrialSummary$TrialSource' => NULL, ], ], 'TrialSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialsResponse$TrialSummaries' => '

A list of the summaries of your trials.

', ], ], 'TrialSummary' => [ 'base' => '

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

', 'refs' => [ 'TrialSummaries$member' => NULL, ], ], 'TtlDuration' => [ 'base' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'refs' => [ 'OnlineStoreConfig$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'OnlineStoreConfigUpdate$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', ], ], 'TtlDurationUnit' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Unit' => '

TtlDuration time unit.

', ], ], 'TtlDurationValue' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Value' => '

TtlDuration time value.

', ], ], 'TuningJobCompletionCriteria' => [ 'base' => '

The job completion criteria.

', 'refs' => [ 'HyperParameterTuningJobConfig$TuningJobCompletionCriteria' => '

The tuning job\'s completion criteria.

', ], ], 'TuningJobStepMetaData' => [ 'base' => '

Metadata for a tuning step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TuningJob' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'USD' => [ 'base' => '

Represents an amount of money in United States dollars.

', 'refs' => [ 'PublicWorkforceTaskPrice$AmountInUsd' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

', ], ], 'UiConfig' => [ 'base' => '

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

', 'refs' => [ 'HumanTaskConfig$UiConfig' => '

Information about the user interface that workers use to complete the labeling task.

', ], ], 'UiTemplate' => [ 'base' => '

The Liquid template for the worker user interface.

', 'refs' => [ 'CreateHumanTaskUiRequest$UiTemplate' => NULL, 'RenderUiTemplateRequest$UiTemplate' => '

A Template object containing the worker UI template to render.

', ], ], 'UiTemplateInfo' => [ 'base' => '

Container for user interface template information.

', 'refs' => [ 'DescribeHumanTaskUiResponse$UiTemplate' => NULL, ], ], 'Uid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Uid' => '

The POSIX user ID.

', ], ], 'UpdateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSoftwareRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSoftwareResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$ModelDataUrl' => '

The location of the model artifacts. For more information, see ContainerDefinition.

', 'ClarifyShapBaselineConfig$ShapBaselineUri' => '

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

', 'ContainerDefinition$ModelDataUrl' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

', 'InferenceComponentContainerSpecification$ArtifactUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InferenceComponentContainerSpecificationSummary$ArtifactUrl' => '

The Amazon S3 path where the model artifacts are stored.

', 'ModelPackageContainerDefinition$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

', 'SourceAlgorithm$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.

', ], ], 'UserContext' => [ 'base' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

', 'refs' => [ 'AssociationSummary$CreatedBy' => NULL, 'DescribeActionResponse$CreatedBy' => NULL, 'DescribeActionResponse$LastModifiedBy' => NULL, 'DescribeArtifactResponse$CreatedBy' => NULL, 'DescribeArtifactResponse$LastModifiedBy' => NULL, 'DescribeContextResponse$CreatedBy' => NULL, 'DescribeContextResponse$LastModifiedBy' => NULL, 'DescribeExperimentResponse$CreatedBy' => '

Who created the experiment.

', 'DescribeExperimentResponse$LastModifiedBy' => '

Who last modified the experiment.

', 'DescribeLineageGroupResponse$CreatedBy' => NULL, 'DescribeLineageGroupResponse$LastModifiedBy' => NULL, 'DescribeModelCardResponse$CreatedBy' => NULL, 'DescribeModelCardResponse$LastModifiedBy' => NULL, 'DescribeModelPackageGroupOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$LastModifiedBy' => NULL, 'DescribePipelineExecutionResponse$CreatedBy' => NULL, 'DescribePipelineExecutionResponse$LastModifiedBy' => NULL, 'DescribePipelineResponse$CreatedBy' => NULL, 'DescribePipelineResponse$LastModifiedBy' => NULL, 'DescribeProjectOutput$CreatedBy' => NULL, 'DescribeProjectOutput$LastModifiedBy' => NULL, 'DescribeTrialComponentResponse$CreatedBy' => '

Who created the trial component.

', 'DescribeTrialComponentResponse$LastModifiedBy' => '

Who last modified the component.

', 'DescribeTrialResponse$CreatedBy' => '

Who created the trial.

', 'DescribeTrialResponse$LastModifiedBy' => '

Who last modified the trial.

', 'Experiment$CreatedBy' => '

Who created the experiment.

', 'Experiment$LastModifiedBy' => NULL, 'ModelCard$CreatedBy' => NULL, 'ModelCard$LastModifiedBy' => NULL, 'ModelDashboardModelCard$CreatedBy' => NULL, 'ModelDashboardModelCard$LastModifiedBy' => NULL, 'ModelPackage$CreatedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackage$LastModifiedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackageGroup$CreatedBy' => NULL, 'Pipeline$CreatedBy' => NULL, 'Pipeline$LastModifiedBy' => NULL, 'PipelineExecution$CreatedBy' => NULL, 'PipelineExecution$LastModifiedBy' => NULL, 'Project$CreatedBy' => '

Who created the project.

', 'Project$LastModifiedBy' => NULL, 'Trial$CreatedBy' => '

Who created the trial.

', 'Trial$LastModifiedBy' => NULL, 'TrialComponent$CreatedBy' => '

Who created the trial component.

', 'TrialComponent$LastModifiedBy' => NULL, 'TrialComponentSimpleSummary$CreatedBy' => NULL, 'TrialComponentSummary$CreatedBy' => '

Who created the trial component.

', 'TrialComponentSummary$LastModifiedBy' => '

Who last modified the component.

', ], ], 'UserProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'DescribeUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'UpdateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', ], ], 'UserProfileDetails' => [ 'base' => '

The user profile details.

', 'refs' => [ 'UserProfileList$member' => NULL, ], ], 'UserProfileList' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesResponse$UserProfiles' => '

The list of user profiles.

', ], ], 'UserProfileName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$UserProfileName' => '

The user profile name.

', 'CreateAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'CreatePresignedDomainUrlRequest$UserProfileName' => '

The name of the UserProfile to sign-in as.

', 'CreateUserProfileRequest$UserProfileName' => '

A name for the UserProfile. This value is not case sensitive.

', 'DeleteAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DeleteUserProfileRequest$UserProfileName' => '

The user profile name.

', 'DescribeAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DescribeAppResponse$UserProfileName' => '

The user profile name.

', 'DescribeUserProfileRequest$UserProfileName' => '

The user profile name. This value is not case sensitive.

', 'DescribeUserProfileResponse$UserProfileName' => '

The user profile name.

', 'ListAppsRequest$UserProfileNameEquals' => '

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

', 'ListUserProfilesRequest$UserProfileNameContains' => '

A parameter by which to filter the results.

', 'OwnershipSettings$OwnerUserProfileName' => '

The user profile who is the owner of the space.

', 'OwnershipSettingsSummary$OwnerUserProfileName' => '

The user profile who is the owner of the space.

', 'UpdateUserProfileRequest$UserProfileName' => '

The user profile name.

', 'UserProfileDetails$UserProfileName' => '

The user profile name.

', ], ], 'UserProfileSortKey' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'UserProfileStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeUserProfileResponse$Status' => '

The status.

', 'UserProfileDetails$Status' => '

The status.

', ], ], 'UserSettings' => [ 'base' => '

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'refs' => [ 'CreateDomainRequest$DefaultUserSettings' => '

The default settings to use to create a user profile when UserSettings isn\'t specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'CreateUserProfileRequest$UserSettings' => '

A collection of settings.

', 'DescribeDomainResponse$DefaultUserSettings' => '

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

', 'DescribeUserProfileResponse$UserSettings' => '

A collection of settings.

', 'UpdateDomainRequest$DefaultUserSettings' => '

A collection of settings.

', 'UpdateUserProfileRequest$UserSettings' => '

A collection of settings.

', ], ], 'UsersPerStep' => [ 'base' => NULL, 'refs' => [ 'Stairs$UsersPerStep' => '

Specifies how many new users to spawn in each step.

', ], ], 'UtilizationMetric' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$CpuUtilization' => '

The expected CPU utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', 'RecommendationMetrics$MemoryUtilization' => '

The expected memory utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', ], ], 'UtilizationPercentagePerCore' => [ 'base' => NULL, 'refs' => [ 'GetScalingConfigurationRecommendationRequest$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

', 'GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

', ], ], 'ValidationFraction' => [ 'base' => NULL, 'refs' => [ 'AutoMLDataSplitConfig$ValidationFraction' => '

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

', ], ], 'VariantName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$VariantName' => '

The name of an existing production variant where you host the inference component.

', 'DescribeInferenceComponentOutput$VariantName' => '

The name of the production variant that hosts the inference component.

', 'DesiredWeightAndCapacity$VariantName' => '

The name of the variant to update.

', 'InferenceComponentSummary$VariantName' => '

The name of the production variant that hosts the inference component.

', 'ListInferenceComponentsInput$VariantNameEquals' => '

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

', 'PendingProductionVariantSummary$VariantName' => '

The name of the variant.

', 'ProductionVariant$VariantName' => '

The name of the production variant.

', 'ProductionVariantSummary$VariantName' => '

The name of the variant.

', ], ], 'VariantProperty' => [ 'base' => '

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

', 'refs' => [ 'VariantPropertyList$member' => NULL, ], ], 'VariantPropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointInput$ExcludeRetainedVariantProperties' => '

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don\'t specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

', ], ], 'VariantPropertyType' => [ 'base' => NULL, 'refs' => [ 'VariantProperty$VariantPropertyType' => '

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

', ], ], 'VariantStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$Status' => '

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.

  • Deleting: Terminating inference resources for the production variant.

  • Updating: Updating capacity for the production variant.

  • ActivatingTraffic: Turning on traffic for the production variant.

  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

', ], ], 'VariantStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$StatusMessage' => '

A message that describes the status of the production variant.

', ], ], 'VariantWeight' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredWeight' => '

The variant\'s weight.

', 'PendingProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'PendingProductionVariantSummary$DesiredWeight' => '

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariant$InitialVariantWeight' => '

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

', 'ProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'ProductionVariantSummary$DesiredWeight' => '

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

', ], ], 'VectorConfig' => [ 'base' => '

Configuration for your vector collection type.

', 'refs' => [ 'CollectionConfig$VectorConfig' => '

Configuration for your vector collection type.

  • Dimension: The number of elements in your vector.

', ], ], 'VendorGuidance' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$VendorGuidance' => '

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'DescribeImageVersionResponse$VendorGuidance' => '

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'UpdateImageVersionRequest$VendorGuidance' => '

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$VersionId' => '

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

', ], ], 'VersionedArnOrName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

', 'DeleteModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'DescribeModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', ], ], 'Vertex' => [ 'base' => '

A lineage entity connected to the starting entity(ies).

', 'refs' => [ 'Vertices$member' => NULL, ], ], 'Vertices' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Vertices' => '

A list of vertices connected to the start entity(ies) in the lineage graph.

', ], ], 'VisibilityConditions' => [ 'base' => '

The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn\'t match, the result is excluded from the search response. Any resources that don\'t have a key from the list that you\'ve provided will also be included in the search response.

', 'refs' => [ 'VisibilityConditionsList$member' => NULL, ], ], 'VisibilityConditionsKey' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Key' => '

The key that specifies the tag that you\'re using to filter the search results. It must be in the following format: Tags.<key>.

', ], ], 'VisibilityConditionsList' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$VisibilityConditions' => '

Limits the results of your search request to the resources that you can access.

', ], ], 'VisibilityConditionsValue' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Value' => '

The value for the tag that you\'re using to filter the search results.

', ], ], 'VolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$VolumeSizeInGB' => '

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

', 'ResourceConfig$VolumeSizeInGB' => '

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn\'t provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance\'s storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

', ], ], 'VpcConfig' => [ 'base' => '

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

', 'refs' => [ 'AutoMLSecurityConfig$VpcConfig' => '

The VPC configuration.

', 'CreateClusterRequest$VpcConfig' => NULL, 'CreateEndpointConfigInput$VpcConfig' => NULL, 'CreateModelInput$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

', 'CreateTrainingJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeClusterResponse$VpcConfig' => NULL, 'DescribeEndpointConfigOutput$VpcConfig' => NULL, 'DescribeModelOutput$VpcConfig' => '

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

', 'DescribeTrainingJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'HyperParameterTrainingJobDefinition$VpcConfig' => '

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'LabelingJobResourceConfig$VpcConfig' => NULL, 'Model$VpcConfig' => NULL, 'MonitoringNetworkConfig$VpcConfig' => NULL, 'NetworkConfig$VpcConfig' => NULL, 'TrainingJob$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', 'DescribeDomainResponse$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', ], ], 'VpcOnlyTrustedAccounts' => [ 'base' => NULL, 'refs' => [ 'DockerSettings$VpcOnlyTrustedAccounts' => '

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

', ], ], 'VpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'WaitIntervalInSeconds' => [ 'base' => NULL, 'refs' => [ 'RollingUpdatePolicy$WaitIntervalInSeconds' => '

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

', 'TrafficRoutingConfig$WaitIntervalInSeconds' => '

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

', ], ], 'WarmPoolResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsRequest$WarmPoolStatusEquals' => '

A filter that retrieves only training jobs with a specific warm pool status.

', 'WarmPoolStatus$Status' => '

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

', ], ], 'WarmPoolStatus' => [ 'base' => '

Status and billing information about the warm pool.

', 'refs' => [ 'DescribeTrainingJobResponse$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', 'TrainingJobSummary$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', ], ], 'Workforce' => [ 'base' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'refs' => [ 'DescribeWorkforceResponse$Workforce' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'UpdateWorkforceResponse$Workforce' => '

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'Workforces$member' => NULL, ], ], 'WorkforceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceResponse$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', 'Workforce$WorkforceArn' => '

The Amazon Resource Name (ARN) of the private workforce.

', 'Workteam$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', ], ], 'WorkforceFailureReason' => [ 'base' => NULL, 'refs' => [ 'Workforce$FailureReason' => '

The reason your workforce failed.

', ], ], 'WorkforceName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceRequest$WorkforceName' => '

The name of the private workforce.

', 'CreateWorkteamRequest$WorkforceName' => '

The name of the workforce.

', 'DeleteWorkforceRequest$WorkforceName' => '

The name of the workforce.

', 'DescribeWorkforceRequest$WorkforceName' => '

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

', 'ListWorkforcesRequest$NameContains' => '

A filter you can use to search for workforces using part of the workforce name.

', 'UpdateWorkforceRequest$WorkforceName' => '

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

', 'Workforce$WorkforceName' => '

The name of the private workforce.

', ], ], 'WorkforceSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSecurityGroupIds$member' => NULL, ], ], 'WorkforceSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'WorkforceVpcConfigResponse$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', ], ], 'WorkforceStatus' => [ 'base' => NULL, 'refs' => [ 'Workforce$Status' => '

The status of your workforce.

', ], ], 'WorkforceSubnetId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSubnets$member' => NULL, ], ], 'WorkforceSubnets' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', 'WorkforceVpcConfigResponse$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', ], ], 'WorkforceVpcConfigRequest' => [ 'base' => '

The VPC object you use to create or update a workforce.

', 'refs' => [ 'CreateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to configure a workforce using VPC.

', 'UpdateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to update your VPC configuration for a workforce.

', ], ], 'WorkforceVpcConfigResponse' => [ 'base' => '

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

', 'refs' => [ 'Workforce$WorkforceVpcConfig' => '

The configuration of a VPC workforce.

', ], ], 'WorkforceVpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigResponse$VpcEndpointId' => '

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

', ], ], 'WorkforceVpcId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', 'WorkforceVpcConfigResponse$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', ], ], 'Workforces' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesResponse$Workforces' => '

A list containing information about your workforce.

', ], ], 'WorkspaceSettings' => [ 'base' => '

The workspace settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$WorkspaceSettings' => '

The workspace settings for the SageMaker Canvas application.

', ], ], 'Workteam' => [ 'base' => '

Provides details about a labeling work team.

', 'refs' => [ 'DescribeWorkteamResponse$Workteam' => '

A Workteam instance that contains information about the work team.

', 'UpdateWorkteamResponse$Workteam' => '

A Workteam object that describes the updated work team.

', 'Workteams$member' => NULL, ], ], 'WorkteamArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamResponse$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

', 'DescribeSubscribedWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the subscribed work team to describe.

', 'HumanLoopConfig$WorkteamArn' => '

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

', 'HumanTaskConfig$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

', 'LabelingJobSummary$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to the job.

', 'ListLabelingJobsForWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

', 'SubscribedWorkteam$WorkteamArn' => '

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

', 'Workteam$WorkteamArn' => '

The Amazon Resource Name (ARN) that identifies the work team.

', ], ], 'WorkteamName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$WorkteamName' => '

The name of the work team. Use this name to identify the work team.

', 'DeleteWorkteamRequest$WorkteamName' => '

The name of the work team to delete.

', 'DescribeWorkteamRequest$WorkteamName' => '

The name of the work team to return a description of.

', 'ListSubscribedWorkteamsRequest$NameContains' => '

A string in the work team name. This filter returns only work teams whose name contains the specified string.

', 'ListWorkteamsRequest$NameContains' => '

A string in the work team\'s name. This filter returns only work teams whose name contains the specified string.

', 'UpdateWorkteamRequest$WorkteamName' => '

The name of the work team to update.

', 'Workteam$WorkteamName' => '

The name of the work team.

', ], ], 'Workteams' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsResponse$Workteams' => '

An array of Workteam objects, each describing a work team.

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

Provides APIs for creating and managing SageMaker resources.

Other Resources:

', 'operations' => [ 'AddAssociation' => '

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'AddTags' => '

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

', 'AssociateTrialComponent' => '

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'BatchDescribeModelPackage' => '

This action batch describes a list of versioned model packages

', 'CreateAction' => '

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAlgorithm' => '

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

', 'CreateApp' => '

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

', 'CreateAppImageConfig' => '

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

', 'CreateArtifact' => '

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAutoMLJob' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

', 'CreateAutoMLJobV2' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

', 'CreateCluster' => '

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

', 'CreateCodeRepository' => '

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

', 'CreateCompilationJob' => '

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job\'s resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'CreateContext' => '

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateDataQualityJobDefinition' => '

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateDeviceFleet' => '

Creates a device fleet.

', 'CreateDomain' => '

Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

    When internet access is disabled, you won\'t be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

', 'CreateEdgeDeploymentPlan' => '

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

', 'CreateEdgeDeploymentStage' => '

Creates a new stage in an existing edge deployment plan.

', 'CreateEdgePackagingJob' => '

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

', 'CreateEndpoint' => '

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

    "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]

    "Resource": [

    "arn:aws:sagemaker:region:account-id:endpoint/endpointName"

    "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"

    ]

    For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

', 'CreateEndpointConfig' => '

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

', 'CreateExperiment' => '

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment\'s properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

', 'CreateFeatureGroup' => '

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

', 'CreateFlowDefinition' => '

Creates a flow definition.

', 'CreateHub' => '

Create a hub.

Hub APIs are only callable through SageMaker Studio.

', 'CreateHumanTaskUi' => '

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

', 'CreateHyperParameterTuningJob' => '

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'CreateImage' => '

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.

', 'CreateImageVersion' => '

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

', 'CreateInferenceComponent' => '

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

', 'CreateInferenceExperiment' => '

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint\'s model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

', 'CreateInferenceRecommendationsJob' => '

Starts a recommendation job. You can create either an instance recommendation or load test job.

', 'CreateLabelingJob' => '

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

', 'CreateModel' => '

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

', 'CreateModelBiasJobDefinition' => '

Creates the definition for a model bias job.

', 'CreateModelCard' => '

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

', 'CreateModelCardExportJob' => '

Creates an Amazon SageMaker Model Card export job.

', 'CreateModelExplainabilityJobDefinition' => '

Creates the definition for a model explainability job.

', 'CreateModelPackage' => '

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.

  • Unversioned - a model package that is not part of a model group.

', 'CreateModelPackageGroup' => '

Creates a model group. A model group contains a group of model versions.

', 'CreateModelQualityJobDefinition' => '

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateMonitoringSchedule' => '

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.

', 'CreateNotebookInstance' => '

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker does the following:

  1. Creates a network interface in the SageMaker VPC.

  2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can\'t change the name of a notebook instance after you create it.

After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

', 'CreateNotebookInstanceLifecycleConfig' => '

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreatePipeline' => '

Creates a pipeline using a JSON pipeline definition.

', 'CreatePresignedDomainUrl' => '

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain\'s Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreatePresignedNotebookInstanceUrl' => '

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreateProcessingJob' => '

Creates a processing job.

', 'CreateProject' => '

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

', 'CreateSpace' => '

Creates a space used for real time collaboration in a domain.

', 'CreateStudioLifecycleConfig' => '

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

', 'CreateTrainingJob' => '

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

    Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

  • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

  • Environment - The environment variables to set in the Docker container.

  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

For more information about SageMaker, see How It Works.

', 'CreateTransformJob' => '

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works, see Batch Transform.

', 'CreateTrial' => '

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial\'s properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

', 'CreateTrialComponent' => '

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

', 'CreateUserProfile' => '

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user\'s private Amazon Elastic File System home directory.

', 'CreateWorkforce' => '

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

', 'CreateWorkteam' => '

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

', 'DeleteAction' => '

Deletes an action.

', 'DeleteAlgorithm' => '

Removes the specified algorithm from your account.

', 'DeleteApp' => '

Used to stop and delete an app.

', 'DeleteAppImageConfig' => '

Deletes an AppImageConfig.

', 'DeleteArtifact' => '

Deletes an artifact. Either ArtifactArn or Source must be specified.

', 'DeleteAssociation' => '

Deletes an association.

', 'DeleteCluster' => '

Delete a SageMaker HyperPod cluster.

', 'DeleteCodeRepository' => '

Deletes the specified Git repository from your account.

', 'DeleteCompilationJob' => '

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn\'t delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

', 'DeleteContext' => '

Deletes an context.

', 'DeleteDataQualityJobDefinition' => '

Deletes a data quality monitoring job definition.

', 'DeleteDeviceFleet' => '

Deletes a fleet.

', 'DeleteDomain' => '

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteEdgeDeploymentPlan' => '

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

', 'DeleteEdgeDeploymentStage' => '

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

', 'DeleteEndpoint' => '

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don\'t need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

', 'DeleteEndpointConfig' => '

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'DeleteExperiment' => '

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

', 'DeleteFeatureGroup' => '

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

', 'DeleteFlowDefinition' => '

Deletes the specified flow definition.

', 'DeleteHub' => '

Delete a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHubContent' => '

Delete the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHumanTaskUi' => '

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

', 'DeleteHyperParameterTuningJob' => '

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

', 'DeleteImage' => '

Deletes a SageMaker image and all versions of the image. The container images aren\'t deleted.

', 'DeleteImageVersion' => '

Deletes a version of a SageMaker image. The container image the version represents isn\'t deleted.

', 'DeleteInferenceComponent' => '

Deletes an inference component.

', 'DeleteInferenceExperiment' => '

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

', 'DeleteModel' => '

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

', 'DeleteModelBiasJobDefinition' => '

Deletes an Amazon SageMaker model bias job definition.

', 'DeleteModelCard' => '

Deletes an Amazon SageMaker Model Card.

', 'DeleteModelExplainabilityJobDefinition' => '

Deletes an Amazon SageMaker model explainability job definition.

', 'DeleteModelPackage' => '

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

', 'DeleteModelPackageGroup' => '

Deletes the specified model group.

', 'DeleteModelPackageGroupPolicy' => '

Deletes a model group resource policy.

', 'DeleteModelQualityJobDefinition' => '

Deletes the secified model quality monitoring job definition.

', 'DeleteMonitoringSchedule' => '

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

', 'DeleteNotebookInstance' => '

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

', 'DeleteNotebookInstanceLifecycleConfig' => '

Deletes a notebook instance lifecycle configuration.

', 'DeletePipeline' => '

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

', 'DeleteProject' => '

Delete the specified project.

', 'DeleteSpace' => '

Used to delete a space.

', 'DeleteStudioLifecycleConfig' => '

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

', 'DeleteTags' => '

Deletes the specified tags from an SageMaker resource.

To list a resource\'s tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

', 'DeleteTrial' => '

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

', 'DeleteTrialComponent' => '

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'DeleteUserProfile' => '

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteWorkforce' => '

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

', 'DeleteWorkteam' => '

Deletes an existing work team. This operation can\'t be undone.

', 'DeregisterDevices' => '

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

', 'DescribeAction' => '

Describes an action.

', 'DescribeAlgorithm' => '

Returns a description of the specified algorithm that is in your account.

', 'DescribeApp' => '

Describes the app.

', 'DescribeAppImageConfig' => '

Describes an AppImageConfig.

', 'DescribeArtifact' => '

Describes an artifact.

', 'DescribeAutoMLJob' => '

Returns information about an AutoML job created by calling CreateAutoMLJob.

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

', 'DescribeAutoMLJobV2' => '

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

', 'DescribeCluster' => '

Retrieves information of a SageMaker HyperPod cluster.

', 'DescribeClusterNode' => '

Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'DescribeCodeRepository' => '

Gets details about the specified Git repository.

', 'DescribeCompilationJob' => '

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'DescribeContext' => '

Describes a context.

', 'DescribeDataQualityJobDefinition' => '

Gets the details of a data quality monitoring job definition.

', 'DescribeDevice' => '

Describes the device.

', 'DescribeDeviceFleet' => '

A description of the fleet the device belongs to.

', 'DescribeDomain' => '

The description of the domain.

', 'DescribeEdgeDeploymentPlan' => '

Describes an edge deployment plan with deployment status per stage.

', 'DescribeEdgePackagingJob' => '

A description of edge packaging jobs.

', 'DescribeEndpoint' => '

Returns the description of an endpoint.

', 'DescribeEndpointConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeExperiment' => '

Provides a list of an experiment\'s properties.

', 'DescribeFeatureGroup' => '

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

', 'DescribeFeatureMetadata' => '

Shows the metadata for a feature within a feature group.

', 'DescribeFlowDefinition' => '

Returns information about the specified flow definition.

', 'DescribeHub' => '

Describe a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHubContent' => '

Describe the content of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHumanTaskUi' => '

Returns information about the requested human task user interface (worker task template).

', 'DescribeHyperParameterTuningJob' => '

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

', 'DescribeImage' => '

Describes a SageMaker image.

', 'DescribeImageVersion' => '

Describes a version of a SageMaker image.

', 'DescribeInferenceComponent' => '

Returns information about an inference component.

', 'DescribeInferenceExperiment' => '

Returns details about an inference experiment.

', 'DescribeInferenceRecommendationsJob' => '

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

', 'DescribeLabelingJob' => '

Gets information about a labeling job.

', 'DescribeLineageGroup' => '

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'DescribeModel' => '

Describes a model that you created using the CreateModel API.

', 'DescribeModelBiasJobDefinition' => '

Returns a description of a model bias job definition.

', 'DescribeModelCard' => '

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

', 'DescribeModelCardExportJob' => '

Describes an Amazon SageMaker Model Card export job.

', 'DescribeModelExplainabilityJobDefinition' => '

Returns a description of a model explainability job definition.

', 'DescribeModelPackage' => '

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

', 'DescribeModelPackageGroup' => '

Gets a description for the specified model group.

', 'DescribeModelQualityJobDefinition' => '

Returns a description of a model quality job definition.

', 'DescribeMonitoringSchedule' => '

Describes the schedule for a monitoring job.

', 'DescribeNotebookInstance' => '

Returns information about a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfig' => '

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'DescribePipeline' => '

Describes the details of a pipeline.

', 'DescribePipelineDefinitionForExecution' => '

Describes the details of an execution\'s pipeline definition.

', 'DescribePipelineExecution' => '

Describes the details of a pipeline execution.

', 'DescribeProcessingJob' => '

Returns a description of a processing job.

', 'DescribeProject' => '

Describes the details of a project.

', 'DescribeSpace' => '

Describes the space.

', 'DescribeStudioLifecycleConfig' => '

Describes the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeSubscribedWorkteam' => '

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

', 'DescribeTrainingJob' => '

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

', 'DescribeTransformJob' => '

Returns information about a transform job.

', 'DescribeTrial' => '

Provides a list of a trial\'s properties.

', 'DescribeTrialComponent' => '

Provides a list of a trials component\'s properties.

', 'DescribeUserProfile' => '

Describes a user profile. For more information, see CreateUserProfile.

', 'DescribeWorkforce' => '

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

', 'DescribeWorkteam' => '

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team\'s Amazon Resource Name (ARN).

', 'DisableSagemakerServicecatalogPortfolio' => '

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'DisassociateTrialComponent' => '

Disassociates a trial component from a trial. This doesn\'t effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

', 'EnableSagemakerServicecatalogPortfolio' => '

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetDeviceFleetReport' => '

Describes a fleet.

', 'GetLineageGroupPolicy' => '

The resource policy for the lineage group.

', 'GetModelPackageGroupPolicy' => '

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'GetSagemakerServicecatalogPortfolioStatus' => '

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetScalingConfigurationRecommendation' => '

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

', 'GetSearchSuggestions' => '

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

', 'ImportHubContent' => '

Import hub content.

Hub APIs are only callable through SageMaker Studio.

', 'ListActions' => '

Lists the actions in your account and their properties.

', 'ListAlgorithms' => '

Lists the machine learning algorithms that have been created.

', 'ListAliases' => '

Lists the aliases of a specified image or image version.

', 'ListAppImageConfigs' => '

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

', 'ListApps' => '

Lists apps.

', 'ListArtifacts' => '

Lists the artifacts in your account and their properties.

', 'ListAssociations' => '

Lists the associations in your account and their properties.

', 'ListAutoMLJobs' => '

Request a list of jobs.

', 'ListCandidatesForAutoMLJob' => '

List the candidates created for the job.

', 'ListClusterNodes' => '

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

', 'ListClusters' => '

Retrieves the list of SageMaker HyperPod clusters.

', 'ListCodeRepositories' => '

Gets a list of the Git repositories in your account.

', 'ListCompilationJobs' => '

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

', 'ListContexts' => '

Lists the contexts in your account and their properties.

', 'ListDataQualityJobDefinitions' => '

Lists the data quality job definitions in your account.

', 'ListDeviceFleets' => '

Returns a list of devices in the fleet.

', 'ListDevices' => '

A list of devices.

', 'ListDomains' => '

Lists the domains.

', 'ListEdgeDeploymentPlans' => '

Lists all edge deployment plans.

', 'ListEdgePackagingJobs' => '

Returns a list of edge packaging jobs.

', 'ListEndpointConfigs' => '

Lists endpoint configurations.

', 'ListEndpoints' => '

Lists endpoints.

', 'ListExperiments' => '

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

', 'ListFeatureGroups' => '

List FeatureGroups based on given filter and order.

', 'ListFlowDefinitions' => '

Returns information about the flow definitions in your account.

', 'ListHubContentVersions' => '

List hub content versions.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubContents' => '

List the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubs' => '

List all existing hubs.

Hub APIs are only callable through SageMaker Studio.

', 'ListHumanTaskUis' => '

Returns information about the human task user interfaces in your account.

', 'ListHyperParameterTuningJobs' => '

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

', 'ListImageVersions' => '

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

', 'ListImages' => '

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

', 'ListInferenceComponents' => '

Lists the inference components in your account and their properties.

', 'ListInferenceExperiments' => '

Returns the list of all inference experiments.

', 'ListInferenceRecommendationsJobSteps' => '

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobs' => '

Lists recommendation jobs that satisfy various filters.

', 'ListLabelingJobs' => '

Gets a list of labeling jobs.

', 'ListLabelingJobsForWorkteam' => '

Gets a list of labeling jobs assigned to a specified work team.

', 'ListLineageGroups' => '

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'ListModelBiasJobDefinitions' => '

Lists model bias jobs definitions that satisfy various filters.

', 'ListModelCardExportJobs' => '

List the export jobs for the Amazon SageMaker Model Card.

', 'ListModelCardVersions' => '

List existing versions of an Amazon SageMaker Model Card.

', 'ListModelCards' => '

List existing model cards.

', 'ListModelExplainabilityJobDefinitions' => '

Lists model explainability job definitions that satisfy various filters.

', 'ListModelMetadata' => '

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

', 'ListModelPackageGroups' => '

Gets a list of the model groups in your Amazon Web Services account.

', 'ListModelPackages' => '

Lists the model packages that have been created.

', 'ListModelQualityJobDefinitions' => '

Gets a list of model quality monitoring job definitions in your account.

', 'ListModels' => '

Lists models created with the CreateModel API.

', 'ListMonitoringAlertHistory' => '

Gets a list of past alerts in a model monitoring schedule.

', 'ListMonitoringAlerts' => '

Gets the alerts for a single monitoring schedule.

', 'ListMonitoringExecutions' => '

Returns list of all monitoring job executions.

', 'ListMonitoringSchedules' => '

Returns list of all monitoring schedules.

', 'ListNotebookInstanceLifecycleConfigs' => '

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

', 'ListNotebookInstances' => '

Returns a list of the SageMaker notebook instances in the requester\'s account in an Amazon Web Services Region.

', 'ListPipelineExecutionSteps' => '

Gets a list of PipeLineExecutionStep objects.

', 'ListPipelineExecutions' => '

Gets a list of the pipeline executions.

', 'ListPipelineParametersForExecution' => '

Gets a list of parameters for a pipeline execution.

', 'ListPipelines' => '

Gets a list of pipelines.

', 'ListProcessingJobs' => '

Lists processing jobs that satisfy various filters.

', 'ListProjects' => '

Gets a list of the projects in an Amazon Web Services account.

', 'ListResourceCatalogs' => '

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

', 'ListSpaces' => '

Lists spaces.

', 'ListStageDevices' => '

Lists devices allocated to the stage, containing detailed device information and deployment status.

', 'ListStudioLifecycleConfigs' => '

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

', 'ListSubscribedWorkteams' => '

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'ListTags' => '

Returns the tags for the specified SageMaker resource.

', 'ListTrainingJobs' => '

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

', 'ListTrainingJobsForHyperParameterTuningJob' => '

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

', 'ListTransformJobs' => '

Lists transform jobs.

', 'ListTrialComponents' => '

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

', 'ListTrials' => '

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

', 'ListUserProfiles' => '

Lists user profiles.

', 'ListWorkforces' => '

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

', 'ListWorkteams' => '

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'PutModelPackageGroupPolicy' => '

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'QueryLineage' => '

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

', 'RegisterDevices' => '

Register devices.

', 'RenderUiTemplate' => '

Renders the UI template so that you can preview the worker\'s experience.

', 'RetryPipelineExecution' => '

Retry the execution of the pipeline.

', 'Search' => '

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

', 'SendPipelineExecutionStepFailure' => '

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'SendPipelineExecutionStepSuccess' => '

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step\'s output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'StartEdgeDeploymentStage' => '

Starts a stage in an edge deployment plan.

', 'StartInferenceExperiment' => '

Starts an inference experiment.

', 'StartMonitoringSchedule' => '

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

', 'StartNotebookInstance' => '

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance\'s status must be InService before you can connect to your Jupyter notebook.

', 'StartPipelineExecution' => '

Starts a pipeline execution.

', 'StopAutoMLJob' => '

A method for forcing a running job to shut down.

', 'StopCompilationJob' => '

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn\'t stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

', 'StopEdgeDeploymentStage' => '

Stops a stage in an edge deployment plan.

', 'StopEdgePackagingJob' => '

Request to stop an edge packaging job.

', 'StopHyperParameterTuningJob' => '

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

', 'StopInferenceExperiment' => '

Stops an inference experiment.

', 'StopInferenceRecommendationsJob' => '

Stops an Inference Recommender job.

', 'StopLabelingJob' => '

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

', 'StopMonitoringSchedule' => '

Stops a previously started monitoring schedule.

', 'StopNotebookInstance' => '

Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

', 'StopPipelineExecution' => '

Stops a pipeline execution.

Callback Step

A pipeline execution won\'t stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can\'t be stopped while a lambda step is running because the Lambda function invoked by the lambda step can\'t be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

', 'StopProcessingJob' => '

Stops a processing job.

', 'StopTrainingJob' => '

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

', 'StopTransformJob' => '

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn\'t store the job\'s output in Amazon S3.

', 'UpdateAction' => '

Updates an action.

', 'UpdateAppImageConfig' => '

Updates the properties of an AppImageConfig.

', 'UpdateArtifact' => '

Updates an artifact.

', 'UpdateCluster' => '

Updates a SageMaker HyperPod cluster.

', 'UpdateClusterSoftware' => '

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

', 'UpdateCodeRepository' => '

Updates the specified Git repository with the specified values.

', 'UpdateContext' => '

Updates a context.

', 'UpdateDeviceFleet' => '

Updates a fleet of devices.

', 'UpdateDevices' => '

Updates one or more devices in a fleet.

', 'UpdateDomain' => '

Updates the default settings for new user profiles in the domain.

', 'UpdateEndpoint' => '

Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'UpdateEndpointWeightsAndCapacities' => '

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

', 'UpdateExperiment' => '

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

', 'UpdateFeatureGroup' => '

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.

', 'UpdateFeatureMetadata' => '

Updates the description and parameters of the feature group.

', 'UpdateHub' => '

Update a hub.

Hub APIs are only callable through SageMaker Studio.

', 'UpdateImage' => '

Updates the properties of a SageMaker image. To change the image\'s tags, use the AddTags and DeleteTags APIs.

', 'UpdateImageVersion' => '

Updates the properties of a SageMaker image version.

', 'UpdateInferenceComponent' => '

Updates an inference component.

', 'UpdateInferenceComponentRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceExperiment' => '

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

', 'UpdateModelCard' => '

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

', 'UpdateModelPackage' => '

Updates a versioned model.

', 'UpdateMonitoringAlert' => '

Update the parameters of a model monitor alert.

', 'UpdateMonitoringSchedule' => '

Updates a previously created schedule.

', 'UpdateNotebookInstance' => '

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

', 'UpdateNotebookInstanceLifecycleConfig' => '

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

', 'UpdatePipeline' => '

Updates a pipeline.

', 'UpdatePipelineExecution' => '

Updates a pipeline execution.

', 'UpdateProject' => '

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

', 'UpdateSpace' => '

Updates the settings of a space.

', 'UpdateTrainingJob' => '

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

', 'UpdateTrial' => '

Updates the display name of a trial.

', 'UpdateTrialComponent' => '

Updates one or more properties of a trial component.

', 'UpdateUserProfile' => '

Updates a user profile.

', 'UpdateWorkforce' => '

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn\'t restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

', 'UpdateWorkteam' => '

Updates an existing work team with new member definitions or description.

', ], 'shapes' => [ 'Accept' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$Accept' => '

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

', ], ], 'AcceptEula' => [ 'base' => NULL, 'refs' => [ 'ModelAccessConfig$AcceptEula' => '

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LabelingJobForWorkteamSummary$WorkRequesterAccountId' => '

The Amazon Web Services account ID of the account used to start the labeling job.

', 'VpcOnlyTrustedAccounts$member' => NULL, ], ], 'ActionArn' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'CreateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DeleteActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DescribeActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'UpdateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', ], ], 'ActionSource' => [ 'base' => '

A structure describing the source of an action.

', 'refs' => [ 'ActionSummary$Source' => '

The source of the action.

', 'CreateActionRequest$Source' => '

The source type, ID, and URI.

', 'DescribeActionResponse$Source' => '

The source of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$Status' => '

The status of the action.

', 'CreateActionRequest$Status' => '

The status of the action.

', 'DescribeActionResponse$Status' => '

The status of the action.

', 'UpdateActionRequest$Status' => '

The new status for the action.

', ], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListActionsResponse$ActionSummaries' => '

A list of actions and their properties.

', ], ], 'ActionSummary' => [ 'base' => '

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'AddAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'NotebookInstanceSummary$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'AdditionalInferenceSpecificationDefinition' => [ 'base' => '

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

', 'refs' => [ 'AdditionalInferenceSpecifications$member' => NULL, ], ], 'AdditionalInferenceSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'DescribeModelPackageOutput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'ModelPackage$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects.

', 'UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd' => '

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', ], ], 'AdditionalS3DataSource' => [ 'base' => '

A data source used for training or inference that is in addition to the input dataset or model data.

', 'refs' => [ 'ModelPackageContainerDefinition$AdditionalS3DataSource' => '

The additional data source that is used during inference in the Docker container for your model package.

', 'TrainingSpecification$AdditionalS3DataSource' => '

The additional data source used during the training job.

', ], ], 'AdditionalS3DataSourceDataType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3DataType' => '

The data type of the additional data source that you specify for use in inference or training.

', ], ], 'AgentVersion' => [ 'base' => '

Edge Manager agent version.

', 'refs' => [ 'AgentVersions$member' => NULL, ], ], 'AgentVersions' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$AgentVersions' => '

The versions of Edge Manager agent deployed on the fleet.

', ], ], 'AggregationTransformationValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$value' => NULL, ], ], 'AggregationTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Aggregation' => '

A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

The supported aggregation methods are sum (default), avg, first, min, max.

Aggregation is only supported for the target column.

', ], ], 'Alarm' => [ 'base' => '

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

', 'refs' => [ 'AlarmList$member' => NULL, ], ], 'AlarmList' => [ 'base' => NULL, 'refs' => [ 'AutoRollbackConfig$Alarms' => '

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

', ], ], 'AlarmName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmName' => '

The name of a CloudWatch alarm in your account.

', ], ], 'AlgorithmArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', 'CreateAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the new algorithm.

', 'DescribeAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', ], ], 'AlgorithmImage' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

', 'DebugRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

', 'HyperParameterAlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'ProfilerRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container Registry Image for the managed rule evaluation.

', ], ], 'AlgorithmSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AlgorithmSpecification' => [ 'base' => '

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'refs' => [ 'CreateTrainingJobRequest$AlgorithmSpecification' => '

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'DescribeTrainingJobResponse$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', 'TrainingJob$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', ], ], 'AlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmStatus' => '

The overall status of the algorithm.

', 'DescribeAlgorithmOutput$AlgorithmStatus' => '

The current status of the algorithm.

', ], ], 'AlgorithmStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the algorithm.

', 'refs' => [ 'DescribeAlgorithmOutput$AlgorithmStatusDetails' => '

Details about the current status of the algorithm.

', ], ], 'AlgorithmStatusItem' => [ 'base' => '

Represents the overall status of an algorithm.

', 'refs' => [ 'AlgorithmStatusItemList$member' => NULL, ], ], 'AlgorithmStatusItemList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusDetails$ValidationStatuses' => '

The status of algorithm validation.

', 'AlgorithmStatusDetails$ImageScanStatuses' => '

The status of the scan of the algorithm\'s Docker image container.

', ], ], 'AlgorithmSummary' => [ 'base' => '

Provides summary information about an algorithm.

', 'refs' => [ 'AlgorithmSummaryList$member' => NULL, ], ], 'AlgorithmSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsOutput$AlgorithmSummaryList' => '

>An array of AlgorithmSummary objects, each of which lists an algorithm.

', ], ], 'AlgorithmValidationProfile' => [ 'base' => '

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'AlgorithmValidationProfiles$member' => NULL, ], ], 'AlgorithmValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationProfiles' => '

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

', ], ], 'AlgorithmValidationSpecification' => [ 'base' => '

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

', 'refs' => [ 'CreateAlgorithmInput$ValidationSpecification' => '

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm\'s training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm\'s inference code.

', 'DescribeAlgorithmOutput$ValidationSpecification' => '

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

', ], ], 'AnnotationConsolidationConfig' => [ 'base' => '

Configures how labels are consolidated across human workers and processes output data.

', 'refs' => [ 'HumanTaskConfig$AnnotationConsolidationConfig' => '

Configures how labels are consolidated across human workers.

', ], ], 'AppArn' => [ 'base' => NULL, 'refs' => [ 'CreateAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', 'DescribeAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', ], ], 'AppDetails' => [ 'base' => '

Details about an Amazon SageMaker app.

', 'refs' => [ 'AppList$member' => NULL, ], ], 'AppImageConfigArn' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigArn' => '

The ARN of the AppImageConfig.

', 'CreateAppImageConfigResponse$AppImageConfigArn' => '

The ARN of the AppImageConfig.

', 'DescribeAppImageConfigResponse$AppImageConfigArn' => '

The ARN of the AppImageConfig.

', 'UpdateAppImageConfigResponse$AppImageConfigArn' => '

The ARN for the AppImageConfig.

', ], ], 'AppImageConfigDetails' => [ 'base' => '

The configuration for running a SageMaker image as a KernelGateway app.

', 'refs' => [ 'AppImageConfigList$member' => NULL, ], ], 'AppImageConfigList' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsResponse$AppImageConfigs' => '

A list of AppImageConfigs and their properties.

', ], ], 'AppImageConfigName' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CreateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CustomImage$AppImageConfigName' => '

The name of the AppImageConfig.

', 'DeleteAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to delete.

', 'DescribeAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to describe.

', 'DescribeAppImageConfigResponse$AppImageConfigName' => '

The name of the AppImageConfig.

', 'ListAppImageConfigsRequest$NameContains' => '

A filter that returns only AppImageConfigs whose name contains the specified string.

', 'UpdateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to update.

', ], ], 'AppImageConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'AppInstanceType' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$InstanceType' => '

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

', ], ], 'AppList' => [ 'base' => NULL, 'refs' => [ 'ListAppsResponse$Apps' => '

The list of apps.

', ], ], 'AppManaged' => [ 'base' => NULL, 'refs' => [ 'ProcessingInput$AppManaged' => '

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

', 'ProcessingOutput$AppManaged' => '

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

', ], ], 'AppName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppName' => '

The name of the app.

', 'CreateAppRequest$AppName' => '

The name of the app.

', 'DeleteAppRequest$AppName' => '

The name of the app.

', 'DescribeAppRequest$AppName' => '

The name of the app.

', 'DescribeAppResponse$AppName' => '

The name of the app.

', ], ], 'AppNetworkAccessType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

', 'DescribeDomainResponse$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

', 'UpdateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

', ], ], 'AppSecurityGroupManagement' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', 'DescribeDomainResponse$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

', 'UpdateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', ], ], 'AppSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AppSpecification' => [ 'base' => '

Configuration to run a processing job in a specified container image.

', 'refs' => [ 'CreateProcessingJobRequest$AppSpecification' => '

Configures the processing job to run a specified Docker container image.

', 'DescribeProcessingJobResponse$AppSpecification' => '

Configures the processing job to run a specified container image.

', 'ProcessingJob$AppSpecification' => NULL, ], ], 'AppStatus' => [ 'base' => NULL, 'refs' => [ 'AppDetails$Status' => '

The status.

', 'DescribeAppResponse$Status' => '

The status.

', ], ], 'AppType' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppType' => '

The type of app.

', 'CreateAppRequest$AppType' => '

The type of app.

', 'DeleteAppRequest$AppType' => '

The type of app.

', 'DescribeAppRequest$AppType' => '

The type of app.

', 'DescribeAppResponse$AppType' => '

The type of app.

', 'SpaceSettings$AppType' => '

The type of app created within the space.

', 'SpaceSettingsSummary$AppType' => '

The type of app created within the space.

', ], ], 'ApprovalDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageOutput$ApprovalDescription' => '

A description provided for the model approval.

', 'ModelPackage$ApprovalDescription' => '

A description provided when the model approval is set.

', 'UpdateModelPackageInput$ApprovalDescription' => '

A description for the approval status of the model.

', ], ], 'ArnOrName' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$AlgorithmName' => '

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can\'t specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don\'t specify any value for both parameters, the training job might raise a null error.

', 'CreateModelPackageInput$ModelPackageGroupName' => '

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

', 'DeleteModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group to delete.

', 'DescribeAlgorithmInput$AlgorithmName' => '

The name of the algorithm to describe.

', 'DescribeModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group to describe.

', 'HyperParameterAlgorithmSpecification$AlgorithmName' => '

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

', 'ListModelPackagesInput$ModelPackageGroupName' => '

A filter that returns only model versions that belong to the specified model group.

', 'SourceAlgorithm$AlgorithmName' => '

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', ], ], 'ArtifactArn' => [ 'base' => NULL, 'refs' => [ 'ArtifactSummary$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'CreateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DeleteArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to delete.

', 'DeleteArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DescribeArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to describe.

', 'DescribeArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'UpdateArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to update.

', 'UpdateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', ], ], 'ArtifactDigest' => [ 'base' => NULL, 'refs' => [ 'ModelDigests$ArtifactDigest' => '

Provides a hash value that uniquely identifies the stored model artifacts.

', ], ], 'ArtifactProperties' => [ 'base' => NULL, 'refs' => [ 'CreateArtifactRequest$Properties' => '

A list of properties to add to the artifact.

', 'UpdateArtifactRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'ArtifactPropertyValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$value' => NULL, ], ], 'ArtifactSource' => [ 'base' => '

A structure describing the source of an artifact.

', 'refs' => [ 'ArtifactSummary$Source' => '

The source of the artifact.

', 'CreateArtifactRequest$Source' => '

The ID, ID type, and URI of the source.

', 'DeleteArtifactRequest$Source' => '

The URI of the source.

', 'DescribeArtifactResponse$Source' => '

The source of the artifact.

', ], ], 'ArtifactSourceIdType' => [ 'base' => NULL, 'refs' => [ 'ArtifactSourceType$SourceIdType' => '

The type of ID.

', ], ], 'ArtifactSourceType' => [ 'base' => '

The ID and ID type of an artifact source.

', 'refs' => [ 'ArtifactSourceTypes$member' => NULL, ], ], 'ArtifactSourceTypes' => [ 'base' => NULL, 'refs' => [ 'ArtifactSource$SourceTypes' => '

A list of source types.

', ], ], 'ArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsResponse$ArtifactSummaries' => '

A list of artifacts and their properties.

', ], ], 'ArtifactSummary' => [ 'base' => '

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

', 'refs' => [ 'ArtifactSummaries$member' => NULL, ], ], 'AssemblyType' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$AssembleWith' => '

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

', ], ], 'AssociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociationEdgeType' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$AssociationType' => '

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

  • ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.

  • AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.

  • DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.

  • Produced - The source generated the destination. For example, a training job produced a model artifact.

', 'AssociationSummary$AssociationType' => '

The type of the association.

', 'Edge$AssociationType' => '

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

', 'ListAssociationsRequest$AssociationType' => '

A filter that returns only associations of the specified type.

', ], ], 'AssociationEntityArn' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$SourceArn' => '

The ARN of the source.

', 'AddAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AddAssociationResponse$SourceArn' => '

The ARN of the source.

', 'AddAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AssociationSummary$SourceArn' => '

The ARN of the source.

', 'AssociationSummary$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationRequest$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationResponse$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'Edge$SourceArn' => '

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

', 'Edge$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

', 'ListAssociationsRequest$SourceArn' => '

A filter that returns only associations with the specified source ARN.

', 'ListAssociationsRequest$DestinationArn' => '

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

', 'QueryLineageStartArns$member' => NULL, 'Vertex$Arn' => '

The Amazon Resource Name (ARN) of the lineage entity resource.

', ], ], 'AssociationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsResponse$AssociationSummaries' => '

A list of associations and their properties.

', ], ], 'AssociationSummary' => [ 'base' => '

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

', 'refs' => [ 'AssociationSummaries$member' => NULL, ], ], 'AsyncInferenceClientConfig' => [ 'base' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', 'refs' => [ 'AsyncInferenceConfig$ClientConfig' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', ], ], 'AsyncInferenceConfig' => [ 'base' => '

Specifies configuration for how an endpoint performs asynchronous inference.

', 'refs' => [ 'CreateEndpointConfigInput$AsyncInferenceConfig' => '

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

', 'DescribeEndpointConfigOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeEndpointOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', ], ], 'AsyncInferenceNotificationConfig' => [ 'base' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', 'refs' => [ 'AsyncInferenceOutputConfig$NotificationConfig' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', ], ], 'AsyncInferenceOutputConfig' => [ 'base' => '

Specifies the configuration for asynchronous inference invocation outputs.

', 'refs' => [ 'AsyncInferenceConfig$OutputConfig' => '

Specifies the configuration for asynchronous inference invocation outputs.

', ], ], 'AsyncNotificationTopicTypeList' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$IncludeInferenceResponseIn' => '

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

', ], ], 'AsyncNotificationTopicTypes' => [ 'base' => NULL, 'refs' => [ 'AsyncNotificationTopicTypeList$member' => NULL, ], ], 'AthenaCatalog' => [ 'base' => '

The name of the data catalog used in Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Catalog' => NULL, ], ], 'AthenaDatabase' => [ 'base' => '

The name of the database used in the Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Database' => NULL, ], ], 'AthenaDatasetDefinition' => [ 'base' => '

Configuration for Athena Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$AthenaDatasetDefinition' => NULL, ], ], 'AthenaQueryString' => [ 'base' => '

The SQL query statements, to be executed.

', 'refs' => [ 'AthenaDatasetDefinition$QueryString' => NULL, ], ], 'AthenaResultCompressionType' => [ 'base' => '

The compression used for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputCompression' => NULL, ], ], 'AthenaResultFormat' => [ 'base' => '

The data storage format for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputFormat' => NULL, ], ], 'AthenaWorkGroup' => [ 'base' => '

The name of the workgroup in which the Athena query is being started.

', 'refs' => [ 'AthenaDatasetDefinition$WorkGroup' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeNames$member' => NULL, ], ], 'AttributeNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$AttributeNames' => '

A list of one or more attribute names to use that are found in a specified augmented manifest file.

', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AuthMode' => '

The mode of authentication that members use to access the domain.

', 'DescribeDomainResponse$AuthMode' => '

The domain\'s authentication mode.

', ], ], 'AutoGenerateEndpointName' => [ 'base' => NULL, 'refs' => [ 'ModelDeployConfig$AutoGenerateEndpointName' => '

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

', ], ], 'AutoMLAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithms$member' => NULL, ], ], 'AutoMLAlgorithmConfig' => [ 'base' => '

The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.

', 'refs' => [ 'AutoMLAlgorithmsConfig$member' => NULL, ], ], 'AutoMLAlgorithms' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithmConfig$AutoMLAlgorithms' => '

The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.

Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

  • In ENSEMBLING mode:

    • "catboost"

    • "extra-trees"

    • "fastai"

    • "lightgbm"

    • "linear-learner"

    • "nn-torch"

    • "randomforest"

    • "xgboost"

  • In HYPERPARAMETER_TUNING mode:

    • "linear-learner"

    • "mlp"

    • "xgboost"

', ], ], 'AutoMLAlgorithmsConfig' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

  • AlgorithmsConfig should not be set in AUTO training mode.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', 'CandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train model candidates on tabular data.

The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .

  • AlgorithmsConfig should not be set in AUTO training mode.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', ], ], 'AutoMLCandidate' => [ 'base' => '

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

', 'refs' => [ 'AutoMLCandidates$member' => NULL, 'DescribeAutoMLJobResponse$BestCandidate' => '

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

', 'DescribeAutoMLJobV2Response$BestCandidate' => '

Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

', ], ], 'AutoMLCandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how a candidate is generated (optional).

', 'refs' => [ 'AutoMLJobConfig$CandidateGenerationConfig' => '

The configuration for generating a candidate for an AutoML job (optional).

', ], ], 'AutoMLCandidateStep' => [ 'base' => '

Information about the steps for a candidate and what step it is working on.

', 'refs' => [ 'CandidateSteps$member' => NULL, ], ], 'AutoMLCandidates' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobResponse$Candidates' => '

Summaries about the AutoMLCandidates.

', ], ], 'AutoMLChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.

A validation dataset must contain the same headers as the training dataset.

', 'refs' => [ 'AutoMLInputDataConfig$member' => NULL, ], ], 'AutoMLChannelType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ChannelType' => '

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.

', 'AutoMLJobChannel$ChannelType' => '

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

', ], ], 'AutoMLContainerDefinition' => [ 'base' => '

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.

', 'refs' => [ 'AutoMLContainerDefinitions$member' => NULL, ], ], 'AutoMLContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$InferenceContainers' => '

Information about the recommended inference container definitions.

', 'AutoMLInferenceContainerDefinitions$value' => '

Information about the recommended inference container definitions.

', ], ], 'AutoMLDataSource' => [ 'base' => '

The data source for the Autopilot job.

', 'refs' => [ 'AutoMLChannel$DataSource' => '

The data source for an AutoML channel.

', 'AutoMLJobChannel$DataSource' => '

The data source for an AutoML channel (Required).

', ], ], 'AutoMLDataSplitConfig' => [ 'base' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

', 'refs' => [ 'AutoMLJobConfig$DataSplitConfig' => '

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

', 'CreateAutoMLJobV2Request$DataSplitConfig' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.

', 'DescribeAutoMLJobV2Response$DataSplitConfig' => '

Returns the configuration settings of how the data are split into train and validation datasets.

', ], ], 'AutoMLFailureReason' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$FailureReason' => '

The failure reason.

', 'AutoMLJobSummary$FailureReason' => '

The failure reason of an AutoML job.

', 'AutoMLPartialFailureReason$PartialFailureMessage' => '

The message containing the reason for a partial failure of an AutoML job.

', 'DescribeAutoMLJobResponse$FailureReason' => '

Returns the failure reason for an AutoML job, when applicable.

', 'DescribeAutoMLJobV2Response$FailureReason' => '

Returns the reason for the failure of the AutoML job V2, when applicable.

', ], ], 'AutoMLInferenceContainerDefinitions' => [ 'base' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLCandidate$InferenceContainerDefinitions' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

', ], ], 'AutoMLInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$InputDataConfig' => '

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

', 'DescribeAutoMLJobResponse$InputDataConfig' => '

Returns the input data configuration for the AutoML job.

', ], ], 'AutoMLJobArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the AutoML job.

', 'AutoMLJobSummary$AutoMLJobArn' => '

The ARN of the AutoML job.

', 'CreateAutoMLJobResponse$AutoMLJobArn' => '

The unique ARN assigned to the AutoML job when it is created.

', 'CreateAutoMLJobV2Response$AutoMLJobArn' => '

The unique ARN assigned to the AutoMLJob when it is created.

', 'DescribeAutoMLJobResponse$AutoMLJobArn' => '

Returns the ARN of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobArn' => '

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

', 'DescribeProcessingJobResponse$AutoMLJobArn' => '

The ARN of an AutoML job associated with this processing job.

', 'DescribeTrainingJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of an AutoML job.

', 'DescribeTransformJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML transform job.

', 'ProcessingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

', 'TrainingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'TransformJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

', ], ], 'AutoMLJobArtifacts' => [ 'base' => '

The artifacts that are generated during an AutoML job.

', 'refs' => [ 'DescribeAutoMLJobResponse$AutoMLJobArtifacts' => '

Returns information on the job\'s artifacts found in AutoMLJobArtifacts.

', 'DescribeAutoMLJobV2Response$AutoMLJobArtifacts' => NULL, ], ], 'AutoMLJobChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLJobInputDataConfig$member' => NULL, ], ], 'AutoMLJobCompletionCriteria' => [ 'base' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'refs' => [ 'AutoMLJobConfig$CompletionCriteria' => '

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

', 'AutoMLResolvedAttributes$CompletionCriteria' => NULL, 'ImageClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'ResolvedAttributes$CompletionCriteria' => NULL, 'TabularJobConfig$CompletionCriteria' => NULL, 'TextClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'TextGenerationJobConfig$CompletionCriteria' => '

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

', 'TimeSeriesForecastingJobConfig$CompletionCriteria' => NULL, ], ], 'AutoMLJobConfig' => [ 'base' => '

A collection of settings used for an AutoML job.

', 'refs' => [ 'CreateAutoMLJobRequest$AutoMLJobConfig' => '

A collection of settings used to configure an AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobConfig' => '

Returns the configuration for the AutoML job.

', ], ], 'AutoMLJobInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLJobInputDataConfig' => '

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:

  • For tabular problem types: S3Prefix, ManifestFile.

  • For image classification: S3Prefix, ManifestFile, AugmentedManifestFile.

  • For text classification: S3Prefix.

  • For time-series forecasting: S3Prefix.

  • For text generation (LLMs fine-tuning): S3Prefix.

', 'DescribeAutoMLJobV2Response$AutoMLJobInputDataConfig' => '

Returns an array of channel objects describing the input data and their location.

', ], ], 'AutoMLJobName' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobName' => '

The name of the AutoML job you are requesting.

', 'CreateAutoMLJobRequest$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'CreateAutoMLJobV2Request$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'DescribeAutoMLJobRequest$AutoMLJobName' => '

Requests information about an AutoML job using its unique name.

', 'DescribeAutoMLJobResponse$AutoMLJobName' => '

Returns the name of the AutoML job.

', 'DescribeAutoMLJobV2Request$AutoMLJobName' => '

Requests information about an AutoML job V2 using its unique name.

', 'DescribeAutoMLJobV2Response$AutoMLJobName' => '

Returns the name of the AutoML job V2.

', 'ListCandidatesForAutoMLJobRequest$AutoMLJobName' => '

List the candidates created for the job by providing the job\'s name.

', 'StopAutoMLJobRequest$AutoMLJobName' => '

The name of the object you are requesting.

', ], ], 'AutoMLJobObjective' => [ 'base' => '

Specifies a metric to minimize or maximize as the objective of an AutoML job.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLJobObjective' => NULL, 'CreateAutoMLJobRequest$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

', 'CreateAutoMLJobV2Request$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.

  • For tabular problem types: You must either provide both the AutoMLJobObjective and indicate the type of supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or none at all.

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

', 'DescribeAutoMLJobResponse$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'DescribeAutoMLJobV2Response$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'ResolvedAttributes$AutoMLJobObjective' => NULL, ], ], 'AutoMLJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Type' => '

The type of metric with the best result.

', ], ], 'AutoMLJobSecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobSecondaryStatus' => '

The secondary status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job V2.

', ], ], 'AutoMLJobStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobStatus' => '

The status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobStatus' => '

Returns the status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobStatus' => '

Returns the status of the AutoML job V2.

', 'ListAutoMLJobsRequest$StatusEquals' => '

Request a list of jobs, using a filter for status.

', ], ], 'AutoMLJobStepMetadata' => [ 'base' => '

Metadata for an AutoML job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$AutoMLJob' => '

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

', ], ], 'AutoMLJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsResponse$AutoMLJobSummaries' => '

Returns a summary list of jobs.

', ], ], 'AutoMLJobSummary' => [ 'base' => '

Provides a summary about an AutoML job.

', 'refs' => [ 'AutoMLJobSummaries$member' => NULL, ], ], 'AutoMLMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$MaxResults' => '

Request a list of jobs up to a specified limit.

', ], ], 'AutoMLMaxResultsForTrials' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$MaxResults' => '

List the job\'s candidates up to a specified limit.

', ], ], 'AutoMLMetricEnum' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobObjective$MetricName' => '

The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model\'s parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.

The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.

  • For tabular problem types:

    • List of available metrics:

      • Regression: MAE, MSE, R2, RMSE

      • Binary classification: Accuracy, AUC, BalancedAccuracy, F1, Precision, Recall

      • Multiclass classification: Accuracy, BalancedAccuracy, F1macro, PrecisionMacro, RecallMacro

      For a description of each metric, see Autopilot metrics for classification and regression.

    • Default objective metrics:

      • Regression: MSE.

      • Binary classification: F1.

      • Multiclass classification: Accuracy.

  • For image or text classification problem types:

  • For time-series forecasting problem types:

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

', 'FinalAutoMLJobObjectiveMetric$MetricName' => '

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

', 'FinalAutoMLJobObjectiveMetric$StandardMetricName' => '

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

', 'MetricDatum$MetricName' => '

The name of the metric.

', ], ], 'AutoMLMetricExtendedEnum' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$StandardMetricName' => '

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

', ], ], 'AutoMLMode' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', 'TabularJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', ], ], 'AutoMLNameContains' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$NameContains' => '

Request a list of jobs, using a search filter for name.

', ], ], 'AutoMLOutputDataConfig' => [ 'base' => '

The output data configuration.

', 'refs' => [ 'CreateAutoMLJobRequest$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

', 'CreateAutoMLJobV2Request$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

', 'DescribeAutoMLJobResponse$OutputDataConfig' => '

Returns the job\'s output data config.

', 'DescribeAutoMLJobV2Response$OutputDataConfig' => '

Returns the job\'s output data config.

', ], ], 'AutoMLPartialFailureReason' => [ 'base' => '

The reason for a partial failure of an AutoML job.

', 'refs' => [ 'AutoMLPartialFailureReasons$member' => NULL, ], ], 'AutoMLPartialFailureReasons' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$PartialFailureReasons' => '

The list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobResponse$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobV2Response$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job V2.

', ], ], 'AutoMLProblemTypeConfig' => [ 'base' => '

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

', 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLProblemTypeConfig' => '

Defines the configuration settings of one of the supported problem types.

', 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig' => '

Returns the configuration settings of the problem type set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeConfigName' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName' => '

Returns the name of the problem type configuration set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'base' => '

Stores resolved attributes specific to the problem type of an AutoML job V2.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes' => '

Defines the resolved attributes specific to a problem type.

', ], ], 'AutoMLProcessingUnit' => [ 'base' => NULL, 'refs' => [ 'AutoMLInferenceContainerDefinitions$key' => '

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.

', ], ], 'AutoMLResolvedAttributes' => [ 'base' => '

The resolved attributes used to configure an AutoML job V2.

', 'refs' => [ 'DescribeAutoMLJobV2Response$ResolvedAttributes' => '

Returns the resolved attributes used by the AutoML job V2.

', ], ], 'AutoMLS3DataSource' => [ 'base' => '

Describes the Amazon S3 data source.

', 'refs' => [ 'AutoMLDataSource$S3DataSource' => '

The Amazon S3 location of the input data.

', ], ], 'AutoMLS3DataType' => [ 'base' => NULL, 'refs' => [ 'AutoMLS3DataSource$S3DataType' => '

The data type.

  • If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

    The S3Prefix should have the following format:

    s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE

  • If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

    A ManifestFile should have the format shown below:

    [ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},

    "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1",

    "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",

    ... "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ]

  • If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).

    Here is a minimal, single-record example of an AugmentedManifestFile:

    {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",

    "label-metadata": {"class-name": "cat" }

    For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.

', ], ], 'AutoMLSecurityConfig' => [ 'base' => '

Security options.

', 'refs' => [ 'AutoMLJobConfig$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'CreateAutoMLJobV2Request$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'DescribeAutoMLJobV2Response$SecurityConfig' => '

Returns the security configuration for traffic encryption or Amazon VPC settings.

', ], ], 'AutoMLSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortBy' => '

The parameter by which to sort the results. The default is Name.

', ], ], 'AutoMLSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortOrder' => '

The sort order for the results. The default is Descending.

', 'ListCandidatesForAutoMLJobRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', ], ], 'AutoParameter' => [ 'base' => '

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

', 'refs' => [ 'AutoParameters$member' => NULL, ], ], 'AutoParameters' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$AutoParameters' => '

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

', ], ], 'AutoRollbackConfig' => [ 'base' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', 'refs' => [ 'DeploymentConfig$AutoRollbackConfiguration' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', ], ], 'Autotune' => [ 'base' => '

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$Autotune' => '

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

', 'DescribeHyperParameterTuningJobResponse$Autotune' => '

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

', ], ], 'AutotuneMode' => [ 'base' => NULL, 'refs' => [ 'Autotune$Mode' => '

Set Mode to Enabled if you want to use Autotune.

', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'base' => NULL, 'refs' => [ 'HumanLoopRequestSource$AwsManagedHumanLoopRequestSource' => '

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

', ], ], 'BacktestResultsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$BacktestResults' => '

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

', ], ], 'BaseModelName' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$BaseModelName' => '

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

', 'TextGenerationResolvedAttributes$BaseModelName' => '

The name of the base model to fine-tune.

', ], ], 'BatchDataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data for batch transform jobs.

', 'refs' => [ 'CreateTransformJobRequest$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'DescribeTransformJobResponse$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'TransformJob$DataCaptureConfig' => NULL, ], ], 'BatchDescribeModelPackageError' => [ 'base' => '

The error code and error description associated with the resource.

', 'refs' => [ 'BatchDescribeModelPackageErrorMap$value' => NULL, ], ], 'BatchDescribeModelPackageErrorMap' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap' => '

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

', ], ], 'BatchDescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageSummary' => [ 'base' => '

Provides summary information about the model package.

', 'refs' => [ 'ModelPackageSummaries$value' => NULL, ], ], 'BatchStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

', 'DescribeTransformJobResponse$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

', 'TransformJob$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

', 'TransformJobDefinition$BatchStrategy' => '

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

', ], ], 'BatchTransformInput' => [ 'base' => '

Input object for the batch transform job.

', 'refs' => [ 'DataQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelBiasJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelDashboardMonitoringSchedule$BatchTransformInput' => NULL, 'ModelExplainabilityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'MonitoringInput$BatchTransformInput' => '

Input object for the batch transform job.

', ], ], 'BestObjectiveNotImproving' => [ 'base' => '

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

', 'refs' => [ 'TuningJobCompletionCriteria$BestObjectiveNotImproving' => '

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

', ], ], 'Bias' => [ 'base' => '

Contains bias metrics for a model.

', 'refs' => [ 'ModelMetrics$Bias' => '

Metrics that measure bias in a model.

', ], ], 'BillableTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$BillableTimeInSeconds' => '

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

', 'TrainingJob$BillableTimeInSeconds' => '

The billable time in seconds.

', ], ], 'BlockedReason' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreStatus$BlockedReason' => '

The justification for why the OfflineStoreStatus is Blocked (if applicable).

', ], ], 'BlueGreenUpdatePolicy' => [ 'base' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', 'refs' => [ 'DeploymentConfig$BlueGreenUpdatePolicy' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$EnableSageMakerMetricsTimeSeries' => '

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren\'t generated except in the following cases:

', 'AutoMLSecurityConfig$EnableInterContainerTrafficEncryption' => '

Whether to use traffic encryption between the container layers.

', 'BatchDataCaptureConfig$GenerateInferenceId' => '

Flag that indicates whether to append inference id to the output.

', 'ChannelSpecification$IsRequired' => '

Indicates whether the channel is required by the algorithm.

', 'ClarifyCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'ClarifyCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

', 'CreateEndpointConfigInput$EnableNetworkIsolation' => '

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'CreateModelInput$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'CreateTrainingJobRequest$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'CreateTrainingJobRequest$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

', 'CreateTrainingJobRequest$EnableManagedSpotTraining' => '

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

', 'DescribeEndpointConfigOutput$EnableNetworkIsolation' => '

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'DescribeModelOutput$EnableNetworkIsolation' => '

If True, no inbound or outbound network calls can be made to or from the model container.

', 'DescribeTrainingJobResponse$EnableNetworkIsolation' => '

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'DescribeTrainingJobResponse$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

', 'DescribeTrainingJobResponse$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'HyperParameterSpecification$IsTunable' => '

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

', 'HyperParameterSpecification$IsRequired' => '

Indicates whether this hyperparameter is required.

', 'HyperParameterTrainingJobDefinition$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'HyperParameterTrainingJobDefinition$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'ListStageDevicesRequest$ExcludeDevicesDeployedInOtherStage' => '

Toggle for excluding devices deployed in other stages.

', 'Model$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'ModelDashboardIndicatorAction$Enabled' => '

Indicates whether the alert action is turned on.

', 'MonitoringCsvDatasetFormat$Header' => '

Indicates if the CSV data has a header.

', 'MonitoringJsonDatasetFormat$Line' => '

Indicates if the file should be read as a JSON object per line.

', 'MonitoringNetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

', 'MonitoringNetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

', 'NetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

', 'NetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

', 'OfflineStoreConfig$DisableGlueTableCreation' => '

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena\'s naming recommendations.

The default value is False.

', 'OnlineStoreConfig$EnableOnlineStore' => '

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

', 'QualityCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'QualityCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

', 'QueryLineageRequest$IncludeEdges' => '

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

', 'TrainingJob$EnableNetworkIsolation' => '

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can\'t communicate beyond the VPC they run in.

', 'TrainingJob$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'TrainingJob$EnableManagedSpotTraining' => '

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

', 'TrainingSpecification$SupportsDistributedTraining' => '

Indicates whether the algorithm supports distributed training. If set to false, buyers can\'t request more than one instance during training.

', 'UpdateEndpointInput$RetainAllVariantProperties' => '

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

', 'UpdateEndpointInput$RetainDeploymentConfig' => '

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

', ], ], 'BooleanOperator' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$Operator' => '

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

', ], ], 'Branch' => [ 'base' => NULL, 'refs' => [ 'GitConfig$Branch' => '

The default branch for the Git repository.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$Bucket' => '

Name of the S3 bucket.

', ], ], 'CacheHitResult' => [ 'base' => '

Details on the cache hit of a pipeline execution step.

', 'refs' => [ 'PipelineExecutionStep$CacheHitResult' => '

If this pipeline execution step was cached, details on the cache hit.

', ], ], 'CallbackStepMetadata' => [ 'base' => '

Metadata about a callback step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Callback' => '

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepFailureRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepSuccessRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', ], ], 'CandidateArtifactLocations' => [ 'base' => '

The location of artifacts for an AutoML candidate job.

', 'refs' => [ 'CandidateProperties$CandidateArtifactLocations' => '

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

', ], ], 'CandidateDefinitionNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$CandidateDefinitionNotebookLocation' => '

The URL of the notebook location.

', ], ], 'CandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how model candidates are generated using an AutoML job V2.

', 'refs' => [ 'TabularJobConfig$CandidateGenerationConfig' => '

The configuration information of how model candidates are generated.

', ], ], 'CandidateName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateName' => '

The name of the candidate.

', 'ListCandidatesForAutoMLJobRequest$CandidateNameEquals' => '

List the candidates for the job and filter by candidate name.

', ], ], 'CandidateProperties' => [ 'base' => '

The properties of an AutoML candidate job.

', 'refs' => [ 'AutoMLCandidate$CandidateProperties' => '

The properties of an AutoML candidate job.

', ], ], 'CandidateSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$SortBy' => '

The parameter by which to sort the results. The default is Descending.

', ], ], 'CandidateStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateStatus' => '

The candidate\'s status.

', 'ListCandidatesForAutoMLJobRequest$StatusEquals' => '

List the candidates for the job and filter by status.

', ], ], 'CandidateStepArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepArn' => '

The ARN for the candidate\'s step.

', ], ], 'CandidateStepName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepName' => '

The name for the candidate\'s step.

', ], ], 'CandidateStepType' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepType' => '

Whether the candidate is at the transform, training, or processing step.

', ], ], 'CandidateSteps' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateSteps' => '

Information about the candidate\'s steps.

', ], ], 'CanvasAppSettings' => [ 'base' => '

The SageMaker Canvas application settings.

', 'refs' => [ 'UserSettings$CanvasAppSettings' => '

The Canvas app settings.

', ], ], 'CapacitySize' => [ 'base' => '

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don\'t specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

', 'refs' => [ 'RollingUpdatePolicy$MaximumBatchSize' => '

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant\'s total instance count.

', 'RollingUpdatePolicy$RollbackMaximumBatchSize' => '

Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

', 'TrafficRoutingConfig$CanarySize' => '

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant\'s total instance count.

', 'TrafficRoutingConfig$LinearStepSize' => '

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant\'s total instance count.

', ], ], 'CapacitySizeType' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Type' => '

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.

  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

', ], ], 'CapacitySizeValue' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Value' => '

Defines the capacity size, either as a number of instances or a capacity percentage.

', ], ], 'CapacityUnit' => [ 'base' => NULL, 'refs' => [ 'ThroughputConfig$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfig$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigDescription$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigDescription$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigUpdate$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

', 'ThroughputConfigUpdate$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

', ], ], 'CaptureContentTypeHeader' => [ 'base' => '

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.

', 'refs' => [ 'DataCaptureConfig$CaptureContentTypeHeader' => '

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

', 'InferenceExperimentDataStorageConfig$ContentType' => NULL, ], ], 'CaptureMode' => [ 'base' => NULL, 'refs' => [ 'CaptureOption$CaptureMode' => '

Specify the boundary of data to capture.

', ], ], 'CaptureOption' => [ 'base' => '

Specifies data Model Monitor will capture.

', 'refs' => [ 'CaptureOptionList$member' => NULL, ], ], 'CaptureOptionList' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$CaptureOptions' => '

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

', ], ], 'CaptureStatus' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfigSummary$CaptureStatus' => '

Whether data capture is currently functional.

', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Catalog' => '

The name of the Glue table catalog.

', ], ], 'CategoricalParameter' => [ 'base' => '

Environment parameters you want to benchmark your load test against.

', 'refs' => [ 'CategoricalParameters$member' => NULL, ], ], 'CategoricalParameterRange' => [ 'base' => '

A list of categorical hyperparameters to tune.

', 'refs' => [ 'CategoricalParameterRanges$member' => NULL, ], ], 'CategoricalParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a categorical hyperparameter.

', 'refs' => [ 'ParameterRange$CategoricalParameterRangeSpecification' => '

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

', ], ], 'CategoricalParameterRangeValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameter$Value' => '

The list of values you can pass.

', ], ], 'CategoricalParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$CategoricalParameterRanges' => '

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

', ], ], 'CategoricalParameters' => [ 'base' => NULL, 'refs' => [ 'EnvironmentParameterRanges$CategoricalParameterRanges' => '

Specified a list of parameters for each category.

', ], ], 'Cents' => [ 'base' => NULL, 'refs' => [ 'USD$Cents' => '

The fractional portion, in cents, of the amount.

', ], ], 'CertifyForMarketplace' => [ 'base' => NULL, 'refs' => [ 'CreateAlgorithmInput$CertifyForMarketplace' => '

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

', 'CreateModelPackageInput$CertifyForMarketplace' => '

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

', 'DescribeAlgorithmOutput$CertifyForMarketplace' => '

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

', 'DescribeModelPackageOutput$CertifyForMarketplace' => '

Whether the model package is certified for listing on Amazon Web Services Marketplace.

', 'ModelPackage$CertifyForMarketplace' => '

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

', ], ], 'Channel' => [ 'base' => '

A channel is a named input source that training algorithms can consume.

', 'refs' => [ 'InputDataConfig$member' => NULL, ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$ChannelName' => '

The name of the channel.

', 'ChannelSpecification$Name' => '

The name of the channel.

', ], ], 'ChannelSpecification' => [ 'base' => '

Defines a named input source, called a channel, to be used by an algorithm.

', 'refs' => [ 'ChannelSpecifications$member' => NULL, ], ], 'ChannelSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$TrainingChannels' => '

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

', ], ], 'CheckpointConfig' => [ 'base' => '

Contains information about the output location for managed spot training checkpoint data.

', 'refs' => [ 'CreateTrainingJobRequest$CheckpointConfig' => '

Contains information about the output location for managed spot training checkpoint data.

', 'DescribeTrainingJobResponse$CheckpointConfig' => NULL, 'HyperParameterTrainingJobDefinition$CheckpointConfig' => NULL, 'TrainingJob$CheckpointConfig' => NULL, ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'Cidrs$member' => NULL, ], ], 'Cidrs' => [ 'base' => NULL, 'refs' => [ 'SourceIpConfig$Cidrs' => '

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

', ], ], 'ClarifyCheckStepMetadata' => [ 'base' => '

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$ClarifyCheck' => '

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'ClarifyContentTemplate' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ContentTemplate' => '

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string \'{"myfeatures":$features}\' will format a list of features [1,2,3] into the record string \'{"myfeatures":[1,2,3]}\'. Required only when the model container input is in JSON Lines format.

', ], ], 'ClarifyEnableExplanations' => [ 'base' => NULL, 'refs' => [ 'ClarifyExplainerConfig$EnableExplanations' => '

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

', ], ], 'ClarifyExplainerConfig' => [ 'base' => '

The configuration parameters for the SageMaker Clarify explainer.

', 'refs' => [ 'ExplainerConfig$ClarifyExplainerConfig' => '

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

', ], ], 'ClarifyFeatureHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureHeaders' => '

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeatureType' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureTypes$member' => NULL, ], ], 'ClarifyFeatureTypes' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureTypes' => '

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one \'text\' string (for example, [\'text\']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeaturesAttribute' => '

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression \'myfeatures\', it extracts a list of features [1,2,3] from request data \'{"myfeatures":[1,2,3]}\'.

', ], ], 'ClarifyHeader' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureHeaders$member' => NULL, 'ClarifyLabelHeaders$member' => NULL, ], ], 'ClarifyInferenceConfig' => [ 'base' => '

The inference configuration parameter for the model container.

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

The inference configuration parameter for the model container.

', ], ], 'ClarifyLabelAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelAttribute' => '

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is \'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}\', then set LabelAttribute to \'labels\' to extract the list of label headers ["cat","dog","fish"]

', ], ], 'ClarifyLabelHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelHeaders' => '

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

', ], ], 'ClarifyLabelIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelIndex' => '

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set LabelIndex to 0 to select the label headers [\'cat\',\'dog\',\'fish\'].

', ], ], 'ClarifyMaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxPayloadInMB' => '

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

', ], ], 'ClarifyMaxRecordCount' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxRecordCount' => '

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container\'s capacity at runtime.

', ], ], 'ClarifyMimeType' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$MimeType' => '

The MIME type of the baseline data. Choose from \'text/csv\' or \'application/jsonlines\'. Defaults to \'text/csv\'.

', ], ], 'ClarifyProbabilityAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityAttribute' => '

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is \'{"predicted_label":1,"probability":0.6}\', then set ProbabilityAttribute to \'probability\'.

', ], ], 'ClarifyProbabilityIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityIndex' => '

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: \'1,0.6\', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

', ], ], 'ClarifyShapBaseline' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$ShapBaseline' => '

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

', ], ], 'ClarifyShapBaselineConfig' => [ 'base' => '

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

', 'refs' => [ 'ClarifyShapConfig$ShapBaselineConfig' => '

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

', ], ], 'ClarifyShapConfig' => [ 'base' => '

The configuration for SHAP analysis using SageMaker Clarify Explainer.

', 'refs' => [ 'ClarifyExplainerConfig$ShapConfig' => '

The configuration for SHAP analysis.

', ], ], 'ClarifyShapNumberOfSamples' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$NumberOfSamples' => '

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

', ], ], 'ClarifyShapSeed' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$Seed' => '

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

', ], ], 'ClarifyShapUseLogit' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$UseLogit' => '

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

', ], ], 'ClarifyTextConfig' => [ 'base' => '

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

', 'refs' => [ 'ClarifyShapConfig$TextConfig' => '

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

', ], ], 'ClarifyTextGranularity' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Granularity' => '

The unit of granularity for the analysis of text features. For example, if the unit is \'token\', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

', ], ], 'ClarifyTextLanguage' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Language' => '

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code \'xx\'.

', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$ClientId' => '

The client ID for your Amazon Cognito user pool.

', 'CognitoMemberDefinition$ClientId' => '

An identifier for an application client. You must create the app client ID using Amazon Cognito.

', 'OidcConfig$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', 'OidcConfigForResponse$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$ClientSecret' => '

The OIDC IdP client secret used to configure your private workforce.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ClientToken' => '

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

', 'CreateModelPackageInput$ClientToken' => '

A unique token that guarantees that the call to this API is idempotent.

', ], ], 'ClusterArn' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'CreateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the cluster.

', 'DeleteClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'UpdateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

', 'UpdateClusterSoftwareResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

', ], ], 'ClusterInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$TargetCount' => '

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceCount' => '

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupDetails' => [ 'base' => '

Details of an instance group in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetailsList$member' => NULL, ], ], 'ClusterInstanceGroupDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterResponse$InstanceGroups' => '

The instance groups of the SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceGroupName' => '

The name of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceGroupName' => '

Specifies the name of the instance group.

', 'ClusterNodeDetails$InstanceGroupName' => '

The instance group name in which the instance is.

', 'ClusterNodeSummary$InstanceGroupName' => '

The name of the instance group in which the instance is.

', 'ListClusterNodesRequest$InstanceGroupNameContains' => '

A filter that returns the instance groups whose name contain a specified string.

', ], ], 'ClusterInstanceGroupSpecification' => [ 'base' => '

The specifications of an instance group that you need to define.

', 'refs' => [ 'ClusterInstanceGroupSpecifications$member' => NULL, ], ], 'ClusterInstanceGroupSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$InstanceGroups' => '

The instance groups to be created in the SageMaker HyperPod cluster.

', 'UpdateClusterRequest$InstanceGroups' => '

Specify the instance groups to update.

', ], ], 'ClusterInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceStatusDetails$Status' => '

The status of an instance in a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceStatusDetails' => [ 'base' => '

Details of an instance in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeDetails$InstanceStatus' => '

The status of the instance.

', 'ClusterNodeSummary$InstanceStatus' => '

The status of the instance.

', ], ], 'ClusterInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceType' => '

The instance type of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceType' => '

Specifies the instance type of the instance group.

', 'ClusterNodeDetails$InstanceType' => '

The type of the instance.

', 'ClusterNodeSummary$InstanceType' => '

The type of the instance.

', ], ], 'ClusterLifeCycleConfig' => [ 'base' => '

The lifecycle configuration for a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetails$LifeCycleConfig' => '

Details of LifeCycle configuration for the instance group.

', 'ClusterInstanceGroupSpecification$LifeCycleConfig' => '

Specifies the LifeCycle configuration for the instance group.

', 'ClusterNodeDetails$LifeCycleConfig' => '

The LifeCycle configuration applied to the instance.

', ], ], 'ClusterLifeCycleConfigFileName' => [ 'base' => NULL, 'refs' => [ 'ClusterLifeCycleConfig$OnCreate' => '

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.

', ], ], 'ClusterName' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', 'CreateClusterRequest$ClusterName' => '

The name for the new SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', ], ], 'ClusterNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterNodeRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

', 'DescribeClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'ListClusterNodesRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

', 'UpdateClusterRequest$ClusterName' => '

Specify the name of the SageMaker HyperPod cluster you want to update.

', 'UpdateClusterSoftwareRequest$ClusterName' => '

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

', ], ], 'ClusterNodeDetails' => [ 'base' => '

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

', 'refs' => [ 'DescribeClusterNodeResponse$NodeDetails' => '

The details of the instance.

', ], ], 'ClusterNodeId' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterNodeRequest$NodeId' => '

The ID of the instance.

', ], ], 'ClusterNodeSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesResponse$ClusterNodeSummaries' => '

The summaries of listed instances in a SageMaker HyperPod cluster

', ], ], 'ClusterNodeSummary' => [ 'base' => '

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeSummaries$member' => NULL, ], ], 'ClusterNonNegativeInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$CurrentCount' => '

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterSortBy' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', 'ListClustersRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', ], ], 'ClusterStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', ], ], 'ClusterSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClustersResponse$ClusterSummaries' => '

The summaries of listed SageMaker HyperPod clusters.

', ], ], 'ClusterSummary' => [ 'base' => '

Lists a summary of the properties of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterSummaries$member' => NULL, ], ], 'ClusterThreadsPerCore' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$ThreadsPerCore' => '

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterInstanceGroupSpecification$ThreadsPerCore' => '

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn\'t support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterNodeDetails$ThreadsPerCore' => '

The number of threads per CPU core you specified under CreateCluster.

', ], ], 'CodeEditorAppImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. The FileSystemConfig object is not supported.

', 'refs' => [ 'AppImageConfigDetails$CodeEditorAppImageConfig' => '

The configuration for the file system and the runtime, such as the environment variables and entry point.

', 'CreateAppImageConfigRequest$CodeEditorAppImageConfig' => '

The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor.

', 'DescribeAppImageConfigResponse$CodeEditorAppImageConfig' => '

The configuration of the Code Editor app.

', 'UpdateAppImageConfigRequest$CodeEditorAppImageConfig' => '

The Code Editor app running on the image.

', ], ], 'CodeEditorAppSettings' => [ 'base' => '

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

', 'refs' => [ 'UserSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'CodeRepositories' => [ 'base' => NULL, 'refs' => [ 'JupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', 'JupyterServerAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'SpaceJupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', ], ], 'CodeRepository' => [ 'base' => '

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'refs' => [ 'CodeRepositories$member' => NULL, ], ], 'CodeRepositoryArn' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'CreateCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the new repository.

', 'DescribeCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'UpdateCodeRepositoryOutput$CodeRepositoryArn' => '

The ARN of the Git repository.

', ], ], 'CodeRepositoryContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$DefaultCodeRepositoryContains' => '

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

', ], ], 'CodeRepositoryNameContains' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$NameContains' => '

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

', ], ], 'CodeRepositoryNameOrUrl' => [ 'base' => NULL, 'refs' => [ 'AdditionalCodeRepositoryNamesOrUrls$member' => NULL, 'CreateNotebookInstanceInput$DefaultCodeRepository' => '

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'ListNotebookInstancesInput$AdditionalCodeRepositoryEquals' => '

A filter that returns only notebook instances with associated with the specified git repository.

', 'NotebookInstanceSummary$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$DefaultCodeRepository' => '

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'CodeRepositorySortBy' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'CodeRepositorySortOrder' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'CodeRepositorySummary' => [ 'base' => '

Specifies summary information about a Git repository.

', 'refs' => [ 'CodeRepositorySummaryList$member' => NULL, ], ], 'CodeRepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesOutput$CodeRepositorySummaryList' => '

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

  • Name

  • Amazon Resource Name (ARN)

  • Creation time

  • Last modified time

  • Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'CognitoConfig' => [ 'base' => '

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', 'refs' => [ 'CreateWorkforceRequest$CognitoConfig' => '

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

', 'Workforce$CognitoConfig' => '

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', ], ], 'CognitoMemberDefinition' => [ 'base' => '

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

', 'refs' => [ 'MemberDefinition$CognitoMemberDefinition' => '

The Amazon Cognito user group that is part of the work team.

', ], ], 'CognitoUserGroup' => [ 'base' => NULL, 'refs' => [ 'CognitoMemberDefinition$UserGroup' => '

An identifier for a user group.

', ], ], 'CognitoUserPool' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$UserPool' => '

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

', 'CognitoMemberDefinition$UserPool' => '

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

', ], ], 'CollectionConfig' => [ 'base' => '

Configuration for your collection.

', 'refs' => [ 'FeatureDefinition$CollectionConfig' => '

Configuration for your collection.

', ], ], 'CollectionConfiguration' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger output tensor collections.

', 'refs' => [ 'CollectionConfigurations$member' => NULL, ], ], 'CollectionConfigurations' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$CollectionConfigurations' => '

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'CollectionName' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionName' => '

The name of the tensor collection. The name must be unique relative to other rule configuration names.

', ], ], 'CollectionParameters' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionParameters' => '

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

', ], ], 'CollectionType' => [ 'base' => NULL, 'refs' => [ 'FeatureDefinition$CollectionType' => '

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

', ], ], 'CompilationJobArn' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', 'CreateCompilationJobResponse$CompilationJobArn' => '

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

', 'DescribeCompilationJobResponse$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', ], ], 'CompilationJobStatus' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobStatus' => '

The status of the model compilation job.

', 'DescribeCompilationJobResponse$CompilationJobStatus' => '

The status of the model compilation job.

', 'ListCompilationJobsRequest$StatusEquals' => '

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

', ], ], 'CompilationJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsResponse$CompilationJobSummaries' => '

An array of CompilationJobSummary objects, each describing a model compilation job.

', ], ], 'CompilationJobSummary' => [ 'base' => '

A summary of a model compilation job.

', 'refs' => [ 'CompilationJobSummaries$member' => NULL, ], ], 'CompilerOptions' => [ 'base' => NULL, 'refs' => [ 'OutputConfig$CompilerOptions' => '

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model\'s input. "float32" is used if "DTYPE" is not specified. Options for data type are:

    • float32: Use either "float" or "float32".

    • int64: Use either "int64" or "long".

    For example, {"dtype" : "float32"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {\'mcpu\': \'skylake-avx512\'}

    • mattr: CPU flags. For example, {\'mattr\': [\'+neon\', \'+vfpv4\']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {\'mattr\': [\'+neon\']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.

    • trt-ver: Specifies the TensorRT versions in x.y.z. format.

    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {\'gpu-code\': \'sm_72\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.1\'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {\'ANDROID_PLATFORM\': 28}.

    • mattr: Add {\'mattr\': [\'+neon\']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\\"--verbose 1 --num-neuroncores 2 -O2\\"".

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

  • CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by newlines.

  • EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:

    • precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".

    • signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow\'s default signature def key.

    • output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

    For example: {"precision_mode": "FP32", "output_names": ["output:0"]}

', ], ], 'CompleteOnConvergence' => [ 'base' => NULL, 'refs' => [ 'ConvergenceDetected$CompleteOnConvergence' => '

A flag to stop a tuning job once AMT has detected that the job has converged.

', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$CompressionType' => '

The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.

', 'AutoMLChannel$CompressionType' => '

You can use Gzip or None. The default value is None.

', 'AutoMLJobChannel$CompressionType' => '

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

', 'Channel$CompressionType' => '

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

', 'CompressionTypes$member' => NULL, 'TransformInput$CompressionType' => '

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

', ], ], 'CompressionTypes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedCompressionTypes' => '

The allowed compression types, if data compression is used.

', ], ], 'ConditionOutcome' => [ 'base' => NULL, 'refs' => [ 'ConditionStepMetadata$Outcome' => '

The outcome of the Condition step evaluation.

', ], ], 'ConditionStepMetadata' => [ 'base' => '

Metadata for a Condition step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Condition' => '

The outcome of the condition evaluation that was run by this step execution.

', ], ], 'ConfigKey' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$key' => NULL, 'HookParameters$key' => NULL, 'ProfilingParameters$key' => NULL, 'RuleParameters$key' => NULL, ], ], 'ConfigValue' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$value' => NULL, 'HookParameters$value' => NULL, 'ProfilingParameters$value' => NULL, 'RuleParameters$value' => NULL, ], ], 'ConflictException' => [ 'base' => '

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

', 'refs' => [], ], 'ContainerArgument' => [ 'base' => NULL, 'refs' => [ 'ContainerArguments$member' => NULL, 'MonitoringContainerArguments$member' => NULL, ], ], 'ContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerArguments' => '

The arguments for a container used to run a processing job.

', ], ], 'ContainerConfig' => [ 'base' => '

The configuration used to run the application image container.

', 'refs' => [ 'CodeEditorAppImageConfig$ContainerConfig' => NULL, 'JupyterLabAppImageConfig$ContainerConfig' => NULL, ], ], 'ContainerDefinition' => [ 'base' => '

Describes the container, as part of model definition.

', 'refs' => [ 'ContainerDefinitionList$member' => NULL, 'CreateModelInput$PrimaryContainer' => '

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

', 'DescribeModelOutput$PrimaryContainer' => '

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

', 'Model$PrimaryContainer' => NULL, ], ], 'ContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$Containers' => '

Specifies the containers in the inference pipeline.

', 'DescribeModelOutput$Containers' => '

The containers in the inference pipeline.

', 'Model$Containers' => '

The containers in the inference pipeline.

', ], ], 'ContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a processing job.

', 'DataQualityAppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a monitoring job.

', 'ModelQualityAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container that the monitoring job runs.

', 'MonitoringAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container used to run the monitoring job.

', ], ], 'ContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'ContainerEntrypoint$member' => NULL, ], ], 'ContainerHostname' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ContainerHostname' => '

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don\'t specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

', 'ModelPackageContainerDefinition$ContainerHostname' => '

The DNS host name for the Docker container.

', ], ], 'ContainerImage' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Image' => '

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', 'DeployedImage$SpecifiedImage' => '

The image path you specified when you created the model.

', 'DeployedImage$ResolvedImage' => '

The specific digest path of the image hosted in this ProductionVariant.

', 'InferenceComponentContainerSpecification$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

', 'ModelPackageContainerDefinition$Image' => '

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'TrainingSpecification$TrainingImage' => '

The Amazon ECR registry path of the Docker image that contains the training algorithm.

', ], ], 'ContainerMode' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$Mode' => '

Whether the container hosts a single model or multiple models.

', ], ], 'ContentClassifier' => [ 'base' => NULL, 'refs' => [ 'ContentClassifiers$member' => NULL, ], ], 'ContentClassifiers' => [ 'base' => NULL, 'refs' => [ 'LabelingJobDataAttributes$ContentClassifiers' => '

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

', ], ], 'ContentColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$ContentColumn' => '

The name of the column used to provide the sentences to be classified. It should not be the same as the target column.

', ], ], 'ContentDigest' => [ 'base' => NULL, 'refs' => [ 'FileSource$ContentDigest' => '

The digest of the file source.

', 'MetricsSource$ContentDigest' => '

The hash key used for the metrics source.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ContentType' => '

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'AutoMLJobChannel$ContentType' => '

The content type of the data from the input source. The following are the allowed content types for different problems:

  • For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

  • For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'Channel$ContentType' => '

The MIME type of the data.

', 'ContentTypes$member' => NULL, 'FileSource$ContentType' => '

The type of content stored in the file source.

', 'MetricsSource$ContentType' => '

The metric source content type.

', 'TransformInput$ContentType' => '

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

', ], ], 'ContentTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedContentTypes' => '

The supported MIME types for the input data.

', 'ChannelSpecification$SupportedContentTypes' => '

The supported MIME types for the data.

', 'InferenceSpecification$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'ContextArn' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'CreateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DeleteContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DescribeContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'UpdateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', ], ], 'ContextName' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextName' => '

The name of the context.

', 'CreateContextRequest$ContextName' => '

The name of the context. Must be unique to your account in an Amazon Web Services Region.

', 'DeleteContextRequest$ContextName' => '

The name of the context to delete.

', 'DescribeContextResponse$ContextName' => '

The name of the context.

', 'UpdateContextRequest$ContextName' => '

The name of the context to update.

', ], ], 'ContextNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeContextRequest$ContextName' => '

The name of the context to describe.

', ], ], 'ContextSource' => [ 'base' => '

A structure describing the source of a context.

', 'refs' => [ 'ContextSummary$Source' => '

The source of the context.

', 'CreateContextRequest$Source' => '

The source type, ID, and URI.

', 'DescribeContextResponse$Source' => '

The source of the context.

', ], ], 'ContextSummaries' => [ 'base' => NULL, 'refs' => [ 'ListContextsResponse$ContextSummaries' => '

A list of contexts and their properties.

', ], ], 'ContextSummary' => [ 'base' => '

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

', 'refs' => [ 'ContextSummaries$member' => NULL, ], ], 'ContinuousParameterRange' => [ 'base' => '

A list of continuous hyperparameters to tune.

', 'refs' => [ 'ContinuousParameterRanges$member' => NULL, ], ], 'ContinuousParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a continuous hyperparameter.

', 'refs' => [ 'ParameterRange$ContinuousParameterRangeSpecification' => '

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

', ], ], 'ContinuousParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$ContinuousParameterRanges' => '

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

', ], ], 'ConvergenceDetected' => [ 'base' => '

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

', 'refs' => [ 'TuningJobCompletionCriteria$ConvergenceDetected' => '

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

', ], ], 'CountryCode' => [ 'base' => NULL, 'refs' => [ 'HolidayConfigAttributes$CountryCode' => '

The country code for the holiday calendar.

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.

', ], ], 'CreateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$CreationTime' => '

A timestamp that shows when the algorithm was created.

', 'AppDetails$CreationTime' => '

The creation time.

', 'BatchDescribeModelPackageSummary$CreationTime' => '

The creation time of the mortgage package summary.

', 'CodeRepositorySummary$CreationTime' => '

The date and time that the Git repository was created.

', 'CompilationJobSummary$CreationTime' => '

The time when the model compilation job was created.

', 'DescribeAlgorithmOutput$CreationTime' => '

A timestamp specifying when the algorithm was created.

', 'DescribeCodeRepositoryOutput$CreationTime' => '

The date and time that the repository was created.

', 'DescribeCompilationJobResponse$CreationTime' => '

The time that the model compilation job was created.

', 'DescribeDomainResponse$CreationTime' => '

The creation time.

', 'DescribeFeatureGroupResponse$CreationTime' => '

A timestamp indicating when SageMaker created the FeatureGroup.

', 'DescribeFeatureMetadataResponse$CreationTime' => '

A timestamp indicating when the feature was created.

', 'DescribeInferenceRecommendationsJobResponse$CreationTime' => '

A timestamp that shows when the job was created.

', 'DescribeModelPackageGroupOutput$CreationTime' => '

The time that the model group was created.

', 'DescribeModelPackageOutput$CreationTime' => '

A timestamp specifying when the model package was created.

', 'DescribeNotebookInstanceLifecycleConfigOutput$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'DescribeNotebookInstanceOutput$CreationTime' => '

A timestamp. Use this parameter to return the time when the notebook instance was created

', 'DescribeSpaceResponse$CreationTime' => '

The creation time.

', 'DescribeUserProfileResponse$CreationTime' => '

The creation time.

', 'DomainDetails$CreationTime' => '

The creation time.

', 'FeatureGroup$CreationTime' => '

The time a FeatureGroup was created.

', 'FeatureMetadata$CreationTime' => '

A timestamp indicating when the feature was created.

', 'InferenceRecommendationsJob$CreationTime' => '

A timestamp that shows when the job was created.

', 'ListAlgorithmsInput$CreationTimeAfter' => '

A filter that returns only algorithms created after the specified time (timestamp).

', 'ListAlgorithmsInput$CreationTimeBefore' => '

A filter that returns only algorithms created before the specified time (timestamp).

', 'ListCodeRepositoriesInput$CreationTimeAfter' => '

A filter that returns only Git repositories that were created after the specified time.

', 'ListCodeRepositoriesInput$CreationTimeBefore' => '

A filter that returns only Git repositories that were created before the specified time.

', 'ListCompilationJobsRequest$CreationTimeAfter' => '

A filter that returns the model compilation jobs that were created after a specified time.

', 'ListCompilationJobsRequest$CreationTimeBefore' => '

A filter that returns the model compilation jobs that were created before a specified time.

', 'ListFeatureGroupsRequest$CreationTimeAfter' => '

Use this parameter to search for FeatureGroupss created after a specific date and time.

', 'ListFeatureGroupsRequest$CreationTimeBefore' => '

Use this parameter to search for FeatureGroupss created before a specific date and time.

', 'ListInferenceRecommendationsJobsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before the specified time (timestamp).

', 'ListModelPackageGroupsInput$CreationTimeAfter' => '

A filter that returns only model groups created after the specified time.

', 'ListModelPackageGroupsInput$CreationTimeBefore' => '

A filter that returns only model groups created before the specified time.

', 'ListModelPackagesInput$CreationTimeAfter' => '

A filter that returns only model packages created after the specified time (timestamp).

', 'ListModelPackagesInput$CreationTimeBefore' => '

A filter that returns only model packages created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore' => '

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter' => '

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeBefore' => '

A filter that returns only notebook instances that were created before the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeAfter' => '

A filter that returns only notebook instances that were created after the specified time (timestamp).

', 'ModelPackage$CreationTime' => '

The time that the model package was created.

', 'ModelPackageGroup$CreationTime' => '

The time that the model group was created.

', 'ModelPackageGroupSummary$CreationTime' => '

The time that the model group was created.

', 'ModelPackageSummary$CreationTime' => '

A timestamp that shows when the model package was created.

', 'NotebookInstanceLifecycleConfigSummary$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'NotebookInstanceSummary$CreationTime' => '

A timestamp that shows when the notebook instance was created.

', 'SpaceDetails$CreationTime' => '

The creation time.

', 'UserProfileDetails$CreationTime' => '

The creation time.

', ], ], 'CrossAccountFilterOption' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$CrossAccountFilterOption' => '

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

', ], ], 'CsvContentType' => [ 'base' => NULL, 'refs' => [ 'CsvContentTypes$member' => NULL, ], ], 'CsvContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$CsvContentTypes' => '

The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.

', ], ], 'CustomFileSystem' => [ 'base' => '

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystems$member' => NULL, ], ], 'CustomFileSystemConfig' => [ 'base' => '

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystemConfigs$member' => NULL, ], ], 'CustomFileSystemConfigs' => [ 'base' => NULL, 'refs' => [ 'DefaultSpaceSettings$CustomFileSystemConfigs' => '

The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'UserSettings$CustomFileSystemConfigs' => '

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomFileSystems' => [ 'base' => NULL, 'refs' => [ 'SpaceSettings$CustomFileSystems' => '

A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomImage' => [ 'base' => '

A custom SageMaker image. For more information, see Bring your own SageMaker image.

', 'refs' => [ 'CustomImages$member' => NULL, ], ], 'CustomImageContainerArguments' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerArguments' => '

The arguments for the container when you\'re running the application.

', ], ], 'CustomImageContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEntrypoint' => '

The entrypoint used to run the application in the container.

', ], ], 'CustomImageContainerEnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEnvironmentVariables' => '

The environment variables to set in the container

', ], ], 'CustomImages' => [ 'base' => NULL, 'refs' => [ 'CodeEditorAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a Code Editor app.

', 'JupyterLabAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a JupyterLab app.

', 'KernelGatewayAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a KernelGateway app.

', 'RSessionAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a RSession app.

', ], ], 'CustomPosixUserConfig' => [ 'base' => '

Details about the POSIX identity that is used for file system operations.

', 'refs' => [ 'DefaultSpaceSettings$CustomPosixUserConfig' => NULL, 'UserSettings$CustomPosixUserConfig' => '

Details about the POSIX identity that is used for file system operations.

', ], ], 'CustomerMetadataKey' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataKeyList$member' => NULL, 'CustomerMetadataMap$key' => NULL, ], ], 'CustomerMetadataKeyList' => [ 'base' => NULL, 'refs' => [ 'UpdateModelPackageInput$CustomerMetadataPropertiesToRemove' => '

The metadata properties associated with the model package versions to remove.

', ], ], 'CustomerMetadataMap' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'DescribeModelPackageOutput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'ModelPackage$CustomerMetadataProperties' => '

The metadata properties for the model package.

', 'UpdateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', ], ], 'CustomerMetadataValue' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataMap$value' => NULL, ], ], 'CustomizedMetricSpecification' => [ 'base' => '

A customized metric.

', 'refs' => [ 'MetricSpecification$Customized' => '

Information about a customized metric.

', ], ], 'DataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data.

', 'refs' => [ 'CreateEndpointConfigInput$DataCaptureConfig' => NULL, 'DescribeEndpointConfigOutput$DataCaptureConfig' => NULL, ], ], 'DataCaptureConfigSummary' => [ 'base' => '

The currently active data capture configuration used by your Endpoint.

', 'refs' => [ 'DescribeEndpointOutput$DataCaptureConfig' => NULL, 'Endpoint$DataCaptureConfig' => NULL, ], ], 'DataCatalogConfig' => [ 'base' => '

The meta data of the Glue table which serves as data catalog for the OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$DataCatalogConfig' => '

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

', ], ], 'DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$DataDistributionType' => '

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

', ], ], 'DataExplorationNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$DataExplorationNotebookLocation' => '

The URL of the notebook location.

', ], ], 'DataInputConfig' => [ 'base' => NULL, 'refs' => [ 'DerivedInformation$DerivedDataInputConfig' => '

The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don\'t need to specify the data input configuration when you create a compilation job.

', 'InputConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input":[1,1024,1024,3]}

      • If using the CLI, {\\"input\\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

      • If using the CLI, {\\"data1\\": [1,28,28,1], \\"data2\\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input_1":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\": [1,3,224,224], \\"input_2\\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"data":[1,3,1024,1024]}

      • If using the CLI, {\\"data\\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

      • If using the CLI, {\\"var1\\": [1,1,28,28], \\"var2\\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {"input0":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224]}

    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224], \\"input1\\":[1,3,224,224]}

    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

  • shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}

    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}

  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.

  • bias: If the input type is an Image, you need to provide the bias vector.

  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]

  • Image type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

  • Image type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow\'s default signature def key. For example:

    • "DataInputConfig": {"inputs": [1, 224, 224, 3]}

    • "CompilerOptions": {"signature_def_key": "serving_custom"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]}

    • "CompilerOptions": {"output_names": ["output_tensor:0"]}

', 'ModelInput$DataInputConfig' => '

The input configuration object for the model.

', ], ], 'DataProcessing' => [ 'base' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'refs' => [ 'CreateTransformJobRequest$DataProcessing' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'DescribeTransformJobResponse$DataProcessing' => NULL, 'TransformJob$DataProcessing' => NULL, ], ], 'DataQualityAppSpecification' => [ 'base' => '

Information about the container that a data quality monitoring job runs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification' => '

Specifies the container that runs the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification' => '

Information about the container that runs the data quality monitoring job.

', ], ], 'DataQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig' => '

Configures the constraints and baselines for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig' => '

The constraints and baselines for the data quality monitoring job definition.

', ], ], 'DataQualityJobInput' => [ 'base' => '

The input for the data quality monitoring job. Currently endpoints are supported for input.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobInput' => '

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityJobInput' => '

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

', ], ], 'DataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'Channel$DataSource' => '

The location of the channel data.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderOAuthSetting$DataSourceName' => '

The name of the data source that you\'re connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Database' => '

The name of the Glue table database.

', ], ], 'DatasetDefinition' => [ 'base' => '

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

', 'refs' => [ 'ProcessingInput$DatasetDefinition' => '

Configuration for a Dataset Definition input.

', ], ], 'DebugHookConfig' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'CreateTrainingJobRequest$DebugHookConfig' => NULL, 'DescribeTrainingJobResponse$DebugHookConfig' => NULL, 'TrainingJob$DebugHookConfig' => NULL, ], ], 'DebugRuleConfiguration' => [ 'base' => '

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'DebugRuleConfigurations$member' => NULL, ], ], 'DebugRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'DescribeTrainingJobResponse$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'TrainingJob$DebugRuleConfigurations' => '

Information about the debug rule configuration.

', ], ], 'DebugRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'DebugRuleEvaluationStatuses$member' => NULL, ], ], 'DebugRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$DebugRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

', 'TrainingJob$DebugRuleEvaluationStatuses' => '

Information about the evaluation status of the rules for the training job.

', ], ], 'DefaultEbsStorageSettings' => [ 'base' => '

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

', 'refs' => [ 'DefaultSpaceStorageSettings$DefaultEbsStorageSettings' => '

The default EBS storage settings for a space.

', ], ], 'DefaultGid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultGid' => '

The default POSIX group ID (GID). If not specified, defaults to 100.

', ], ], 'DefaultSpaceSettings' => [ 'base' => '

A collection of settings that apply to spaces created in the domain.

', 'refs' => [ 'CreateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'DescribeDomainResponse$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'UpdateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space within the domain.

', ], ], 'DefaultSpaceStorageSettings' => [ 'base' => '

The default storage settings for a space.

', 'refs' => [ 'DefaultSpaceSettings$SpaceStorageSettings' => NULL, 'UserSettings$SpaceStorageSettings' => '

The storage settings for a space.

', ], ], 'DefaultUid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultUid' => '

The default POSIX user ID (UID). If not specified, defaults to 1000.

', ], ], 'DeleteActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyCopyPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyCopyPath' => '

The hub content dependency copy path.

', ], ], 'DependencyOriginPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyOriginPath' => '

The hub content dependency origin path.

', ], ], 'DeployedImage' => [ 'base' => '

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

', 'refs' => [ 'DeployedImages$member' => NULL, 'InferenceComponentContainerSpecificationSummary$DeployedImage' => NULL, ], ], 'DeployedImages' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', 'ProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', ], ], 'DeploymentConfig' => [ 'base' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', 'refs' => [ 'CreateEndpointInput$DeploymentConfig' => NULL, 'DescribeEndpointOutput$LastDeploymentConfig' => '

The most recent deployment configuration for the endpoint.

', 'UpdateEndpointInput$DeploymentConfig' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', ], ], 'DeploymentRecommendation' => [ 'base' => '

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

', 'refs' => [ 'DescribeModelOutput$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', 'Model$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', ], ], 'DeploymentStage' => [ 'base' => '

Contains information about a stage in an edge deployment plan.

', 'refs' => [ 'DeploymentStages$member' => NULL, ], ], 'DeploymentStageMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', ], ], 'DeploymentStageStatusSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanResponse$Stages' => '

List of stages in the edge deployment plan.

', ], ], 'DeploymentStageStatusSummary' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummaries$member' => NULL, ], ], 'DeploymentStages' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$Stages' => '

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

', 'CreateEdgeDeploymentStageRequest$Stages' => '

List of stages to be added to the edge deployment plan.

', ], ], 'DeregisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DerivedInformation' => [ 'base' => '

Information that SageMaker Neo automatically derived about the model.

', 'refs' => [ 'DescribeCompilationJobResponse$DerivedInformation' => '

Information that SageMaker Neo automatically derived about the model.

', ], ], 'DescribeActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$Description' => '

A free-form description of a FeatureGroup.

', 'DescribeFeatureGroupResponse$Description' => '

A free form description of the feature group.

', 'FeatureGroup$Description' => '

A free form description of a FeatureGroup.

', ], ], 'DesiredWeightAndCapacity' => [ 'base' => '

Specifies weight and capacity values for a production variant.

', 'refs' => [ 'DesiredWeightAndCapacityList$member' => NULL, ], ], 'DesiredWeightAndCapacityList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities' => '

An object that provides new capacity and weight values for a variant.

', ], ], 'DestinationS3Uri' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$S3OutputPath' => '

The Amazon S3 location to upload inference responses to.

', 'AsyncInferenceOutputConfig$S3FailurePath' => '

The Amazon S3 location to upload failure inference responses to.

', 'BatchTransformInput$DataCapturedDestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'DataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location used to capture the data.

', 'DataCaptureConfigSummary$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'InferenceExperimentDataStorageConfig$Destination' => '

The Amazon S3 bucket where the inference request and response data is stored.

', 'ProductionVariantCoreDumpConfig$DestinationS3Uri' => '

The Amazon S3 bucket to send the core dump to.

', ], ], 'DetailedAlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$Status' => '

The current status.

', ], ], 'DetailedModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusItem$Status' => '

The current status.

', ], ], 'Device' => [ 'base' => '

Information of a particular device.

', 'refs' => [ 'Devices$member' => NULL, ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceArn' => '

The Amazon Resource Name (ARN) of the device.

', 'DeviceDeploymentSummary$DeviceArn' => '

The ARN of the device.

', 'DeviceSummary$DeviceArn' => '

Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceDeploymentSummary$DeviceDeploymentStatus' => '

The deployment status of the device.

', ], ], 'DeviceDeploymentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStageDevicesResponse$DeviceDeploymentSummaries' => '

List of summaries of devices allocated to the stage.

', ], ], 'DeviceDeploymentSummary' => [ 'base' => '

Contains information summarizing device details and deployment status.

', 'refs' => [ 'DeviceDeploymentSummaries$member' => NULL, ], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Description' => '

A description of the device.

', 'Device$Description' => '

Description of the device.

', 'DeviceDeploymentSummary$Description' => '

The description of the device.

', 'DeviceSummary$Description' => '

A description of the device.

', ], ], 'DeviceFleetArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$DeviceFleetArn' => '

The The Amazon Resource Name (ARN) of the fleet.

', 'DeviceFleetSummary$DeviceFleetArn' => '

Amazon Resource Name (ARN) of the device fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetArn' => '

The Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceFleetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$Description' => '

A description of the fleet.

', 'DescribeDeviceFleetResponse$Description' => '

A description of the fleet.

', 'GetDeviceFleetReportResponse$Description' => '

Description of the fleet.

', 'UpdateDeviceFleetRequest$Description' => '

Description of the fleet.

', ], ], 'DeviceFleetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsResponse$DeviceFleetSummaries' => '

Summary of the device fleet.

', ], ], 'DeviceFleetSummary' => [ 'base' => '

Summary of the device fleet.

', 'refs' => [ 'DeviceFleetSummaries$member' => NULL, ], ], 'DeviceName' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceName' => '

The name of the device.

', 'DeviceDeploymentSummary$DeviceName' => '

The name of the device.

', 'DeviceNames$member' => NULL, 'DeviceSelectionConfig$DeviceNameContains' => '

A filter to select devices with names containing this name.

', ], ], 'DeviceNames' => [ 'base' => NULL, 'refs' => [ 'DeregisterDevicesRequest$DeviceNames' => '

The unique IDs of the devices.

', 'DeviceSelectionConfig$DeviceNames' => '

List of devices chosen to deploy.

', ], ], 'DeviceSelectionConfig' => [ 'base' => '

Contains information about the configurations of selected devices.

', 'refs' => [ 'DeploymentStage$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', 'DeploymentStageStatusSummary$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', ], ], 'DeviceStats' => [ 'base' => '

Status of devices.

', 'refs' => [ 'GetDeviceFleetReportResponse$DeviceStats' => '

Status of devices.

', ], ], 'DeviceSubsetType' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$DeviceSubsetType' => '

Type of device subsets to deploy to the current stage.

', ], ], 'DeviceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$DeviceSummaries' => '

Summary of devices.

', ], ], 'DeviceSummary' => [ 'base' => '

Summary of the device.

', 'refs' => [ 'DeviceSummaries$member' => NULL, ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'RegisterDevicesRequest$Devices' => '

A list of devices to register with SageMaker Edge Manager.

', 'UpdateDevicesRequest$Devices' => '

List of devices to register with Edge Manager agent.

', ], ], 'Dimension' => [ 'base' => NULL, 'refs' => [ 'VectorConfig$Dimension' => '

The number of elements in your vector.

', ], ], 'DirectDeploySettings' => [ 'base' => '

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain\'s or user profile\'s Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain\'s or user profile\'s settings in the SageMaker console.

', 'refs' => [ 'CanvasAppSettings$DirectDeploySettings' => '

The model deployment settings for the SageMaker Canvas application.

', ], ], 'DirectInternetAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$DirectInternetAccess' => '

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

', 'DescribeNotebookInstanceOutput$DirectInternetAccess' => '

Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

', ], ], 'Direction' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$Direction' => '

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

', ], ], 'DirectoryPath' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfig$LocalPath' => '

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

', 'DebugHookConfig$LocalPath' => '

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

', 'DebugRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'FileSystemDataSource$DirectoryPath' => '

The full path to the directory to associate with the channel.

', 'ProfilerRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'TensorBoardOutputConfig$LocalPath' => '

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

', ], ], 'DisableProfiler' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$DisableProfiler' => '

Configuration to turn off Amazon SageMaker Debugger\'s system monitoring and profiling functionality. To turn it off, set to True.

', 'ProfilerConfigForUpdate$DisableProfiler' => '

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

', ], ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAdditionalCodeRepositories' => '

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateDefaultCodeRepository' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository' => '

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateLifecycleConfig' => '

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerSettings' => [ 'base' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'refs' => [ 'DomainSettings$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'DomainSettingsForUpdate$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', ], ], 'DocumentSchemaVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$DocumentSchemaVersion' => '

The document schema version for the hub content.

', 'HubContentInfo$DocumentSchemaVersion' => '

The version of the hub content document schema.

', 'ImportHubContentRequest$DocumentSchemaVersion' => '

The version of the hub content schema to import.

', 'ListHubContentVersionsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema version.

', 'ListHubContentsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema verion.

', ], ], 'Dollars' => [ 'base' => NULL, 'refs' => [ 'USD$Dollars' => '

The whole number of dollars in the amount.

', ], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the created domain.

', 'DescribeDomainResponse$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'DomainDetails$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'UpdateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the domain.

', ], ], 'DomainDetails' => [ 'base' => '

The domain\'s details.

', 'refs' => [ 'DomainList$member' => NULL, ], ], 'DomainId' => [ 'base' => NULL, 'refs' => [ 'AppDetails$DomainId' => '

The domain ID.

', 'CreateAppRequest$DomainId' => '

The domain ID.

', 'CreatePresignedDomainUrlRequest$DomainId' => '

The domain ID.

', 'CreateSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'CreateUserProfileRequest$DomainId' => '

The ID of the associated Domain.

', 'DeleteAppRequest$DomainId' => '

The domain ID.

', 'DeleteDomainRequest$DomainId' => '

The domain ID.

', 'DeleteSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'DeleteUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeAppRequest$DomainId' => '

The domain ID.

', 'DescribeAppResponse$DomainId' => '

The domain ID.

', 'DescribeDomainRequest$DomainId' => '

The domain ID.

', 'DescribeDomainResponse$DomainId' => '

The domain ID.

', 'DescribeSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'DescribeSpaceResponse$DomainId' => '

The ID of the associated domain.

', 'DescribeUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeUserProfileResponse$DomainId' => '

The ID of the domain that contains the profile.

', 'DomainDetails$DomainId' => '

The domain ID.

', 'ListAppsRequest$DomainIdEquals' => '

A parameter to search for the domain ID.

', 'ListSpacesRequest$DomainIdEquals' => '

A parameter to search for the domain ID.

', 'ListUserProfilesRequest$DomainIdEquals' => '

A parameter by which to filter the results.

', 'SpaceDetails$DomainId' => '

The ID of the associated domain.

', 'UpdateDomainRequest$DomainId' => '

The ID of the domain to be updated.

', 'UpdateSpaceRequest$DomainId' => '

The ID of the associated domain.

', 'UpdateUserProfileRequest$DomainId' => '

The domain ID.

', 'UserProfileDetails$DomainId' => '

The domain ID.

', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResponse$Domains' => '

The list of domains.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$DomainName' => '

A name for the domain.

', 'DescribeDomainResponse$DomainName' => '

The domain name.

', 'DomainDetails$DomainName' => '

The domain name.

', ], ], 'DomainSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', 'DomainSettingsForUpdate$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', ], ], 'DomainSettings' => [ 'base' => '

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

', 'refs' => [ 'CreateDomainRequest$DomainSettings' => '

A collection of Domain settings.

', 'DescribeDomainResponse$DomainSettings' => '

A collection of Domain settings.

', ], ], 'DomainSettingsForUpdate' => [ 'base' => '

A collection of Domain configuration settings to update.

', 'refs' => [ 'UpdateDomainRequest$DomainSettingsForUpdate' => '

A collection of DomainSettings configuration values to update.

', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$Status' => '

The status.

', 'DomainDetails$Status' => '

The status.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$TargetValue' => '

The recommended target value to specify for the metric when creating a scaling policy.

', ], ], 'DoubleParameterValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameterValue$NumberValue' => '

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can\'t specify the StringValue parameter.

', ], ], 'DriftCheckBaselines' => [ 'base' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'CreateModelPackageInput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'DescribeModelPackageOutput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'ModelPackage$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckBias' => [ 'base' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Bias' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckExplainability' => [ 'base' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Explainability' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelDataQuality' => [ 'base' => '

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelDataQuality' => '

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelQuality' => [ 'base' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelQuality' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DynamicScalingConfiguration' => [ 'base' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', ], ], 'EFSFileSystem' => [ 'base' => '

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystem$EFSFileSystem' => '

A custom file system in Amazon EFS.

', ], ], 'EFSFileSystemConfig' => [ 'base' => '

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker Domain.

', 'refs' => [ 'CustomFileSystemConfig$EFSFileSystemConfig' => '

The settings for a custom Amazon EFS file system.

', ], ], 'EMRStepMetadata' => [ 'base' => '

The configurations and outcomes of an Amazon EMR step execution.

', 'refs' => [ 'PipelineExecutionStepMetadata$EMR' => '

The configurations and outcomes of an Amazon EMR step execution.

', ], ], 'EbsStorageSettings' => [ 'base' => '

A collection of EBS storage settings that apply to both private and shared spaces.

', 'refs' => [ 'SpaceStorageSettings$EbsStorageSettings' => '

A collection of EBS storage settings for a space.

', ], ], 'Edge' => [ 'base' => '

A directed edge connecting two lineage entities.

', 'refs' => [ 'Edges$member' => NULL, ], ], 'EdgeDeploymentConfig' => [ 'base' => '

Contains information about the configuration of a deployment.

', 'refs' => [ 'DeploymentStage$DeploymentConfig' => '

Configuration of the deployment details.

', 'DeploymentStageStatusSummary$DeploymentConfig' => '

Configuration of the deployment details.

', ], ], 'EdgeDeploymentModelConfig' => [ 'base' => '

Contains information about the configuration of a model in a deployment.

', 'refs' => [ 'EdgeDeploymentModelConfigs$member' => NULL, ], ], 'EdgeDeploymentModelConfigs' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$ModelConfigs' => '

List of models associated with the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$ModelConfigs' => '

List of models associated with the edge deployment plan.

', ], ], 'EdgeDeploymentPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of edge deployment plan.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', ], ], 'EdgeDeploymentPlanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries' => '

List of summaries of edge deployment plans.

', ], ], 'EdgeDeploymentPlanSummary' => [ 'base' => '

Contains information summarizing an edge deployment plan.

', 'refs' => [ 'EdgeDeploymentPlanSummaries$member' => NULL, ], ], 'EdgeDeploymentStatus' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummary$DeploymentStatus' => '

General status of the current state.

', ], ], 'EdgeModel' => [ 'base' => '

The model on the edge device.

', 'refs' => [ 'EdgeModels$member' => NULL, ], ], 'EdgeModelStat' => [ 'base' => '

Status of edge devices with this model.

', 'refs' => [ 'EdgeModelStats$member' => NULL, ], ], 'EdgeModelStats' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$ModelStats' => '

Status of model on device.

', ], ], 'EdgeModelSummaries' => [ 'base' => NULL, 'refs' => [ 'DeviceSummary$Models' => '

Models on the device.

', ], ], 'EdgeModelSummary' => [ 'base' => '

Summary of model on edge device.

', 'refs' => [ 'EdgeModelSummaries$member' => NULL, ], ], 'EdgeModels' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Models' => '

Models on the device.

', ], ], 'EdgeOutputConfig' => [ 'base' => '

The output configuration.

', 'refs' => [ 'CreateDeviceFleetRequest$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'CreateEdgePackagingJobRequest$OutputConfig' => '

Provides information about the output location for the packaged model.

', 'DescribeDeviceFleetResponse$OutputConfig' => '

The output configuration for storing sampled data.

', 'DescribeEdgePackagingJobResponse$OutputConfig' => '

The output configuration for the edge packaging job.

', 'GetDeviceFleetReportResponse$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'UpdateDeviceFleetRequest$OutputConfig' => '

Output configuration for storing sample data collected by the fleet.

', ], ], 'EdgePackagingJobArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', ], ], 'EdgePackagingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatus' => '

The current status of the packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobStatus' => '

The status of the edge packaging job.

', 'ListEdgePackagingJobsRequest$StatusEquals' => '

The job status to filter for.

', ], ], 'EdgePackagingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsResponse$EdgePackagingJobSummaries' => '

Summaries of edge packaging jobs.

', ], ], 'EdgePackagingJobSummary' => [ 'base' => '

Summary of edge packaging job.

', 'refs' => [ 'EdgePackagingJobSummaries$member' => NULL, ], ], 'EdgePresetDeploymentArtifact' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Artifact' => '

The Amazon Resource Name (ARN) of the generated deployable resource.

', ], ], 'EdgePresetDeploymentOutput' => [ 'base' => '

The output of a SageMaker Edge Manager deployable resource.

', 'refs' => [ 'DescribeEdgePackagingJobResponse$PresetDeploymentOutput' => '

The output of a SageMaker Edge Manager deployable resource.

', ], ], 'EdgePresetDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Status' => '

The status of the deployable resource.

', ], ], 'EdgePresetDeploymentType' => [ 'base' => NULL, 'refs' => [ 'EdgeOutputConfig$PresetDeploymentType' => '

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', 'EdgePresetDeploymentOutput$Type' => '

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', ], ], 'EdgeVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$Version' => '

Version of the agent.

', 'CreateEdgePackagingJobRequest$ModelVersion' => '

The version of the model.

', 'DescribeDeviceResponse$AgentVersion' => '

Edge Manager agent version.

', 'DescribeEdgePackagingJobResponse$ModelVersion' => '

The version of the model.

', 'DeviceSummary$AgentVersion' => '

Edge Manager agent version.

', 'EdgeModel$ModelVersion' => '

The model version.

', 'EdgeModelStat$ModelVersion' => '

The model version.

', 'EdgeModelSummary$ModelVersion' => '

The version model.

', 'EdgePackagingJobSummary$ModelVersion' => '

The version of the model.

', ], ], 'Edges' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Edges' => '

A list of edges that connect vertices in the response.

', ], ], 'EfsUid' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$HomeEfsFileSystemUid' => '

The ID of the space\'s profile in the Amazon EFS volume.

', 'DescribeUserProfileResponse$HomeEfsFileSystemUid' => '

The ID of the user\'s profile in the Amazon Elastic File System volume.

', ], ], 'EnableCapture' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$EnableCapture' => '

Whether data capture should be enabled or disabled (defaults to enabled).

', 'DataCaptureConfigSummary$EnableCapture' => '

Whether data capture is enabled or disabled.

', ], ], 'EnableInfraCheck' => [ 'base' => NULL, 'refs' => [ 'InfraCheckConfig$EnableInfraCheck' => '

Enables an infrastructure health check.

', ], ], 'EnableIotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', 'UpdateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', ], ], 'EnableRemoteDebug' => [ 'base' => NULL, 'refs' => [ 'RemoteDebugConfig$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', 'RemoteDebugConfigForUpdate$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', ], ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSessionTagChaining' => [ 'base' => NULL, 'refs' => [ 'SessionChainingConfig$EnableSessionTagChaining' => '

Set to True to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.

', ], ], 'Endpoint' => [ 'base' => '

A hosted endpoint for real-time inference.

', 'refs' => [ 'SearchRecord$Endpoint' => NULL, ], ], 'EndpointArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'Endpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'EndpointSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'InferenceComponentSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'ModelDashboardEndpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the updated endpoint.

', ], ], 'EndpointConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'EndpointConfigSummary$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', ], ], 'EndpointConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

', 'CreateEndpointInput$EndpointConfigName' => '

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

', 'DeleteEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration that you want to delete.

', 'DescribeEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigName' => '

Name of the SageMaker endpoint configuration.

', 'DescribeEndpointOutput$EndpointConfigName' => '

The name of the endpoint configuration associated with this endpoint.

', 'Endpoint$EndpointConfigName' => '

The endpoint configuration associated with the endpoint.

', 'EndpointConfigSummary$EndpointConfigName' => '

The name of the endpoint configuration.

', 'EndpointMetadata$EndpointConfigName' => '

The name of the endpoint configuration.

', 'PendingDeploymentSummary$EndpointConfigName' => '

The name of the endpoint configuration used in the deployment.

', 'UpdateEndpointInput$EndpointConfigName' => '

The name of the new endpoint configuration.

', ], ], 'EndpointConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NameContains' => '

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

', ], ], 'EndpointConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'EndpointConfigSummary' => [ 'base' => '

Provides summary information for an endpoint configuration.

', 'refs' => [ 'EndpointConfigSummaryList$member' => NULL, ], ], 'EndpointConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsOutput$EndpointConfigs' => '

An array of endpoint configurations.

', ], ], 'EndpointInfo' => [ 'base' => '

Details about a customer endpoint that was compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$EndpointInfo' => NULL, 'Endpoints$member' => NULL, ], ], 'EndpointInput' => [ 'base' => '

Input object for the endpoint

', 'refs' => [ 'DataQualityJobInput$EndpointInput' => NULL, 'ModelBiasJobInput$EndpointInput' => NULL, 'ModelExplainabilityJobInput$EndpointInput' => NULL, 'ModelQualityJobInput$EndpointInput' => NULL, 'MonitoringInput$EndpointInput' => '

The endpoint for a monitoring job.

', ], ], 'EndpointInputConfiguration' => [ 'base' => '

The endpoint configuration for the load test.

', 'refs' => [ 'EndpointInputConfigurations$member' => NULL, ], ], 'EndpointInputConfigurations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$EndpointConfigurations' => '

Specifies the endpoint configuration to use for a job.

', ], ], 'EndpointMetadata' => [ 'base' => '

The metadata of the endpoint.

', 'refs' => [ 'DescribeInferenceExperimentResponse$EndpointMetadata' => '

The metadata of the endpoint on which the inference experiment ran.

', ], ], 'EndpointName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointInput$EndpointName' => '

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

', 'CreateInferenceComponentInput$EndpointName' => '

The name of an existing endpoint where you host the inference component.

', 'CreateInferenceExperimentRequest$EndpointName' => '

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

', 'DeleteEndpointInput$EndpointName' => '

The name of the endpoint that you want to delete.

', 'DescribeEndpointInput$EndpointName' => '

The name of the endpoint.

', 'DescribeEndpointOutput$EndpointName' => '

Name of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'DescribeMonitoringScheduleResponse$EndpointName' => '

The name of the endpoint for the monitoring job.

', 'Endpoint$EndpointName' => '

The name of the endpoint.

', 'EndpointInfo$EndpointName' => '

The name of a customer\'s endpoint.

', 'EndpointInput$EndpointName' => '

An endpoint in customer\'s account which has enabled DataCaptureConfig enabled.

', 'EndpointMetadata$EndpointName' => '

The name of the endpoint.

', 'EndpointSummary$EndpointName' => '

The name of the endpoint.

', 'GetScalingConfigurationRecommendationRequest$EndpointName' => '

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the RecommendationId field.

', 'GetScalingConfigurationRecommendationResponse$EndpointName' => '

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

', 'InferenceComponentSummary$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'ListDataQualityJobDefinitionsRequest$EndpointName' => '

A filter that lists the data quality job definitions associated with the specified endpoint.

', 'ListInferenceComponentsInput$EndpointNameEquals' => '

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

', 'ListModelBiasJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model bias.

', 'ListModelExplainabilityJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model explainability.

', 'ListModelQualityJobDefinitionsRequest$EndpointName' => '

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

', 'ListMonitoringExecutionsRequest$EndpointName' => '

Name of a specific endpoint to fetch jobs for.

', 'ListMonitoringSchedulesRequest$EndpointName' => '

Name of a specific endpoint to fetch schedules for.

', 'ModelDashboardEndpoint$EndpointName' => '

The endpoint name.

', 'ModelDashboardMonitoringSchedule$EndpointName' => '

The endpoint which is monitored.

', 'ModelDeployConfig$EndpointName' => '

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

', 'ModelDeployResult$EndpointName' => '

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

', 'MonitoringExecutionSummary$EndpointName' => '

The name of the endpoint used to run the monitoring job.

', 'MonitoringJobDefinitionSummary$EndpointName' => '

The name of the endpoint that the job monitors.

', 'MonitoringSchedule$EndpointName' => '

The endpoint that hosts the model being monitored.

', 'MonitoringScheduleSummary$EndpointName' => '

The name of the endpoint using the monitoring schedule.

', 'UpdateEndpointInput$EndpointName' => '

The name of the endpoint whose configuration you want to update.

', 'UpdateEndpointWeightsAndCapacitiesInput$EndpointName' => '

The name of an existing SageMaker endpoint.

', ], ], 'EndpointNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$NameContains' => '

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

', ], ], 'EndpointOutputConfiguration' => [ 'base' => '

The endpoint configuration made by Inference Recommender during a recommendation job.

', 'refs' => [ 'InferenceRecommendation$EndpointConfiguration' => '

Defines the endpoint configuration parameters.

', 'RecommendationJobInferenceBenchmark$EndpointConfiguration' => NULL, ], ], 'EndpointPerformance' => [ 'base' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', 'refs' => [ 'EndpointPerformances$member' => NULL, ], ], 'EndpointPerformances' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$EndpointPerformances' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', ], ], 'EndpointSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'EndpointStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint\'s status to InService, see Rolling Deployments.

', 'Endpoint$EndpointStatus' => '

The status of the endpoint.

', 'EndpointMetadata$EndpointStatus' => '

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

', 'EndpointSummary$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

', 'ListEndpointsInput$StatusEquals' => '

A filter that returns only endpoints with the specified status.

', 'ModelDashboardEndpoint$EndpointStatus' => '

The endpoint status.

', ], ], 'EndpointSummary' => [ 'base' => '

Provides summary information for an endpoint.

', 'refs' => [ 'EndpointSummaryList$member' => NULL, ], ], 'EndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsOutput$Endpoints' => '

An array or endpoint objects.

', ], ], 'Endpoints' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$Endpoints' => '

Existing customer endpoints on which to run an Inference Recommender job.

', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Description' => '

A description of the additional Inference specification

', 'AlgorithmSummary$AlgorithmDescription' => '

A brief description of the algorithm.

', 'BatchDescribeModelPackageSummary$ModelPackageDescription' => '

The description of the model package.

', 'ChannelSpecification$Description' => '

A brief description of the channel.

', 'CreateAlgorithmInput$AlgorithmDescription' => '

A description of the algorithm.

', 'CreateModelPackageGroupInput$ModelPackageGroupDescription' => '

A description for the model group.

', 'CreateModelPackageInput$ModelPackageDescription' => '

A description of the model package.

', 'CreateProjectInput$ProjectDescription' => '

A description for the project.

', 'DescribeAlgorithmOutput$AlgorithmDescription' => '

A brief summary about the algorithm.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupDescription' => '

A description of the model group.

', 'DescribeModelPackageOutput$ModelPackageDescription' => '

A brief summary of the model package.

', 'DescribeProjectOutput$ProjectDescription' => '

The description of the project.

', 'HyperParameterSpecification$Description' => '

A brief description of the hyperparameter.

', 'ModelPackage$ModelPackageDescription' => '

The description of the model package.

', 'ModelPackageGroup$ModelPackageGroupDescription' => '

The description for the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupDescription' => '

A description of the model group.

', 'ModelPackageSummary$ModelPackageDescription' => '

A brief description of the model package.

', 'Project$ProjectDescription' => '

The description of the project.

', 'ProjectSummary$ProjectDescription' => '

The description of the project.

', 'UpdateProjectInput$ProjectDescription' => '

The description for the project.

', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Name' => '

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

', 'AlgorithmStatusItem$Name' => '

The name of the algorithm for which the overall status is being reported.

', 'AlgorithmSummary$AlgorithmName' => '

The name of the algorithm that is described by the summary.

', 'AlgorithmValidationProfile$ProfileName' => '

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'BatchDescribeModelPackageSummary$ModelPackageGroupName' => '

The group name for the model package

', 'CodeRepositorySummary$CodeRepositoryName' => '

The name of the Git repository.

', 'CompilationJobSummary$CompilationJobName' => '

The name of the model compilation job that you want a summary for.

', 'CreateAlgorithmInput$AlgorithmName' => '

The name of the algorithm.

', 'CreateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'CreateCompilationJobRequest$CompilationJobName' => '

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

', 'CreateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet that the device belongs to.

', 'CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgeDeploymentPlanRequest$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'CreateEdgePackagingJobRequest$CompilationJobName' => '

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

', 'CreateEdgePackagingJobRequest$ModelName' => '

The name of the model.

', 'CreateModelCardExportJobRequest$ModelCardExportJobName' => '

The name of the model card export job.

', 'CreateModelCardRequest$ModelCardName' => '

The unique name of the model card.

', 'CreateModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group.

', 'CreateModelPackageInput$ModelPackageName' => '

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

', 'DeleteAlgorithmInput$AlgorithmName' => '

The name of the algorithm to delete.

', 'DeleteCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to delete.

', 'DeleteCompilationJobRequest$CompilationJobName' => '

The name of the compilation job to delete.

', 'DeleteDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet to delete.

', 'DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to delete.

', 'DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan from which the stage will be deleted.

', 'DeleteEdgeDeploymentStageRequest$StageName' => '

The name of the stage.

', 'DeleteModelCardRequest$ModelCardName' => '

The name of the model card to delete.

', 'DeleteModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to delete the policy.

', 'DeploymentStage$StageName' => '

The name of the stage.

', 'DeploymentStageStatusSummary$StageName' => '

The name of the stage.

', 'DeregisterDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeAlgorithmOutput$AlgorithmName' => '

The name of the algorithm being described.

', 'DescribeCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to describe.

', 'DescribeCodeRepositoryOutput$CodeRepositoryName' => '

The name of the Git repository.

', 'DescribeCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job that you want information about.

', 'DescribeCompilationJobResponse$CompilationJobName' => '

The name of the model compilation job.

', 'DescribeDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceFleetResponse$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceRequest$DeviceName' => '

The unique ID of the device.

', 'DescribeDeviceRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeDeviceResponse$DeviceName' => '

The unique identifier of the device.

', 'DescribeDeviceResponse$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the deployment plan to describe.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'DescribeEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$CompilationJobName' => '

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

', 'DescribeEdgePackagingJobResponse$ModelName' => '

The name of the model.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobName' => '

The name of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

', 'DescribeModelCardResponse$ModelCardName' => '

The name of the model card.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupName' => '

The name of the model group.

', 'DescribeModelPackageOutput$ModelPackageName' => '

The name of the model package being described.

', 'DescribeModelPackageOutput$ModelPackageGroupName' => '

If the model is a versioned model, the name of the model group that the versioned model belongs to.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DeviceDeploymentSummary$StageName' => '

The name of the stage in the edge deployment plan.

', 'DeviceDeploymentSummary$DeployedStageName' => '

The name of the deployed stage.

', 'DeviceDeploymentSummary$DeviceFleetName' => '

The name of the fleet to which the device belongs to.

', 'DeviceFleetSummary$DeviceFleetName' => '

Name of the device fleet.

', 'DeviceSummary$DeviceName' => '

The unique identifier of the device.

', 'DeviceSummary$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'EdgeDeploymentModelConfig$ModelHandle' => '

The name the device application uses to reference this model.

', 'EdgeDeploymentModelConfig$EdgePackagingJobName' => '

The edge packaging job associated with this deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$DeviceFleetName' => '

The name of the device fleet used for the deployment.

', 'EdgeModel$ModelName' => '

The name of the model.

', 'EdgeModelStat$ModelName' => '

The name of the model.

', 'EdgeModelSummary$ModelName' => '

The name of the model.

', 'EdgePackagingJobSummary$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'EdgePackagingJobSummary$CompilationJobName' => '

The name of the SageMaker Neo compilation job.

', 'EdgePackagingJobSummary$ModelName' => '

The name of the model.

', 'GetDeviceFleetReportRequest$DeviceFleetName' => '

The name of the fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetName' => '

The name of the fleet.

', 'GetModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to get the resource policy.

', 'ListDevicesRequest$ModelName' => '

A filter that searches devices that contains this name in any of their models.

', 'ListDevicesRequest$DeviceFleetName' => '

Filter for fleets containing this name in their device fleet name.

', 'ListModelCardExportJobsRequest$ModelCardName' => '

List export jobs for the model card with the specified name.

', 'ListModelCardExportJobsRequest$ModelCardExportJobNameContains' => '

Only list model card export jobs with names that contain the specified string.

', 'ListModelCardsRequest$NameContains' => '

Only list model cards with names that contain the specified string.

', 'ListStageDevicesRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'ListStageDevicesRequest$StageName' => '

The name of the stage in the deployment.

', 'ModelCard$ModelCardName' => '

The unique name of the model card.

', 'ModelCardExportJobSummary$ModelCardExportJobName' => '

The name of the model card export job.

', 'ModelCardExportJobSummary$ModelCardName' => '

The name of the model card that the export job exports.

', 'ModelCardSummary$ModelCardName' => '

The name of the model card.

', 'ModelCardVersionSummary$ModelCardName' => '

The name of the model card.

', 'ModelDashboardModelCard$ModelCardName' => '

The name of a model card.

', 'ModelPackage$ModelPackageName' => '

The name of the model.

', 'ModelPackage$ModelPackageGroupName' => '

The model group to which the model belongs.

', 'ModelPackageGroup$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageStatusItem$Name' => '

The name of the model package for which the overall status is being reported.

', 'ModelPackageSummary$ModelPackageName' => '

The name of the model package.

', 'ModelPackageSummary$ModelPackageGroupName' => '

If the model package is a versioned model, the model group that the versioned model belongs to.

', 'ModelPackageValidationProfile$ProfileName' => '

The name of the profile for the model package.

', 'PutModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group to add a resource policy to.

', 'RegisterDevicesRequest$DeviceFleetName' => '

The name of the fleet.

', 'StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to start.

', 'StartEdgeDeploymentStageRequest$StageName' => '

The name of the stage to start.

', 'StopCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job to stop.

', 'StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to stop.

', 'StopEdgeDeploymentStageRequest$StageName' => '

The name of the stage to stop.

', 'StopEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'UpdateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to update.

', 'UpdateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'UpdateDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', ], ], 'EnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$key' => NULL, ], ], 'EnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Environment' => '

The environment variables to set in the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Environment' => '

The environment variables to set in the Docker container.

The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB.

', 'InferenceComponentContainerSpecification$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

', 'InferenceComponentContainerSpecificationSummary$Environment' => '

The environment variables to set in the Docker container.

', 'ModelPackageContainerDefinition$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

', 'RealTimeInferenceRecommendation$Environment' => '

The recommended environment variables to set in the model container for Real-Time Inference.

', ], ], 'EnvironmentParameter' => [ 'base' => '

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

', 'refs' => [ 'EnvironmentParameters$member' => NULL, ], ], 'EnvironmentParameterRanges' => [ 'base' => '

Specifies the range of environment parameters

', 'refs' => [ 'EndpointInputConfiguration$EnvironmentParameterRanges' => '

The parameter you want to benchmark against.

', ], ], 'EnvironmentParameters' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$EnvironmentParameters' => '

Defines the environment parameters that includes key, value types, and values.

', ], ], 'EnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$value' => NULL, ], ], 'ExcludeFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', 'EndpointInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', ], ], 'ExecutionRoleIdentityConfig' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

', 'DomainSettingsForUpdate$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$StatusEquals' => '

A filter that retrieves only jobs with a specific status.

', 'MonitoringExecutionSummary$MonitoringExecutionStatus' => '

The status of the monitoring job.

', ], ], 'ExitMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJob$ExitMessage' => '

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJobSummary$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', ], ], 'Experiment' => [ 'base' => '

The properties of an experiment as returned by the Search API.

', 'refs' => [ 'SearchRecord$Experiment' => '

The properties of an experiment.

', ], ], 'ExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'DeleteExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment that is being deleted.

', 'DescribeExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'Experiment$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'ExperimentSummary$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'UpdateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', ], ], 'ExperimentConfig' => [ 'base' => '

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

', 'refs' => [ 'CreateProcessingJobRequest$ExperimentConfig' => NULL, 'CreateTrainingJobRequest$ExperimentConfig' => NULL, 'CreateTransformJobRequest$ExperimentConfig' => NULL, 'DescribeProcessingJobResponse$ExperimentConfig' => '

The configuration information used to create an experiment.

', 'DescribeTrainingJobResponse$ExperimentConfig' => NULL, 'DescribeTransformJobResponse$ExperimentConfig' => NULL, 'ProcessingJob$ExperimentConfig' => NULL, 'TrainingJob$ExperimentConfig' => NULL, 'TransformJob$ExperimentConfig' => NULL, ], ], 'ExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Description' => '

The description of the action.

', 'CreateContextRequest$Description' => '

The description of the context.

', 'CreateExperimentRequest$Description' => '

The description of the experiment.

', 'DescribeActionResponse$Description' => '

The description of the action.

', 'DescribeContextResponse$Description' => '

The description of the context.

', 'DescribeExperimentResponse$Description' => '

The description of the experiment.

', 'DescribeLineageGroupResponse$Description' => '

The description of the lineage group.

', 'Experiment$Description' => '

The description of the experiment.

', 'UpdateActionRequest$Description' => '

The new description for the action.

', 'UpdateContextRequest$Description' => '

The new description for the context.

', 'UpdateExperimentRequest$Description' => '

The description of the experiment.

', ], ], 'ExperimentEntityName' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionName' => '

The name of the action.

', 'ArtifactSummary$ArtifactName' => '

The name of the artifact.

', 'AssociateTrialComponentRequest$TrialComponentName' => '

The name of the component to associated with the trial.

', 'AssociateTrialComponentRequest$TrialName' => '

The name of the trial to associate with.

', 'AssociationSummary$SourceName' => '

The name of the source.

', 'AssociationSummary$DestinationName' => '

The name of the destination.

', 'CreateActionRequest$ActionName' => '

The name of the action. Must be unique to your account in an Amazon Web Services Region.

', 'CreateArtifactRequest$ArtifactName' => '

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

', 'CreateExperimentRequest$ExperimentName' => '

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If you don\'t specify DisplayName, the value in ExperimentName is displayed.

', 'CreateTrialComponentRequest$TrialComponentName' => '

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'CreateTrialRequest$TrialName' => '

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', 'CreateTrialRequest$ExperimentName' => '

The name of the experiment to associate the trial with.

', 'DeleteActionRequest$ActionName' => '

The name of the action to delete.

', 'DeleteExperimentRequest$ExperimentName' => '

The name of the experiment to delete.

', 'DeleteTrialComponentRequest$TrialComponentName' => '

The name of the component to delete.

', 'DeleteTrialRequest$TrialName' => '

The name of the trial to delete.

', 'DescribeExperimentRequest$ExperimentName' => '

The name of the experiment to describe.

', 'DescribeExperimentResponse$ExperimentName' => '

The name of the experiment.

', 'DescribeExperimentResponse$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'DescribeLineageGroupRequest$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$DisplayName' => '

The display name of the lineage group.

', 'DescribeTrialComponentResponse$TrialComponentName' => '

The name of the trial component.

', 'DescribeTrialComponentResponse$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'DescribeTrialRequest$TrialName' => '

The name of the trial to describe.

', 'DescribeTrialResponse$TrialName' => '

The name of the trial.

', 'DescribeTrialResponse$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'DescribeTrialResponse$ExperimentName' => '

The name of the experiment the trial is part of.

', 'DisassociateTrialComponentRequest$TrialComponentName' => '

The name of the component to disassociate from the trial.

', 'DisassociateTrialComponentRequest$TrialName' => '

The name of the trial to disassociate from.

', 'Experiment$ExperimentName' => '

The name of the experiment.

', 'Experiment$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'ExperimentConfig$ExperimentName' => '

The name of an existing experiment to associate with the trial component.

', 'ExperimentConfig$TrialName' => '

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

', 'ExperimentConfig$TrialComponentDisplayName' => '

The display name for the trial component. If this key isn\'t specified, the display name is the trial component name.

', 'ExperimentConfig$RunName' => '

The name of the experiment run to associate with the trial component.

', 'ExperimentSummary$ExperimentName' => '

The name of the experiment.

', 'ExperimentSummary$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'LineageGroupSummary$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$DisplayName' => '

The display name of the lineage group summary.

', 'ListTrialComponentsRequest$ExperimentName' => '

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can\'t filter by SourceArn or TrialName.

', 'ListTrialComponentsRequest$TrialName' => '

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can\'t filter by ExperimentName or SourceArn.

', 'ListTrialsRequest$ExperimentName' => '

A filter that returns only trials that are part of the specified experiment.

', 'ListTrialsRequest$TrialComponentName' => '

A filter that returns only trials that are associated with the specified trial component.

', 'Parent$TrialName' => '

The name of the trial.

', 'Parent$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$TrialName' => '

The name of the trial.

', 'Trial$TrialName' => '

The name of the trial.

', 'Trial$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'Trial$ExperimentName' => '

The name of the experiment the trial is part of.

', 'TrialComponent$TrialComponentName' => '

The name of the trial component.

', 'TrialComponent$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialComponent$RunName' => '

The name of the experiment run.

', 'TrialComponentSimpleSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialSummary$TrialName' => '

The name of the trial.

', 'TrialSummary$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'UpdateActionRequest$ActionName' => '

The name of the action to update.

', 'UpdateArtifactRequest$ArtifactName' => '

The new name for the artifact.

', 'UpdateExperimentRequest$ExperimentName' => '

The name of the experiment to update.

', 'UpdateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'UpdateTrialComponentRequest$TrialComponentName' => '

The name of the component to update.

', 'UpdateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'UpdateTrialRequest$TrialName' => '

The name of the trial to update.

', 'UpdateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', ], ], 'ExperimentEntityNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionRequest$ActionName' => '

The name of the action to describe.

', 'DescribeActionResponse$ActionName' => '

The name of the action.

', 'DescribeArtifactResponse$ArtifactName' => '

The name of the artifact.

', 'DescribeTrialComponentRequest$TrialComponentName' => '

The name of the trial component to describe.

', ], ], 'ExperimentSource' => [ 'base' => '

The source of the experiment.

', 'refs' => [ 'DescribeExperimentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the type.

', 'Experiment$Source' => NULL, 'ExperimentSummary$ExperimentSource' => NULL, ], ], 'ExperimentSourceArn' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'ExperimentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsResponse$ExperimentSummaries' => '

A list of the summaries of your experiments.

', ], ], 'ExperimentSummary' => [ 'base' => '

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

', 'refs' => [ 'ExperimentSummaries$member' => NULL, ], ], 'ExpiresInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$ExpiresInSeconds' => '

The number of seconds until the pre-signed URL expires. This value defaults to 300.

', ], ], 'Explainability' => [ 'base' => '

Contains explainability metrics for a model.

', 'refs' => [ 'ModelMetrics$Explainability' => '

Metrics that help explain a model.

', ], ], 'ExplainabilityLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$Explainability' => '

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

', ], ], 'ExplainerConfig' => [ 'base' => '

A parameter to activate explainers.

', 'refs' => [ 'CreateEndpointConfigInput$ExplainerConfig' => '

A member of CreateEndpointConfig that enables explainers.

', 'DescribeEndpointConfigOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', 'DescribeEndpointOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', ], ], 'FailStepMetadata' => [ 'base' => '

The container for the metadata for Fail step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Fail' => '

The configurations and outcomes of a Fail step execution.

', ], ], 'FailureHandlingPolicy' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentConfig$FailureHandlingPolicy' => '

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'DescribeAppResponse$FailureReason' => '

The failure reason.

', 'DescribeCompilationJobResponse$FailureReason' => '

If a model compilation job failed, the reason it failed.

', 'DescribeDomainResponse$FailureReason' => '

The failure reason.

', 'DescribeEndpointOutput$FailureReason' => '

If the status of the endpoint is Failed, the reason why it failed.

', 'DescribeFeatureGroupResponse$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.

  • The FeatureGroup could not be deleted from the OfflineStore.

', 'DescribeFlowDefinitionResponse$FailureReason' => '

The reason your flow definition failed.

', 'DescribeHubContentResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHubResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHyperParameterTuningJobResponse$FailureReason' => '

If the tuning job failed, the reason it failed.

', 'DescribeImageResponse$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'DescribeImageVersionResponse$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'DescribeInferenceComponentOutput$FailureReason' => '

If the inference component status is Failed, the reason for the failure.

', 'DescribeInferenceRecommendationsJobResponse$FailureReason' => '

If the job fails, provides information why the job failed.

', 'DescribeLabelingJobResponse$FailureReason' => '

If the job failed, the reason that it failed.

', 'DescribeModelCardExportJobResponse$FailureReason' => '

The failure reason if the model export job fails.

', 'DescribeMonitoringScheduleResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

', 'DescribeNotebookInstanceOutput$FailureReason' => '

If status is Failed, the reason it failed.

', 'DescribeProcessingJobResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'DescribeSpaceResponse$FailureReason' => '

The failure reason.

', 'DescribeTrainingJobResponse$FailureReason' => '

If the training job failed, the reason it failed.

', 'DescribeTransformJobResponse$FailureReason' => '

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

', 'DescribeUserProfileResponse$FailureReason' => '

The failure reason.

', 'Endpoint$FailureReason' => '

If the endpoint failed, the reason it failed.

', 'EndpointMetadata$FailureReason' => '

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

', 'FeatureGroup$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

', 'FlowDefinitionSummary$FailureReason' => '

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

', 'HyperParameterTrainingJobSummary$FailureReason' => '

The reason that the training job failed.

', 'HyperParameterTuningJobSearchEntity$FailureReason' => '

The error that was created when a hyperparameter tuning job failed.

', 'Image$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'ImageVersion$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'InferenceRecommendationsJob$FailureReason' => '

If the job fails, provides information why the job failed.

', 'LabelingJobSummary$FailureReason' => '

If the LabelingJobStatus field is Failed, this field contains a description of the error.

', 'LastUpdateStatus$FailureReason' => '

If the update wasn\'t successful, indicates the reason why it failed.

', 'ModelDashboardMonitoringSchedule$FailureReason' => '

If a monitoring job failed, provides the reason.

', 'MonitoringExecutionSummary$FailureReason' => '

Contains the reason a monitoring job failed, if it failed.

', 'MonitoringSchedule$FailureReason' => '

If the monitoring schedule failed, the reason it failed.

', 'PipelineExecutionStep$FailureReason' => '

The reason why the step failed execution. This is only returned if the step failed its execution.

', 'ProcessingJob$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ProcessingJobSummary$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ResourceInUse$Message' => NULL, 'ResourceLimitExceeded$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'TrainingJob$FailureReason' => '

If the training job failed, the reason it failed.

', 'TransformJob$FailureReason' => '

If the transform job failed, the reason it failed.

', 'TransformJobSummary$FailureReason' => '

If the transform job failed, the reason it failed.

', ], ], 'FeatureAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureGroupRequest$FeatureAdditions' => '

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you\'ve made a valid request. It takes some time after you\'ve made a valid request for Feature Store to update the feature group.

', ], ], 'FeatureDefinition' => [ 'base' => '

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

', 'refs' => [ 'FeatureAdditions$member' => NULL, 'FeatureDefinitions$member' => NULL, ], ], 'FeatureDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureDefinitions' => '

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', 'DescribeFeatureGroupResponse$FeatureDefinitions' => '

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

', 'FeatureGroup$FeatureDefinitions' => '

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', ], ], 'FeatureDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Description' => '

The description you added to describe the feature.

', 'FeatureMetadata$Description' => '

An optional description that you specify to better describe the feature.

', 'UpdateFeatureMetadataRequest$Description' => '

A description that you can write to better describe the feature.

', ], ], 'FeatureGroup' => [ 'base' => '

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

', 'refs' => [ 'SearchRecord$FeatureGroup' => NULL, ], ], 'FeatureGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

', 'DescribeFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that contains the feature.

', 'FeatureGroup$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of a FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupArn' => '

Unique identifier for the FeatureGroup.

', 'FeatureMetadata$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group.

', 'UpdateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that you\'re updating.

', ], ], 'FeatureGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$MaxResults' => '

The maximum number of results returned by ListFeatureGroups.

', ], ], 'FeatureGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

', 'DeleteFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeFeatureGroupResponse$FeatureGroupName' => '

he name of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupName' => '

The name of the feature group that you\'ve specified.

', 'FeatureGroup$FeatureGroupName' => '

The name of the FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupName' => '

The name of FeatureGroup.

', 'FeatureMetadata$FeatureGroupName' => '

The name of the feature group containing the feature.

', 'ProcessingFeatureStoreOutput$FeatureGroupName' => '

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

', ], ], 'FeatureGroupNameContains' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$NameContains' => '

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

', ], ], 'FeatureGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

', 'DescribeFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature.

', 'UpdateFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group that you\'re updating.

', 'UpdateFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you\'re updating.

', ], ], 'FeatureGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortBy' => '

The value on which the feature group list is sorted.

', ], ], 'FeatureGroupSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortOrder' => '

The order in which feature groups are listed.

', ], ], 'FeatureGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$FeatureGroupStatus' => '

The status of the feature group.

', 'FeatureGroup$FeatureGroupStatus' => '

A FeatureGroup status.

', 'FeatureGroupSummary$FeatureGroupStatus' => '

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

', 'ListFeatureGroupsRequest$FeatureGroupStatusEquals' => '

A FeatureGroup status. Filters by FeatureGroup status.

', ], ], 'FeatureGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsResponse$FeatureGroupSummaries' => '

A summary of feature groups.

', ], ], 'FeatureGroupSummary' => [ 'base' => '

The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

', 'refs' => [ 'FeatureGroupSummaries$member' => NULL, ], ], 'FeatureMetadata' => [ 'base' => '

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

', 'refs' => [ 'SearchRecord$FeatureMetadata' => '

The feature metadata used to search through the features.

', ], ], 'FeatureName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions\' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

', 'CreateFeatureGroupRequest$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd\'T\'HH:mm:ssZ and yyyy-MM-dd\'T\'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. \'T\' and Z are constants.

', 'DescribeFeatureGroupResponse$RecordIdentifierFeatureName' => '

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

', 'DescribeFeatureGroupResponse$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

', 'DescribeFeatureMetadataRequest$FeatureName' => '

The name of the feature.

', 'DescribeFeatureMetadataResponse$FeatureName' => '

The name of the feature that you\'ve specified.

', 'FeatureDefinition$FeatureName' => '

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

', 'FeatureGroup$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

', 'FeatureGroup$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

', 'FeatureMetadata$FeatureName' => '

The name of feature.

', 'UpdateFeatureMetadataRequest$FeatureName' => '

The name of the feature that you\'re updating.

', ], ], 'FeatureParameter' => [ 'base' => '

A key-value pair that you specify to describe the feature.

', 'refs' => [ 'FeatureParameterAdditions$member' => NULL, 'FeatureParameters$member' => NULL, ], ], 'FeatureParameterAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterAdditions' => '

A list of key-value pairs that you can add to better describe the feature.

', ], ], 'FeatureParameterKey' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Key' => '

A key that must contain a value to describe the feature.

', 'FeatureParameterRemovals$member' => NULL, ], ], 'FeatureParameterRemovals' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterRemovals' => '

A list of parameter keys that you can specify to remove parameters that describe your feature.

', ], ], 'FeatureParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Value' => '

The value that belongs to a key.

', ], ], 'FeatureParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Parameters' => '

The key-value pairs that you added to describe the feature.

', 'FeatureMetadata$Parameters' => '

Optional key-value pairs that you specify to better describe the feature.

', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'DirectDeploySettings$Status' => '

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

', 'DockerSettings$EnableDockerAccess' => '

Indicates whether the domain can access Docker.

', 'IdentityProviderOAuthSetting$Status' => '

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

', 'KendraSettings$Status' => '

Describes whether the document querying feature is enabled or disabled in the Canvas application.

', 'ModelRegisterSettings$Status' => '

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

', 'TimeSeriesForecastingSettings$Status' => '

Describes whether time series forecasting is enabled or disabled in the Canvas application.

', ], ], 'FeatureType' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$FeatureType' => '

The data type of the feature.

', 'FeatureDefinition$FeatureType' => '

The value type of a feature. Valid values are Integral, Fractional, or String.

', 'FeatureMetadata$FeatureType' => '

The data type of the feature.

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

Contains details regarding the file source.

', 'refs' => [ 'DriftCheckBias$ConfigFile' => '

The bias config file for a model.

', 'DriftCheckExplainability$ConfigFile' => '

The explainability config file for the model.

', ], ], 'FileSystemAccessMode' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemAccessMode' => '

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

', ], ], 'FileSystemConfig' => [ 'base' => '

The Amazon Elastic File System storage configuration for a SageMaker image.

', 'refs' => [ 'CodeEditorAppImageConfig$FileSystemConfig' => NULL, 'JupyterLabAppImageConfig$FileSystemConfig' => NULL, 'KernelGatewayImageConfig$FileSystemConfig' => '

The Amazon Elastic File System storage configuration for a SageMaker image.

', ], ], 'FileSystemDataSource' => [ 'base' => '

Specifies a file system data source for a channel.

', 'refs' => [ 'DataSource$FileSystemDataSource' => '

The file system that is associated with a channel.

', ], ], 'FileSystemId' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystem$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'EFSFileSystemConfig$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'FileSystemDataSource$FileSystemId' => '

The file system id.

', ], ], 'FileSystemPath' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystemConfig$FileSystemPath' => '

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemType' => '

The file system type.

', ], ], 'FillingTransformationMap' => [ 'base' => NULL, 'refs' => [ 'FillingTransformations$value' => NULL, ], ], 'FillingTransformationValue' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$value' => NULL, ], ], 'FillingTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Filling' => '

A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

The supported filling methods and their corresponding options are:

  • frontfill: none (Supported only for target column)

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

', ], ], 'FillingType' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$key' => NULL, ], ], 'Filter' => [ 'base' => '

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GreaterThan",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LessThan",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'NestedFilters$Filters' => '

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

', 'SearchExpression$Filters' => '

A list of filter objects.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'Filter$Value' => '

A value used with Name and Operator to determine which resources satisfy the filter\'s condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd\'T\'HH:MM:SS.

', ], ], 'FinalAutoMLJobObjectiveMetric' => [ 'base' => '

The best candidate result from an AutoML training job.

', 'refs' => [ 'AutoMLCandidate$FinalAutoMLJobObjectiveMetric' => NULL, ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'base' => '

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

', 'refs' => [ 'HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric' => '

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

', ], ], 'FinalMetricDataList' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$FinalMetricDataList' => '

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

', 'TrainingJob$FinalMetricDataList' => '

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

', ], ], 'FlatInvocations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$FlatInvocations' => '

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'MetricData$Value' => '

The value of the metric.

', 'MetricDatum$Value' => '

The value of the metric.

', 'RecommendationMetrics$CostPerHour' => '

Defines the cost per hour for the instance.

', 'RecommendationMetrics$CostPerInference' => '

Defines the cost per inference for the instance .

', ], ], 'FlowDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition you create.

', 'DescribeFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow defintion.

', 'FlowDefinitionSummary$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition.

', ], ], 'FlowDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionRequest$FlowDefinitionName' => '

The name of your flow definition.

', 'DeleteFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition you are deleting.

', 'DescribeFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition.

', 'DescribeFlowDefinitionResponse$FlowDefinitionName' => '

The Amazon Resource Name (ARN) of the flow definition.

', 'FlowDefinitionSummary$FlowDefinitionName' => '

The name of the flow definition.

', ], ], 'FlowDefinitionOutputConfig' => [ 'base' => '

Contains information about where human output will be stored.

', 'refs' => [ 'CreateFlowDefinitionRequest$OutputConfig' => '

An object containing information about where the human review results will be uploaded.

', 'DescribeFlowDefinitionResponse$OutputConfig' => '

An object containing information about the output file.

', ], ], 'FlowDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowDefinitionResponse$FlowDefinitionStatus' => '

The status of the flow definition. Valid values are listed below.

', 'FlowDefinitionSummary$FlowDefinitionStatus' => '

The status of the flow definition. Valid values:

', ], ], 'FlowDefinitionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFlowDefinitionsResponse$FlowDefinitionSummaries' => '

An array of objects describing the flow definitions.

', ], ], 'FlowDefinitionSummary' => [ 'base' => '

Contains summary information about the flow definition.

', 'refs' => [ 'FlowDefinitionSummaries$member' => NULL, ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for review by human workers.

', ], ], 'FlowDefinitionTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskCount' => '

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

', ], ], 'FlowDefinitionTaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskDescription' => '

A description for the human worker task.

', ], ], 'FlowDefinitionTaskKeyword' => [ 'base' => NULL, 'refs' => [ 'FlowDefinitionTaskKeywords$member' => NULL, ], ], 'FlowDefinitionTaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskKeywords' => '

Keywords used to describe the task so that workers can discover the task.

', ], ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

', ], ], 'FlowDefinitionTaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTitle' => '

A title for the human worker task.

', ], ], 'ForecastFrequency' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastFrequency' => '

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.

The valid values for each frequency are the following:

  • Minute - 1-59

  • Hour - 1-23

  • Day - 1-6

  • Week - 1-4

  • Month - 1-11

  • Year - 1

', ], ], 'ForecastHorizon' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastHorizon' => '

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.

', ], ], 'ForecastQuantile' => [ 'base' => NULL, 'refs' => [ 'ForecastQuantiles$member' => NULL, ], ], 'ForecastQuantiles' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastQuantiles' => '

The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.

', ], ], 'Framework' => [ 'base' => NULL, 'refs' => [ 'InputConfig$Framework' => '

Identifies the framework in which the model was trained. For example: TENSORFLOW.

', ], ], 'FrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'InputConfig$FrameworkVersion' => '

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

', ], ], 'GenerateCandidateDefinitionsOnly' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', 'DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly' => '

Indicates whether the output for an AutoML job generates candidate definitions only.

', 'TabularJobConfig$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', ], ], 'GenerativeAiSettings' => [ 'base' => '

The generative AI settings for the SageMaker Canvas application.

Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.

', 'refs' => [ 'CanvasAppSettings$GenerativeAiSettings' => '

The generative AI settings for the SageMaker Canvas application.

', ], ], 'GetDeviceFleetReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceFleetReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Gid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Gid' => '

The POSIX group ID.

', ], ], 'GitConfig' => [ 'base' => '

Specifies configuration details for a Git repository in your Amazon Web Services account.

', 'refs' => [ 'CodeRepositorySummary$GitConfig' => '

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', 'CreateCodeRepositoryInput$GitConfig' => '

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

', 'DescribeCodeRepositoryOutput$GitConfig' => '

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'GitConfigForUpdate' => [ 'base' => '

Specifies configuration details for a Git repository when the repository is updated.

', 'refs' => [ 'UpdateCodeRepositoryInput$GitConfig' => '

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', ], ], 'GitConfigUrl' => [ 'base' => NULL, 'refs' => [ 'GitConfig$RepositoryUrl' => '

The URL where the Git repository is located.

', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupingAttributeName' => [ 'base' => NULL, 'refs' => [ 'GroupingAttributeNames$member' => NULL, ], ], 'GroupingAttributeNames' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$GroupingAttributeNames' => '

A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'OidcMemberDefinition$Groups' => '

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

', ], ], 'HolidayConfig' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$HolidayConfig' => '

The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.

', ], ], 'HolidayConfigAttributes' => [ 'base' => '

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

', 'refs' => [ 'HolidayConfig$member' => NULL, ], ], 'HookParameters' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$HookParameters' => '

Configuration information for the Amazon SageMaker Debugger hook parameters.

', ], ], 'Horovod' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', 'DescribeImageVersionResponse$Horovod' => '

Indicates Horovod compatibility.

', 'UpdateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', ], ], 'HubArn' => [ 'base' => NULL, 'refs' => [ 'CreateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'DescribeHubContentResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub that contains the content.

', 'DescribeHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'HubInfo$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'ImportHubContentResponse$HubArn' => '

The ARN of the hub that the content was imported into.

', 'UpdateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the updated hub.

', ], ], 'HubContentArn' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'HubContentInfo$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'ImportHubContentResponse$HubContentArn' => '

The ARN of the hub content that was imported.

', ], ], 'HubContentDependency' => [ 'base' => '

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

', 'refs' => [ 'HubContentDependencyList$member' => NULL, ], ], 'HubContentDependencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDependencies' => '

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

', ], ], 'HubContentDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDescription' => '

A description of the hub content.

', 'HubContentInfo$HubContentDescription' => '

A description of the hub content.

', 'ImportHubContentRequest$HubContentDescription' => '

A description of the hub content to import.

', ], ], 'HubContentDisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDisplayName' => '

The display name of the hub content.

', 'HubContentInfo$HubContentDisplayName' => '

The display name of the hub content.

', 'ImportHubContentRequest$HubContentDisplayName' => '

The display name of the hub content to import.

', ], ], 'HubContentDocument' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', 'ImportHubContentRequest$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', ], ], 'HubContentInfo' => [ 'base' => '

Information about hub content.

', 'refs' => [ 'HubContentInfoList$member' => NULL, ], ], 'HubContentInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsResponse$HubContentSummaries' => '

The summaries of the listed hub content versions.

', 'ListHubContentsResponse$HubContentSummaries' => '

The summaries of the listed hub content.

', ], ], 'HubContentMarkdown' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', 'ImportHubContentRequest$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', ], ], 'HubContentName' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentName' => '

The name of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentName' => '

The name of the content to describe.

', 'DescribeHubContentResponse$HubContentName' => '

The name of the hub content.

', 'HubContentInfo$HubContentName' => '

The name of the hub content.

', 'ImportHubContentRequest$HubContentName' => '

The name of the hub content to import.

', 'ListHubContentVersionsRequest$HubContentName' => '

The name of the hub content.

', ], ], 'HubContentSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'HubContentInfo$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'ImportHubContentRequest$HubContentSearchKeywords' => '

The searchable keywords of the hub content.

', ], ], 'HubContentSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', 'ListHubContentsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', ], ], 'HubContentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentStatus' => '

The status of the hub content.

', 'HubContentInfo$HubContentStatus' => '

The status of the hub content.

', ], ], 'HubContentType' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentType' => '

The type of content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentType' => '

The type of content in the hub.

', 'DescribeHubContentResponse$HubContentType' => '

The type of hub content.

', 'HubContentInfo$HubContentType' => '

The type of hub content.

', 'ImportHubContentRequest$HubContentType' => '

The type of hub content to import.

', 'ListHubContentVersionsRequest$HubContentType' => '

The type of hub content to list versions of.

', 'ListHubContentsRequest$HubContentType' => '

The type of hub content to list.

', ], ], 'HubContentVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentVersion' => '

The version of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentVersion' => '

The version of the content to describe.

', 'DescribeHubContentResponse$HubContentVersion' => '

The version of the hub content.

', 'HubContentInfo$HubContentVersion' => '

The version of the hub content.

', 'ImportHubContentRequest$HubContentVersion' => '

The version of the hub content to import.

', 'ListHubContentVersionsRequest$MinVersion' => '

The lower bound of the hub content versions to list.

', ], ], 'HubDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDescription' => '

A description of the hub.

', 'DescribeHubResponse$HubDescription' => '

A description of the hub.

', 'HubInfo$HubDescription' => '

A description of the hub.

', 'UpdateHubRequest$HubDescription' => '

A description of the updated hub.

', ], ], 'HubDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDisplayName' => '

The display name of the hub.

', 'DescribeHubResponse$HubDisplayName' => '

The display name of the hub.

', 'HubInfo$HubDisplayName' => '

The display name of the hub.

', 'UpdateHubRequest$HubDisplayName' => '

The display name of the hub.

', ], ], 'HubInfo' => [ 'base' => '

Information about a hub.

', 'refs' => [ 'HubInfoList$member' => NULL, ], ], 'HubInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubsResponse$HubSummaries' => '

The summaries of the listed hubs.

', ], ], 'HubName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubName' => '

The name of the hub to create.

', 'DeleteHubContentRequest$HubName' => '

The name of the hub that you want to delete content in.

', 'DeleteHubRequest$HubName' => '

The name of the hub to delete.

', 'DescribeHubContentRequest$HubName' => '

The name of the hub that contains the content to describe.

', 'DescribeHubContentResponse$HubName' => '

The name of the hub that contains the content.

', 'DescribeHubRequest$HubName' => '

The name of the hub to describe.

', 'DescribeHubResponse$HubName' => '

The name of the hub.

', 'HubInfo$HubName' => '

The name of the hub.

', 'ImportHubContentRequest$HubName' => '

The name of the hub to import content into.

', 'ListHubContentVersionsRequest$HubName' => '

The name of the hub to list the content versions of.

', 'ListHubContentsRequest$HubName' => '

The name of the hub to list the contents of.

', 'UpdateHubRequest$HubName' => '

The name of the hub to update.

', ], ], 'HubS3StorageConfig' => [ 'base' => '

The Amazon S3 storage configuration of a hub.

', 'refs' => [ 'CreateHubRequest$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', 'DescribeHubResponse$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', ], ], 'HubSearchKeyword' => [ 'base' => NULL, 'refs' => [ 'HubContentSearchKeywordList$member' => NULL, 'HubSearchKeywordList$member' => NULL, ], ], 'HubSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'DescribeHubResponse$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'HubInfo$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'UpdateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', ], ], 'HubSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubsRequest$SortBy' => '

Sort hubs by either name or creation time.

', ], ], 'HubStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubResponse$HubStatus' => '

The status of the hub.

', 'HubInfo$HubStatus' => '

The status of the hub.

', ], ], 'HumanLoopActivationConditions' => [ 'base' => NULL, 'refs' => [ 'HumanLoopActivationConditionsConfig$HumanLoopActivationConditions' => '

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

', ], ], 'HumanLoopActivationConditionsConfig' => [ 'base' => '

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

', 'refs' => [ 'HumanLoopActivationConfig$HumanLoopActivationConditionsConfig' => '

Container structure for defining under what conditions SageMaker creates a human loop.

', ], ], 'HumanLoopActivationConfig' => [ 'base' => '

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopActivationConfig' => '

An object containing information about the events that trigger a human workflow.

', 'DescribeFlowDefinitionResponse$HumanLoopActivationConfig' => '

An object containing information about what triggers a human review workflow.

', ], ], 'HumanLoopConfig' => [ 'base' => '

Describes the work to be performed by human workers.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopConfig' => '

An object containing information about the tasks the human reviewers will perform.

', 'DescribeFlowDefinitionResponse$HumanLoopConfig' => '

An object containing information about who works on the task, the workforce task price, and other task details.

', ], ], 'HumanLoopRequestSource' => [ 'base' => '

Container for configuring the source of human task requests.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', 'DescribeFlowDefinitionResponse$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', ], ], 'HumanTaskConfig' => [ 'base' => '

Information required for human workers to complete a labeling task.

', 'refs' => [ 'CreateLabelingJobRequest$HumanTaskConfig' => '

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

', 'DescribeLabelingJobResponse$HumanTaskConfig' => '

Configuration information required for human workers to complete a labeling task.

', ], ], 'HumanTaskUiArn' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

', 'DescribeHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

', 'HumanLoopConfig$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

', 'HumanTaskUiSummary$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

', 'RenderUiTemplateRequest$HumanTaskUiArn' => '

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

', 'UiConfig$HumanTaskUiArn' => '

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

', ], ], 'HumanTaskUiName' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiRequest$HumanTaskUiName' => '

The name of the user interface you are creating.

', 'DeleteHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (work task template) you want to delete.

', 'DescribeHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (worker task template) you want information about.

', 'DescribeHumanTaskUiResponse$HumanTaskUiName' => '

The name of the human task user interface (worker task template).

', 'HumanTaskUiSummary$HumanTaskUiName' => '

The name of the human task user interface.

', ], ], 'HumanTaskUiStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHumanTaskUiResponse$HumanTaskUiStatus' => '

The status of the human task user interface (worker task template). Valid values are listed below.

', ], ], 'HumanTaskUiSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHumanTaskUisResponse$HumanTaskUiSummaries' => '

An array of objects describing the human task user interfaces.

', ], ], 'HumanTaskUiSummary' => [ 'base' => '

Container for human task user interface information.

', 'refs' => [ 'HumanTaskUiSummaries$member' => NULL, ], ], 'HyperParameterAlgorithmSpecification' => [ 'base' => '

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$AlgorithmSpecification' => '

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

', ], ], 'HyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameters$key' => NULL, ], ], 'HyperParameterScalingType' => [ 'base' => NULL, 'refs' => [ 'ContinuousParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

', 'IntegerParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

', ], ], 'HyperParameterSpecification' => [ 'base' => '

Defines a hyperparameter to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecifications$member' => NULL, ], ], 'HyperParameterSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedHyperParameters' => '

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

', ], ], 'HyperParameterTrainingJobDefinition' => [ 'base' => '

Defines the training jobs launched by a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

', 'HyperParameterTrainingJobDefinitions$member' => NULL, 'HyperParameterTuningJobSearchEntity$TrainingJobDefinition' => NULL, ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$DefinitionName' => '

The job definition name.

', 'HyperParameterTrainingJobSummary$TrainingJobDefinitionName' => '

The training job definition name.

', ], ], 'HyperParameterTrainingJobDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'HyperParameterTuningJobSearchEntity$TrainingJobDefinitions' => '

The job definitions included in a hyperparameter tuning job.

', ], ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$key' => NULL, ], ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$Environment' => '

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can\'t exceed the maximum number specified.

', ], ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$value' => NULL, ], ], 'HyperParameterTrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries' => '

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

', ], ], 'HyperParameterTrainingJobSummary' => [ 'base' => '

The container for the summary information about a training job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$BestTrainingJob' => '

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

', 'DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob' => '

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

', 'HyperParameterTrainingJobSummaries$member' => NULL, 'HyperParameterTuningJobSearchEntity$BestTrainingJob' => NULL, 'HyperParameterTuningJobSearchEntity$OverallBestTrainingJob' => NULL, ], ], 'HyperParameterTuningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$AllocationStrategy' => '

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

', ], ], 'HyperParameterTuningInstanceConfig' => [ 'base' => '

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

', 'refs' => [ 'HyperParameterTuningInstanceConfigs$member' => NULL, ], ], 'HyperParameterTuningInstanceConfigs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$InstanceConfigs' => '

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

', ], ], 'HyperParameterTuningJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'DescribeTrainingJobResponse$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'TrainingJob$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'TuningJobStepMetaData$Arn' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'HyperParameterTuningJobCompletionDetails' => [ 'base' => '

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails' => '

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

', 'HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails' => '

Information about either a current or completed hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobConfig' => [ 'base' => '

Configures a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig' => NULL, ], ], 'HyperParameterTuningJobConsumedResources' => [ 'base' => '

The total resources consumed by your hyperparameter tuning job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ConsumedResources' => NULL, 'HyperParameterTuningJobSearchEntity$ConsumedResources' => '

The total amount of resources consumed by a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobName' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

', 'DeleteHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job that you want to delete.

', 'DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job.

', 'HyperParameterTrainingJobSummary$TuningJobName' => '

The HyperParameter tuning job that launched the training job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName' => '

The name of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job whose training jobs you want to list.

', 'ParentHyperParameterTuningJob$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'StopHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job to stop.

', ], ], 'HyperParameterTuningJobObjective' => [ 'base' => '

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$TuningObjective' => NULL, 'HyperParameterTuningJobConfig$HyperParameterTuningJobObjective' => '

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

', 'HyperParameterTuningJobObjectives$member' => NULL, ], ], 'HyperParameterTuningJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$Type' => '

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

', 'HyperParameterTuningJobObjective$Type' => '

Whether to minimize or maximize the objective metric.

', ], ], 'HyperParameterTuningJobObjectives' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTuningJobObjectiveMetrics' => '

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'base' => '

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

', 'refs' => [ 'SearchRecord$HyperParameterTuningJob' => '

The properties of a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsRequest$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'HyperParameterTuningJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobStatus' => '

The status of the tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus' => '

The status of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobStatus' => '

The status of the tuning job.

', 'ListHyperParameterTuningJobsRequest$StatusEquals' => '

A filter that returns only tuning jobs with the specified status.

', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'base' => '

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

', 'refs' => [ 'HyperParameterTuningJobConfig$StrategyConfig' => '

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

', ], ], 'HyperParameterTuningJobStrategyType' => [ 'base' => '

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

', 'refs' => [ 'HyperParameterTuningJobConfig$Strategy' => '

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

', 'HyperParameterTuningJobSummary$Strategy' => '

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

', ], ], 'HyperParameterTuningJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries' => '

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

', ], ], 'HyperParameterTuningJobSummary' => [ 'base' => '

Provides summary information about a hyperparameter tuning job.

', 'refs' => [ 'HyperParameterTuningJobSummaries$member' => NULL, ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'base' => '

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$WarmStartConfig' => '

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'DescribeHyperParameterTuningJobResponse$WarmStartConfig' => '

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

', 'HyperParameterTuningJobSearchEntity$WarmStartConfig' => NULL, ], ], 'HyperParameterTuningJobWarmStartType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$WarmStartType' => '

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxRuntimeInSeconds' => '

The maximum time in seconds that a hyperparameter tuning job can run.

', ], ], 'HyperParameterTuningResourceConfig' => [ 'base' => '

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterTuningResourceConfig' => '

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

', ], ], 'HyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$DefaultValue' => '

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

', 'HyperParameters$value' => NULL, ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$HyperParameters' => '

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'DescribeTrainingJobResponse$HyperParameters' => '

Algorithm-specific parameters.

', 'HyperParameterTrainingJobDefinition$StaticHyperParameters' => '

Specifies the values of hyperparameters that do not change for the tuning job.

', 'HyperParameterTrainingJobSummary$TunedHyperParameters' => '

A list of the hyperparameters for which you specified ranges to search.

', 'TrainingJob$HyperParameters' => '

Algorithm-specific parameters.

', 'TrainingJobDefinition$HyperParameters' => '

The hyperparameters used for the training job.

', ], ], 'HyperbandStrategyConfig' => [ 'base' => '

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

', 'refs' => [ 'HyperParameterTuningJobStrategyConfig$HyperbandStrategyConfig' => '

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

', ], ], 'HyperbandStrategyMaxResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MaxResource' => '

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs

  • numepochs

  • n-epochs

  • n_epochs

  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

', ], ], 'HyperbandStrategyMinResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MinResource' => '

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

', ], ], 'IamIdentity' => [ 'base' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

', 'refs' => [ 'UserContext$IamIdentity' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'DeletePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'RetryPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'SendPipelineExecutionStepFailureRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'SendPipelineExecutionStepSuccessRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'StartPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'StopPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', ], ], 'IdentityProviderOAuthSetting' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

', 'refs' => [ 'IdentityProviderOAuthSettings$member' => NULL, ], ], 'IdentityProviderOAuthSettings' => [ 'base' => NULL, 'refs' => [ 'CanvasAppSettings$IdentityProviderOAuthSettings' => '

The settings for connecting to an external data source with OAuth.

', ], ], 'Image' => [ 'base' => '

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

', 'refs' => [ 'Images$member' => NULL, ], ], 'ImageArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageVersionResponse$ImageArn' => '

The ARN of the image the version is based on.

', 'Image$ImageArn' => '

The ARN of the image.

', 'ImageVersion$ImageArn' => '

The ARN of the image the version is based on.

', 'ResourceSpec$SageMakerImageArn' => '

The ARN of the SageMaker image that the image version belongs to.

', 'UpdateImageResponse$ImageArn' => '

The ARN of the image.

', ], ], 'ImageBaseImage' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$BaseImage' => '

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

', 'DescribeImageVersionResponse$BaseImage' => '

The registry path of the container image on which this image version is based.

', ], ], 'ImageClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the image classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$ImageClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the image classification problem type.

', ], ], 'ImageConfig' => [ 'base' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

', 'refs' => [ 'ContainerDefinition$ImageConfig' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', ], ], 'ImageContainerImage' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ContainerImage' => '

The registry path of the container image that contains this image version.

', ], ], 'ImageDeleteProperty' => [ 'base' => NULL, 'refs' => [ 'ImageDeletePropertyList$member' => NULL, ], ], 'ImageDeletePropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateImageRequest$DeleteProperties' => '

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

', ], ], 'ImageDescription' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$Description' => '

The description of the image.

', 'DescribeImageResponse$Description' => '

The description of the image.

', 'Image$Description' => '

The description of the image.

', 'UpdateImageRequest$Description' => '

The new description for the image.

', ], ], 'ImageDigest' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$ImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', 'TrainingSpecification$TrainingImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', ], ], 'ImageDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$DisplayName' => '

The display name of the image. If not provided, ImageName is displayed.

', 'DescribeImageResponse$DisplayName' => '

The name of the image as displayed.

', 'Image$DisplayName' => '

The name of the image as displayed.

', 'UpdateImageRequest$DisplayName' => '

The new display name for the image.

', ], ], 'ImageName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$ImageName' => '

The name of the image. Must be unique to your account.

', 'CreateImageVersionRequest$ImageName' => '

The ImageName of the Image to create a version of.

', 'CustomImage$ImageName' => '

The name of the CustomImage. Must be unique to your account.

', 'DeleteImageRequest$ImageName' => '

The name of the image to delete.

', 'DeleteImageVersionRequest$ImageName' => '

The name of the image to delete.

', 'DescribeImageRequest$ImageName' => '

The name of the image to describe.

', 'DescribeImageResponse$ImageName' => '

The name of the image.

', 'DescribeImageVersionRequest$ImageName' => '

The name of the image.

', 'Image$ImageName' => '

The name of the image.

', 'ListAliasesRequest$ImageName' => '

The name of the image.

', 'ListImageVersionsRequest$ImageName' => '

The name of the image to list the versions of.

', 'UpdateImageRequest$ImageName' => '

The name of the image to update.

', 'UpdateImageVersionRequest$ImageName' => '

The name of the image.

', ], ], 'ImageNameContains' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$NameContains' => '

A filter that returns only images whose name contains the specified string.

', ], ], 'ImageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageResponse$ImageStatus' => '

The status of the image.

', 'Image$ImageStatus' => '

The status of the image.

', ], ], 'ImageUri' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ImageUri' => '

The container image to be run by the processing job.

', 'DataQualityAppSpecification$ImageUri' => '

The container image that the data quality monitoring job runs.

', 'ModelBiasAppSpecification$ImageUri' => '

The container image to be run by the model bias job.

', 'ModelExplainabilityAppSpecification$ImageUri' => '

The container image to be run by the model explainability job.

', 'ModelQualityAppSpecification$ImageUri' => '

The address of the container image that the monitoring job runs.

', 'MonitoringAppSpecification$ImageUri' => '

The container image to be run by the monitoring job.

', ], ], 'ImageVersion' => [ 'base' => '

A version of a SageMaker Image. A version represents an existing container image.

', 'refs' => [ 'ImageVersions$member' => NULL, ], ], 'ImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$SageMakerImageVersionAlias' => '

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

', ], ], 'ImageVersionArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', 'DescribeImageVersionResponse$ImageVersionArn' => '

The ARN of the version.

', 'ImageVersion$ImageVersionArn' => '

The ARN of the version.

', 'ResourceSpec$SageMakerImageVersionArn' => '

The ARN of the image version created on the instance.

', 'UpdateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', ], ], 'ImageVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CustomImage$ImageVersionNumber' => '

The version number of the CustomImage.

', 'DeleteImageVersionRequest$Version' => '

The version to delete.

', 'DescribeImageVersionRequest$Version' => '

The version of the image. If not specified, the latest version is described.

', 'DescribeImageVersionResponse$Version' => '

The version number.

', 'ImageVersion$Version' => '

The version number.

', 'ListAliasesRequest$Version' => '

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

', 'UpdateImageVersionRequest$Version' => '

The version of the image.

', ], ], 'ImageVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageVersionSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ImageVersionStatus' => '

The status of the version.

', 'ImageVersion$ImageVersionStatus' => '

The status of the version.

', ], ], 'ImageVersions' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsResponse$ImageVersions' => '

A list of versions and their properties.

', ], ], 'Images' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$Images' => '

A list of images and their properties.

', ], ], 'ImportHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InferenceComponentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'InferenceComponentSummary$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentRuntimeConfigOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', ], ], 'InferenceComponentComputeResourceRequirements' => [ 'base' => '

Defines the compute resources to allocate to run a model that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

', 'refs' => [ 'InferenceComponentSpecification$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', 'InferenceComponentSpecificationSummary$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', ], ], 'InferenceComponentContainerSpecification' => [ 'base' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', 'refs' => [ 'InferenceComponentSpecification$Container' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'InferenceComponentSpecificationSummary$Container' => '

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

', ], ], 'InferenceComponentCopyCount' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentRuntimeConfig$CopyCount' => '

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

', 'InferenceComponentRuntimeConfigSummary$DesiredCopyCount' => '

The number of runtime copies of the model container that you requested to deploy with the inference component.

', 'InferenceComponentRuntimeConfigSummary$CurrentCopyCount' => '

The number of runtime copies of the model container that are currently deployed.

', ], ], 'InferenceComponentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$InferenceComponentName' => '

A unique name to assign to the inference component.

', 'DeleteInferenceComponentInput$InferenceComponentName' => '

The name of the inference component to delete.

', 'DescribeInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentName' => '

The name of the inference component.

', 'InferenceComponentSummary$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$InferenceComponentName' => '

The name of the inference component to update.

', ], ], 'InferenceComponentNameContains' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$NameContains' => '

Filters the results to only those inference components with a name that contains the specified string.

', ], ], 'InferenceComponentRuntimeConfig' => [ 'base' => '

Runtime settings for a model that is deployed with an inference component.

', 'refs' => [ 'CreateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$DesiredRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'base' => '

Details about the runtime settings for the model that is deployed with the inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$RuntimeConfig' => '

Details about the runtime settings for the model that is deployed with the inference component.

', ], ], 'InferenceComponentSortKey' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$SortBy' => '

The field by which to sort the inference components in the response. The default is CreationTime.

', ], ], 'InferenceComponentSpecification' => [ 'base' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'refs' => [ 'CreateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'UpdateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', ], ], 'InferenceComponentSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$Specification' => '

Details about the resources that are deployed with this inference component.

', ], ], 'InferenceComponentStartupParameters' => [ 'base' => '

Settings that take effect while the model container starts up.

', 'refs' => [ 'InferenceComponentSpecification$StartupParameters' => '

Settings that take effect while the model container starts up.

', 'InferenceComponentSpecificationSummary$StartupParameters' => '

Settings that take effect while the model container starts up.

', ], ], 'InferenceComponentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceComponentOutput$InferenceComponentStatus' => '

The status of the inference component.

', 'InferenceComponentSummary$InferenceComponentStatus' => '

The status of the inference component.

', 'ListInferenceComponentsInput$StatusEquals' => '

Filters the results to only those inference components with the specified status.

', ], ], 'InferenceComponentSummary' => [ 'base' => '

A summary of the properties of an inference component.

', 'refs' => [ 'InferenceComponentSummaryList$member' => NULL, ], ], 'InferenceComponentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsOutput$InferenceComponents' => '

A list of inference components and their properties that matches any of the filters you specified in the request.

', ], ], 'InferenceExecutionConfig' => [ 'base' => '

Specifies details about how containers in a multi-container endpoint are run.

', 'refs' => [ 'CreateModelInput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'DescribeModelOutput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'Model$InferenceExecutionConfig' => NULL, ], ], 'InferenceExecutionMode' => [ 'base' => NULL, 'refs' => [ 'InferenceExecutionConfig$Mode' => '

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.

  • DIRECT - Only the individual container that you specify is run.

', ], ], 'InferenceExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN for your inference experiment.

', 'DeleteInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the deleted inference experiment.

', 'DescribeInferenceExperimentResponse$Arn' => '

The ARN of the inference experiment being described.

', 'StartInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the started inference experiment to start.

', 'StopInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the stopped inference experiment.

', 'UpdateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the updated inference experiment.

', ], ], 'InferenceExperimentDataStorageConfig' => [ 'base' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'refs' => [ 'CreateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

', 'DescribeInferenceExperimentResponse$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'UpdateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', ], ], 'InferenceExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Description' => '

A description for the inference experiment.

', 'DescribeInferenceExperimentResponse$Description' => '

The description of the inference experiment.

', 'InferenceExperimentSummary$Description' => '

The description of the inference experiment.

', 'UpdateInferenceExperimentRequest$Description' => '

The description of the inference experiment.

', ], ], 'InferenceExperimentList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsResponse$InferenceExperiments' => '

List of inference experiments.

', ], ], 'InferenceExperimentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Name' => '

The name for the inference experiment.

', 'DeleteInferenceExperimentRequest$Name' => '

The name of the inference experiment you want to delete.

', 'DescribeInferenceExperimentRequest$Name' => '

The name of the inference experiment to describe.

', 'DescribeInferenceExperimentResponse$Name' => '

The name of the inference experiment.

', 'InferenceExperimentSummary$Name' => '

The name of the inference experiment.

', 'StartInferenceExperimentRequest$Name' => '

The name of the inference experiment to start.

', 'StopInferenceExperimentRequest$Name' => '

The name of the inference experiment to stop.

', 'UpdateInferenceExperimentRequest$Name' => '

The name of the inference experiment to be updated.

', ], ], 'InferenceExperimentSchedule' => [ 'base' => '

The start and end times of an inference experiment.

The maximum duration that you can set for an inference experiment is 30 days.

', 'refs' => [ 'CreateInferenceExperimentRequest$Schedule' => '

The duration for which you want the inference experiment to run. If you don\'t specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

', 'DescribeInferenceExperimentResponse$Schedule' => '

The duration for which the inference experiment ran or will run.

', 'InferenceExperimentSummary$Schedule' => '

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

', 'UpdateInferenceExperimentRequest$Schedule' => '

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

', ], ], 'InferenceExperimentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$Status' => '

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.

  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

  • Updating - When you make changes to your experiment, your experiment shows as updating.

  • Starting - Amazon SageMaker is beginning your experiment.

  • Running - Your experiment is in progress.

  • Stopping - Amazon SageMaker is stopping your experiment.

  • Completed - Your experiment has completed.

  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

', 'InferenceExperimentSummary$Status' => '

The status of the inference experiment.

', 'ListInferenceExperimentsRequest$StatusEquals' => '

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

', ], ], 'InferenceExperimentStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$StatusReason' => '

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

', 'InferenceExperimentSummary$StatusReason' => '

The error message for the inference experiment status result.

', 'StopInferenceExperimentRequest$Reason' => '

The reason for stopping the experiment.

', ], ], 'InferenceExperimentStopDesiredState' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$DesiredState' => '

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully

  • Cancelled: The experiment was canceled

', ], ], 'InferenceExperimentSummary' => [ 'base' => '

Lists a summary of properties of an inference experiment.

', 'refs' => [ 'InferenceExperimentList$member' => NULL, ], ], 'InferenceExperimentType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Type' => '

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

', 'DescribeInferenceExperimentResponse$Type' => '

The type of the inference experiment.

', 'InferenceExperimentSummary$Type' => '

The type of the inference experiment.

', 'ListInferenceExperimentsRequest$Type' => '

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

', ], ], 'InferenceImage' => [ 'base' => NULL, 'refs' => [ 'DescribeCompilationJobResponse$InferenceImage' => '

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

', ], ], 'InferenceMetrics' => [ 'base' => '

The metrics for an existing endpoint compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$Metrics' => '

The metrics for an existing endpoint.

', 'RecommendationJobInferenceBenchmark$EndpointMetrics' => NULL, ], ], 'InferenceRecommendation' => [ 'base' => '

A list of recommendations made by Amazon SageMaker Inference Recommender.

', 'refs' => [ 'InferenceRecommendations$member' => NULL, ], ], 'InferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$InferenceRecommendations' => '

The recommendations made by Inference Recommender.

', ], ], 'InferenceRecommendationsJob' => [ 'base' => '

A structure that contains a list of recommendation jobs.

', 'refs' => [ 'InferenceRecommendationsJobs$member' => NULL, ], ], 'InferenceRecommendationsJobStep' => [ 'base' => '

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

', 'refs' => [ 'InferenceRecommendationsJobSteps$member' => NULL, ], ], 'InferenceRecommendationsJobSteps' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobStepsResponse$Steps' => '

A list of all subtask details in Inference Recommender.

', ], ], 'InferenceRecommendationsJobs' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs' => '

The recommendations created from the Amazon SageMaker Inference Recommender job.

', ], ], 'InferenceSpecification' => [ 'base' => '

Defines how to perform inference generation after a training job is run.

', 'refs' => [ 'BatchDescribeModelPackageSummary$InferenceSpecification' => NULL, 'CreateAlgorithmInput$InferenceSpecification' => '

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

', 'CreateModelPackageInput$InferenceSpecification' => '

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

', 'DescribeAlgorithmOutput$InferenceSpecification' => '

Details about inference jobs that the algorithm runs.

', 'DescribeModelPackageOutput$InferenceSpecification' => '

Details about inference jobs that you can run with models based on this model package.

', 'ModelPackage$InferenceSpecification' => '

Defines how to perform inference generation after a training job is run.

', 'UpdateModelPackageInput$InferenceSpecification' => '

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

', ], ], 'InferenceSpecificationName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'EndpointInputConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'ModelConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', ], ], 'InfraCheckConfig' => [ 'base' => '

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

', 'refs' => [ 'CreateTrainingJobRequest$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', 'DescribeTrainingJobResponse$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', ], ], 'InitialInstanceCount' => [ 'base' => NULL, 'refs' => [ 'EndpointOutputConfiguration$InitialInstanceCount' => '

The number of instances recommended to launch initially.

', ], ], 'InitialNumberOfUsers' => [ 'base' => NULL, 'refs' => [ 'Phase$InitialNumberOfUsers' => '

Specifies how many concurrent users to start with. The value should be between 1 and 3.

', ], ], 'InitialTaskCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$InitialInstanceCount' => '

Number of instances to launch initially.

', ], ], 'InputConfig' => [ 'base' => '

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'refs' => [ 'CreateCompilationJobRequest$InputConfig' => '

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'DescribeCompilationJobResponse$InputConfig' => '

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', ], ], 'InputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$InputDataConfig' => '

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

Your input must be in the same Amazon Web Services region as your training job.

', 'DescribeTrainingJobResponse$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

', 'HyperParameterTrainingJobDefinition$InputDataConfig' => '

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

', 'TrainingJob$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

Your input must be in the same Amazon Web Services region as your training job.

', 'TrainingJobDefinition$InputDataConfig' => '

An array of Channel objects, each of which specifies an input source.

', ], ], 'InputMode' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$InputMode' => '

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InputModes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedInputModes' => '

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InstanceGroup' => [ 'base' => '

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

', 'refs' => [ 'InstanceGroups$member' => NULL, ], ], 'InstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupName' => '

Specifies the name of the instance group.

', 'InstanceGroupNames$member' => NULL, ], ], 'InstanceGroupNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$InstanceGroupNames' => '

A list of names of instance groups that get data from the S3 data source.

', ], ], 'InstanceGroups' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$InstanceGroups' => '

The configuration of a heterogeneous cluster in JSON format.

', ], ], 'InstanceMetadataServiceConfiguration' => [ 'base' => '

Information on the IMDS configuration of the notebook instance

', 'refs' => [ 'CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$InstanceType' => '

The type of ML compute instance to launch for the notebook instance.

', 'DescribeNotebookInstanceOutput$InstanceType' => '

The type of ML compute instance running on the notebook instance.

', 'NotebookInstanceSummary$InstanceType' => '

The type of ML compute instance that the notebook instance is running on.

', 'RealTimeInferenceConfig$InstanceType' => '

The instance type the model is deployed to.

', 'UpdateNotebookInstanceInput$InstanceType' => '

The Amazon ML compute instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardVersion' => '

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

', 'DescribeDeviceResponse$MaxModels' => '

The maximum number of models.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending' => '

The number of edge devices yet to pick up deployment, or in progress.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'DescribeModelCardExportJobResponse$ModelCardVersion' => '

The version of the model card that the model export job exports.

', 'DescribeModelCardRequest$ModelCardVersion' => '

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

', 'DescribeModelCardResponse$ModelCardVersion' => '

The version of the model card.

', 'DynamicScalingConfiguration$MinCapacity' => '

The recommended minimum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$MaxCapacity' => '

The recommended maximum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleInCooldown' => '

The recommended scale in cooldown time for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleOutCooldown' => '

The recommended scale out cooldown time for your autoscaling policy.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPending' => '

The number of edge devices yet to pick up the deployment, or in progress.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'EdgeDeploymentStatus$EdgeDeploymentSuccessInStage' => '

The number of edge devices with the successful deployment in the current stage.

', 'EdgeDeploymentStatus$EdgeDeploymentPendingInStage' => '

The number of edge devices yet to pick up the deployment in current stage, or in progress.

', 'EdgeDeploymentStatus$EdgeDeploymentFailedInStage' => '

The number of edge devices that failed the deployment in current stage.

', 'HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving' => '

The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.

', 'HyperParameterTuningJobConsumedResources$RuntimeInSeconds' => '

The wall clock runtime in seconds used by your hyperparameter tuning job.

', 'InferenceMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'InferenceMetrics$ModelLatency' => '

The expected model latency at maximum invocations per minute for the instance.

', 'ListModelCardExportJobsRequest$ModelCardVersion' => '

List export jobs for the model card with the specified version.

', 'ModelCard$ModelCardVersion' => '

The version of the model card.

', 'ModelCardExportJobSummary$ModelCardVersion' => '

The version of the model card that the export job exports.

', 'ModelCardVersionSummary$ModelCardVersion' => '

A version of the model card.

', 'ModelDashboardModelCard$ModelCardVersion' => '

The model card version.

', 'ModelLatencyThreshold$ValueInMilliseconds' => '

The model latency percentile value in milliseconds.

', 'PipelineExecutionStep$AttemptCount' => '

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

', 'RecommendationJobStoppingConditions$MaxInvocations' => '

The maximum number of requests per minute expected for the endpoint.

', 'RecommendationMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'RecommendationMetrics$ModelLatency' => '

The expected model latency at maximum invocation per minute for the instance.

', 'ScalingPolicyMetric$InvocationsPerInstance' => '

The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.

', 'ScalingPolicyMetric$ModelLatency' => '

The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', 'ScalingPolicyObjective$MinInvocationsPerMinute' => '

The minimum number of expected requests to your endpoint per minute.

', 'ScalingPolicyObjective$MaxInvocationsPerMinute' => '

The maximum number of expected requests to your endpoint per minute.

', ], ], 'IntegerParameterRange' => [ 'base' => '

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

', 'refs' => [ 'IntegerParameterRanges$member' => NULL, ], ], 'IntegerParameterRangeSpecification' => [ 'base' => '

Defines the possible values for an integer hyperparameter.

', 'refs' => [ 'ParameterRange$IntegerParameterRangeSpecification' => '

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

', ], ], 'IntegerParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$IntegerParameterRanges' => '

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

', ], ], 'InvocationEndTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', 'RecommendationJobInferenceBenchmark$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', ], ], 'InvocationStartTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', 'RecommendationJobInferenceBenchmark$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', ], ], 'InvocationsMaxRetries' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsMaxRetries' => '

The maximum number of retries when invocation requests are failing. The default value is 3.

', ], ], 'InvocationsTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsTimeoutInSeconds' => '

The timeout value in seconds for an invocation request. The default value is 600.

', ], ], 'IotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$IotRoleAlias' => '

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

', ], ], 'ItemIdentifierAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$ItemIdentifierAttributeName' => '

The name of the column that represents the set of item identifiers for which you want to predict the target value.

', ], ], 'JobDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$JobDurationInSeconds' => '

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

', ], ], 'JobReferenceCode' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$JobReferenceCode' => '

A unique identifier for work done as part of a labeling job.

', 'LabelingJobForWorkteamSummary$JobReferenceCode' => '

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

', ], ], 'JobReferenceCodeContains' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains' => '

A filter the limits jobs to only the ones whose job reference code contains the specified string.

', ], ], 'JobType' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'DescribeImageVersionResponse$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'UpdateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', ], ], 'JoinSource' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$JoinSource' => '

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

', ], ], 'JsonContentType' => [ 'base' => NULL, 'refs' => [ 'JsonContentTypes$member' => NULL, ], ], 'JsonContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$JsonContentTypes' => '

The list of all content type headers that SageMaker will treat as JSON and capture accordingly.

', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$InputFilter' => '

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: "$", "$[1:]", "$.features"

', 'DataProcessing$OutputFilter' => '

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren\'t within the dimension size of the joined dataset, you get an error.

Examples: "$", "$[0,5:]", "$[\'id\',\'SageMakerOutput\']"

', ], ], 'JupyterLabAppImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app. The FileSystemConfig object is not supported.

', 'refs' => [ 'AppImageConfigDetails$JupyterLabAppImageConfig' => '

The configuration for the file system and the runtime, such as the environment variables and entry point.

', 'CreateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$JupyterLabAppImageConfig' => '

The configuration of the JupyterLab app.

', 'UpdateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLab app running on the image.

', ], ], 'JupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application.

', 'refs' => [ 'DefaultSpaceSettings$JupyterLabAppSettings' => NULL, 'UserSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'JupyterServerAppSettings' => [ 'base' => '

The JupyterServer app settings.

', 'refs' => [ 'DefaultSpaceSettings$JupyterServerAppSettings' => NULL, 'SpaceSettings$JupyterServerAppSettings' => NULL, 'UserSettings$JupyterServerAppSettings' => '

The Jupyter server\'s app settings.

', ], ], 'KeepAlivePeriodInSeconds' => [ 'base' => 'Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.', 'refs' => [ 'ResourceConfig$KeepAlivePeriodInSeconds' => '

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

', 'ResourceConfigForUpdate$KeepAlivePeriodInSeconds' => '

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

', ], ], 'KendraSettings' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure document querying.

', 'refs' => [ 'CanvasAppSettings$KendraSettings' => '

The settings for document querying.

', ], ], 'KernelDisplayName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$DisplayName' => '

The display name of the kernel.

', ], ], 'KernelGatewayAppSettings' => [ 'base' => '

The KernelGateway app settings.

', 'refs' => [ 'DefaultSpaceSettings$KernelGatewayAppSettings' => NULL, 'SpaceSettings$KernelGatewayAppSettings' => NULL, 'UserSettings$KernelGatewayAppSettings' => '

The kernel gateway app settings.

', ], ], 'KernelGatewayImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

', 'refs' => [ 'AppImageConfigDetails$KernelGatewayImageConfig' => '

The configuration for the file system and kernels in the SageMaker image.

', 'CreateAppImageConfigRequest$KernelGatewayImageConfig' => '

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$KernelGatewayImageConfig' => '

The configuration of a KernelGateway app.

', 'UpdateAppImageConfigRequest$KernelGatewayImageConfig' => '

The new KernelGateway app to run on the image.

', ], ], 'KernelName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$Name' => '

The name of the Jupyter kernel in the image. This value is case sensitive.

', ], ], 'KernelSpec' => [ 'base' => '

The specification of a Jupyter kernel.

', 'refs' => [ 'KernelSpecs$member' => NULL, ], ], 'KernelSpecs' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayImageConfig$KernelSpecs' => '

The specification of the Jupyter kernels in the image.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$ObjectKey' => '

The object key (or key name) uniquely identifies the object in an S3 bucket.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

', 'AthenaDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

', 'AutoMLOutputDataConfig$KmsKeyId' => '

The Key Management Service encryption key ID.

', 'AutoMLSecurityConfig$VolumeKmsKeyId' => '

The key used to encrypt stored data.

', 'BatchDataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'CreateDomainRequest$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'CreateDomainRequest$KmsKeyId' => '

SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

', 'CreateEdgePackagingJobRequest$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

', 'CreateEndpointConfigInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'CreateInferenceExperimentRequest$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS key Alias

    "alias/ExampleAlias"

  • Amazon Resource Name (ARN) of a KMS key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'CreateNotebookInstanceInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

', 'DataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'DataCaptureConfigSummary$KmsKeyId' => '

The KMS key being used to encrypt the data in Amazon S3.

', 'DescribeDomainResponse$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'DescribeDomainResponse$KmsKeyId' => '

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

', 'DescribeEdgePackagingJobResponse$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

', 'DescribeEndpointConfigOutput$KmsKeyId' => '

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'DescribeInferenceExperimentResponse$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

', 'DescribeNotebookInstanceOutput$KmsKeyId' => '

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'EdgeOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account.

', 'FlowDefinitionOutputConfig$KmsKeyId' => '

The Amazon Key Management Service (KMS) key ID for server-side encryption.

', 'HyperParameterTuningResourceConfig$VolumeKmsKeyId' => '

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

"1234abcd-12ab-34cd-56ef-1234567890ab"

Amazon Resource Name (ARN) of a KMS key:

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

', 'InferenceExperimentDataStorageConfig$KmsKey' => '

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

', 'LabelingJobOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role\'s account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

', 'LabelingJobResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'ModelCardSecurityConfig$KmsKeyId' => '

A Key Management Service key ID to use for encrypting a model card.

', 'MonitoringClusterConfig$VolumeKmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

', 'MonitoringOutputConfig$KmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

', 'OnlineStoreSecurityConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • "kms:Encrypt"

  • "kms:Decrypt"

  • "kms:DescribeKey"

  • "kms:CreateGrant"

  • "kms:RetireGrant"

  • "kms:ReEncryptFrom"

  • "kms:ReEncryptTo"

  • "kms:GenerateDataKey"

  • "kms:ListAliases"

  • "kms:ListGrants"

  • "kms:RevokeGrant"

The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • "kms:Decrypt"

', 'OutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'OutputDataConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'ProcessingClusterConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'ProcessingOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

', 'ProductionVariantCoreDumpConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'RecommendationJobInputConfig$VolumeKmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RecommendationJobOutputConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RedshiftDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

', 'ResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'S3StorageConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • "kms:GenerateDataKey"

', 'SharingSettings$S3KmsKeyId' => '

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

', 'TransformOutput$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'TransformResources$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'WorkspaceSettings$S3KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

', ], ], 'LabelAttributeName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelAttributeName' => '

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can\'t end with "-metadata".

  • If you are using one of the following built-in task types, the attribute name must end with "-ref". If the task type you are using is not listed below, the attribute name must not end with "-ref".

    • Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

', 'DescribeLabelingJobResponse$LabelAttributeName' => '

The attribute used as the label in the output manifest file.

', ], ], 'LabelCounter' => [ 'base' => NULL, 'refs' => [ 'LabelCounters$TotalLabeled' => '

The total number of objects labeled.

', 'LabelCounters$HumanLabeled' => '

The total number of objects labeled by a human worker.

', 'LabelCounters$MachineLabeled' => '

The total number of objects labeled by automated data labeling.

', 'LabelCounters$FailedNonRetryableError' => '

The total number of objects that could not be labeled due to an error.

', 'LabelCounters$Unlabeled' => '

The total number of objects not yet labeled.

', 'LabelCountersForWorkteam$HumanLabeled' => '

The total number of data objects labeled by a human worker.

', 'LabelCountersForWorkteam$PendingHuman' => '

The total number of data objects that need to be labeled by a human worker.

', 'LabelCountersForWorkteam$Total' => '

The total number of tasks in the labeling job.

', ], ], 'LabelCounters' => [ 'base' => '

Provides a breakdown of the number of objects labeled.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelCounters' => '

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn\'t be labeled, and the total number of objects labeled.

', 'LabelingJobSummary$LabelCounters' => '

Counts showing the progress of the labeling job.

', ], ], 'LabelCountersForWorkteam' => [ 'base' => '

Provides counts for human-labeled tasks in the labeling job.

', 'refs' => [ 'LabelingJobForWorkteamSummary$LabelCounters' => '

Provides information about the progress of a labeling job.

', ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'base' => NULL, 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn' => '

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

', ], ], 'LabelingJobAlgorithmsConfig' => [ 'base' => '

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

', 'refs' => [ 'CreateLabelingJobRequest$LabelingJobAlgorithmsConfig' => '

Configures the information required to perform automated data labeling.

', 'DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig' => '

Configuration information for automated data labeling.

', ], ], 'LabelingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

', 'DescribeLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'DescribeTrainingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

', 'DescribeTransformJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

', 'LabelingJobSummary$LabelingJobArn' => '

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

', 'TrainingJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'TransformJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

', ], ], 'LabelingJobDataAttributes' => [ 'base' => '

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

', 'refs' => [ 'LabelingJobInputConfig$DataAttributes' => '

Attributes of the data specified by the customer.

', ], ], 'LabelingJobDataSource' => [ 'base' => '

Provides information about the location of input data.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

', 'refs' => [ 'LabelingJobInputConfig$DataSource' => '

The location of the input data.

', ], ], 'LabelingJobForWorkteamSummary' => [ 'base' => '

Provides summary information for a work team.

', 'refs' => [ 'LabelingJobForWorkteamSummaryList$member' => NULL, ], ], 'LabelingJobForWorkteamSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LabelingJobInputConfig' => [ 'base' => '

Input configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$InputConfig' => '

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.

  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

', 'DescribeLabelingJobResponse$InputConfig' => '

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

', 'LabelingJobSummary$InputConfig' => '

Input configuration for the labeling job.

', ], ], 'LabelingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelingJobName' => '

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

', 'DescribeLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to return information for.

', 'DescribeLabelingJobResponse$LabelingJobName' => '

The name assigned to the labeling job when it was created.

', 'LabelingJobForWorkteamSummary$LabelingJobName' => '

The name of the labeling job that the work team is assigned to.

', 'LabelingJobSummary$LabelingJobName' => '

The name of the labeling job.

', 'StopLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to stop.

', ], ], 'LabelingJobOutput' => [ 'base' => '

Specifies the location of the output produced by the labeling job.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', 'LabelingJobSummary$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', ], ], 'LabelingJobOutputConfig' => [ 'base' => '

Output configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$OutputConfig' => '

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', 'DescribeLabelingJobResponse$OutputConfig' => '

The location of the job\'s output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', ], ], 'LabelingJobResourceConfig' => [ 'base' => '

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

', 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobResourceConfig' => '

Provides configuration information for a labeling job.

', ], ], 'LabelingJobS3DataSource' => [ 'base' => '

The Amazon S3 location of the input data objects.

', 'refs' => [ 'LabelingJobDataSource$S3DataSource' => '

The Amazon S3 location of the input data objects.

', ], ], 'LabelingJobSnsDataSource' => [ 'base' => '

An Amazon SNS data source used for streaming labeling jobs.

', 'refs' => [ 'LabelingJobDataSource$SnsDataSource' => '

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

', ], ], 'LabelingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobStatus' => '

The processing status of the labeling job.

', 'LabelingJobSummary$LabelingJobStatus' => '

The current status of the labeling job.

', 'ListLabelingJobsRequest$StatusEquals' => '

A filter that retrieves only labeling jobs with a specific status.

', ], ], 'LabelingJobStoppingConditions' => [ 'base' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Labeling jobs fail after 30 days with an appropriate client error message.

', 'refs' => [ 'CreateLabelingJobRequest$StoppingConditions' => '

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

', 'DescribeLabelingJobResponse$StoppingConditions' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

', ], ], 'LabelingJobSummary' => [ 'base' => '

Provides summary information about a labeling job.

', 'refs' => [ 'LabelingJobSummaryList$member' => NULL, ], ], 'LabelingJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'AnnotationConsolidationConfig$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

', 'HumanTaskConfig$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

', 'LabelingJobSummary$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

', 'LabelingJobSummary$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

', ], ], 'LambdaStepMetadata' => [ 'base' => '

Metadata for a Lambda step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Lambda' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

', ], ], 'LandingUri' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$LandingUri' => '

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

  • studio::relative/path: Directs users to the relative path in Studio.

  • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

  • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

  • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

  • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

  • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

', 'UserSettings$DefaultLandingUri' => '

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$LastModifiedTime' => '

The date and time that the Git repository was last modified.

', 'CompilationJobSummary$LastModifiedTime' => '

The time when the model compilation job was last modified.

', 'DescribeCodeRepositoryOutput$LastModifiedTime' => '

The date and time that the repository was last changed.

', 'DescribeCompilationJobResponse$LastModifiedTime' => '

The time that the status of the model compilation job was last modified.

', 'DescribeDomainResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeFeatureGroupResponse$LastModifiedTime' => '

A timestamp indicating when the feature group was last updated.

', 'DescribeFeatureMetadataResponse$LastModifiedTime' => '

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

', 'DescribeInferenceRecommendationsJobResponse$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'DescribeNotebookInstanceOutput$LastModifiedTime' => '

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

', 'DescribeSpaceResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeUserProfileResponse$LastModifiedTime' => '

The last modified time.

', 'DomainDetails$LastModifiedTime' => '

The last modified time.

', 'FeatureGroup$LastModifiedTime' => '

A timestamp indicating the last time you updated the feature group.

', 'FeatureMetadata$LastModifiedTime' => '

A timestamp indicating when the feature was last modified.

', 'InferenceRecommendationsJob$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'ListCompilationJobsRequest$LastModifiedTimeAfter' => '

A filter that returns the model compilation jobs that were modified after a specified time.

', 'ListCompilationJobsRequest$LastModifiedTimeBefore' => '

A filter that returns the model compilation jobs that were modified before a specified time.

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs that were last modified after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs that were last modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore' => '

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter' => '

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeBefore' => '

A filter that returns only notebook instances that were modified before the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeAfter' => '

A filter that returns only notebook instances that were modified after the specified time (timestamp).

', 'NotebookInstanceLifecycleConfigSummary$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'NotebookInstanceSummary$LastModifiedTime' => '

A timestamp that shows when the notebook instance was last modified.

', 'SpaceDetails$LastModifiedTime' => '

The last modified time.

', 'UserProfileDetails$LastModifiedTime' => '

The last modified time.

', ], ], 'LastUpdateStatus' => [ 'base' => '

A value that indicates whether the update was successful.

', 'refs' => [ 'DescribeFeatureGroupResponse$LastUpdateStatus' => '

A value indicating whether the update made to the feature group was successful.

', 'FeatureGroup$LastUpdateStatus' => '

A value that indicates whether the feature group was updated successfully.

', ], ], 'LastUpdateStatusValue' => [ 'base' => NULL, 'refs' => [ 'LastUpdateStatus$Status' => '

A value that indicates whether the update was made successful.

', ], ], 'LifecycleConfigArns' => [ 'base' => NULL, 'refs' => [ 'CodeEditorAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

', 'JupyterLabAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

', 'JupyterServerAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', 'KernelGatewayAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', ], ], 'LineageEntityParameters' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Properties' => '

A list of properties to add to the action.

', 'CreateContextRequest$Properties' => '

A list of properties to add to the context.

', 'DescribeActionResponse$Properties' => '

A list of the action\'s properties.

', 'DescribeArtifactResponse$Properties' => '

A list of the artifact\'s properties.

', 'DescribeContextResponse$Properties' => '

A list of the context\'s properties.

', 'UpdateActionRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', 'UpdateContextRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'LineageGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeArtifactResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeContextResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeTrialComponentResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'GetLineageGroupPolicyResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', 'TrialComponent$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', ], ], 'LineageGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyRequest$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', ], ], 'LineageGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsResponse$LineageGroupSummaries' => '

A list of lineage groups and their properties.

', ], ], 'LineageGroupSummary' => [ 'base' => '

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

', 'refs' => [ 'LineageGroupSummaries$member' => NULL, ], ], 'LineageType' => [ 'base' => NULL, 'refs' => [ 'QueryLineageTypes$member' => NULL, 'Vertex$LineageType' => '

The type of resource of the lineage entity.

', ], ], 'ListActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsRequest$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ListContextsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContextsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$SortBy' => '

The column to sort by.

', ], ], 'ListDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansRequest$SortBy' => '

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

', ], ], 'ListEdgePackagingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsRequest$SortBy' => '

Use to specify what column to sort by.

', ], ], 'ListEndpointConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsRequest$SortBy' => '

The parameter by which to sort the results.

', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ListLabelingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageEntityParameterKey' => [ 'base' => NULL, 'refs' => [ 'UpdateActionRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateArtifactRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateContextRequest$PropertiesToRemove' => '

A list of properties to remove.

', ], ], 'ListLineageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListDevicesRequest$MaxResults' => '

Maximum number of results to select.

', 'ListEdgeDeploymentPlansRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', 'ListEdgePackagingJobsRequest$MaxResults' => '

Maximum number of results to select.

', 'ListStageDevicesRequest$MaxResults' => '

The maximum number of requests to select.

', ], ], 'ListModelBiasJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelBiasJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsInput$MaxResults' => '

Maximum number of tags to return.

', ], ], 'ListTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'UpdateTrialComponentRequest$ParametersToRemove' => '

The hyperparameters to remove from the component.

', 'UpdateTrialComponentRequest$InputArtifactsToRemove' => '

The input artifacts to remove from the component.

', 'UpdateTrialComponentRequest$OutputArtifactsToRemove' => '

The output artifacts to remove from the component.

', ], ], 'ListTrialComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesRequest$SortBy' => '

Sort workforces using the workforce name or creation date.

', ], ], 'ListWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$AgentCount' => '

The number of Edge Manager agents.

', 'DeviceStats$ConnectedDeviceCount' => '

The number of devices connected with a heartbeat.

', 'DeviceStats$RegisteredDeviceCount' => '

The number of registered devices.

', 'EdgeModelStat$OfflineDeviceCount' => '

The number of devices that have this model version and do not have a heart beat.

', 'EdgeModelStat$ConnectedDeviceCount' => '

The number of devices that have this model version and have a heart beat.

', 'EdgeModelStat$ActiveDeviceCount' => '

The number of devices that have this model version, a heart beat, and are currently running.

', 'EdgeModelStat$SamplingDeviceCount' => '

The number of devices with this model version and are producing sample data.

', ], ], 'MLFramework' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', 'DescribeImageVersionResponse$MLFramework' => '

The machine learning framework vended in the image version.

', 'UpdateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', ], ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MaxInstanceCount' => '

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

', ], ], 'ManagedInstanceScalingMinInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MinInstanceCount' => '

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

', ], ], 'ManagedInstanceScalingStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$Status' => '

Indicates whether managed instance scaling is enabled.

', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds' => '

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

', ], ], 'MaxCandidates' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxCandidates' => '

The maximum number of times a training job is allowed to run.

For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

', ], ], 'MaxConcurrentInvocationsPerInstance' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance' => '

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

', ], ], 'MaxConcurrentTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$MaxConcurrentTaskCount' => '

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

', ], ], 'MaxConcurrentTransforms' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'DescribeTransformJobResponse$MaxConcurrentTransforms' => '

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

', 'TransformJob$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'TransformJobDefinition$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

', ], ], 'MaxHumanLabeledObjectCount' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxHumanLabeledObjectCount' => '

The maximum number of objects that can be labeled by human workers.

', ], ], 'MaxNumberOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxNumberOfTests' => '

Defines the maximum number of load tests.

', ], ], 'MaxNumberOfTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxNumberOfTrainingJobs' => '

The maximum number of training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'base' => NULL, 'refs' => [ 'BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving' => '

The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.

', ], ], 'MaxParallelExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$MaxParallelExecutionSteps' => '

The max number of steps that can be executed in parallel.

', ], ], 'MaxParallelOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxParallelOfTests' => '

Defines the maximum number of parallel load tests.

', ], ], 'MaxParallelTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxParallelTrainingJobs' => '

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'DescribeTransformJobResponse$MaxPayloadInMB' => '

The maximum payload size, in MB, used in the transform job.

', 'TransformJob$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'TransformJobDefinition$MaxPayloadInMB' => '

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

', ], ], 'MaxPendingTimeInSeconds' => [ 'base' => 'Maximum job scheduler pending time in seconds.', 'refs' => [ 'StoppingCondition$MaxPendingTimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

', ], ], 'MaxPercentageOfInputDatasetLabeled' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled' => '

The maximum number of input data objects that should be labeled.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$MaxResults' => '

The maximum number of actions to return in the response. The default value is 10.

', 'ListAlgorithmsInput$MaxResults' => '

The maximum number of algorithms to return in the response.

', 'ListAliasesRequest$MaxResults' => '

The maximum number of aliases to return.

', 'ListAppImageConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListAppsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListArtifactsRequest$MaxResults' => '

The maximum number of artifacts to return in the response. The default value is 10.

', 'ListAssociationsRequest$MaxResults' => '

The maximum number of associations to return in the response. The default value is 10.

', 'ListClusterNodesRequest$MaxResults' => '

The maximum number of nodes to return in the response.

', 'ListClustersRequest$MaxResults' => '

Set the maximum number of SageMaker HyperPod clusters to list.

', 'ListCodeRepositoriesInput$MaxResults' => '

The maximum number of Git repositories to return in the response.

', 'ListCompilationJobsRequest$MaxResults' => '

The maximum number of model compilation jobs to return in the response.

', 'ListContextsRequest$MaxResults' => '

The maximum number of contexts to return in the response. The default value is 10.

', 'ListDataQualityJobDefinitionsRequest$MaxResults' => '

The maximum number of data quality monitoring job definitions to return in the response.

', 'ListDomainsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListEndpointConfigsInput$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListEndpointsInput$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListExperimentsRequest$MaxResults' => '

The maximum number of experiments to return in the response. The default value is 10.

', 'ListFlowDefinitionsRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHubContentVersionsRequest$MaxResults' => '

The maximum number of hub content versions to list.

', 'ListHubContentsRequest$MaxResults' => '

The maximum amount of hub content to list.

', 'ListHubsRequest$MaxResults' => '

The maximum number of hubs to list.

', 'ListHumanTaskUisRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHyperParameterTuningJobsRequest$MaxResults' => '

The maximum number of tuning jobs to return. The default value is 10.

', 'ListImageVersionsRequest$MaxResults' => '

The maximum number of versions to return in the response. The default value is 10.

', 'ListImagesRequest$MaxResults' => '

The maximum number of images to return in the response. The default value is 10.

', 'ListInferenceComponentsInput$MaxResults' => '

The maximum number of inference components to return in the response. This value defaults to 10.

', 'ListInferenceExperimentsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListInferenceRecommendationsJobStepsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListInferenceRecommendationsJobsRequest$MaxResults' => '

The maximum number of recommendations to return in the response.

', 'ListLabelingJobsForWorkteamRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLabelingJobsRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLineageGroupsRequest$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListModelBiasJobDefinitionsRequest$MaxResults' => '

The maximum number of model bias jobs to return in the response. The default value is 10.

', 'ListModelCardExportJobsRequest$MaxResults' => '

The maximum number of model card export jobs to list.

', 'ListModelCardVersionsRequest$MaxResults' => '

The maximum number of model card versions to list.

', 'ListModelCardsRequest$MaxResults' => '

The maximum number of model cards to list.

', 'ListModelExplainabilityJobDefinitionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListModelMetadataRequest$MaxResults' => '

The maximum number of models to return in the response.

', 'ListModelPackageGroupsInput$MaxResults' => '

The maximum number of results to return in the response.

', 'ListModelPackagesInput$MaxResults' => '

The maximum number of model packages to return in the response.

', 'ListModelQualityJobDefinitionsRequest$MaxResults' => '

The maximum number of results to return in a call to ListModelQualityJobDefinitions.

', 'ListModelsInput$MaxResults' => '

The maximum number of models to return in the response.

', 'ListMonitoringAlertHistoryRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringAlertsRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringExecutionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListMonitoringSchedulesRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListNotebookInstanceLifecycleConfigsInput$MaxResults' => '

The maximum number of lifecycle configurations to return in the response.

', 'ListNotebookInstancesInput$MaxResults' => '

The maximum number of notebook instances to return.

', 'ListPipelineExecutionStepsRequest$MaxResults' => '

The maximum number of pipeline execution steps to return in the response.

', 'ListPipelineExecutionsRequest$MaxResults' => '

The maximum number of pipeline executions to return in the response.

', 'ListPipelineParametersForExecutionRequest$MaxResults' => '

The maximum number of parameters to return in the response.

', 'ListPipelinesRequest$MaxResults' => '

The maximum number of pipelines to return in the response.

', 'ListProcessingJobsRequest$MaxResults' => '

The maximum number of processing jobs to return in the response.

', 'ListProjectsInput$MaxResults' => '

The maximum number of projects to return in the response.

', 'ListResourceCatalogsRequest$MaxResults' => '

The maximum number of results returned by ListResourceCatalogs.

', 'ListSpacesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListStudioLifecycleConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListSubscribedWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults' => '

The maximum number of training jobs to return. The default value is 10.

', 'ListTrainingJobsRequest$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListTransformJobsRequest$MaxResults' => '

The maximum number of transform jobs to return in the response. The default value is 10.

', 'ListTrialComponentsRequest$MaxResults' => '

The maximum number of components to return in the response. The default value is 10.

', 'ListTrialsRequest$MaxResults' => '

The maximum number of trials to return in the response. The default value is 10.

', 'ListUserProfilesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListWorkforcesRequest$MaxResults' => '

The maximum number of workforces returned in the response.

', 'ListWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'SearchRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'MaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxRuntimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

', ], ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds' => '

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

', ], ], 'MaxWaitTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxWaitTimeInSeconds' => '

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

', ], ], 'MaximumExecutionTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

', 'RollingUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

The time limit for the total deployment. Exceeding this limit causes a timeout.

', ], ], 'MaximumRetryAttempts' => [ 'base' => NULL, 'refs' => [ 'RetryStrategy$MaximumRetryAttempts' => '

The number of times to retry the job. When the job is retried, it\'s SecondaryStatus is changed to STARTING.

', ], ], 'MediaType' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$MediaType' => '

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

', ], ], 'MemberDefinition' => [ 'base' => '

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

', 'refs' => [ 'MemberDefinitions$member' => NULL, ], ], 'MemberDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

', 'UpdateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

', 'Workteam$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

', ], ], 'MemoryInMb' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$MinMemoryRequiredInMb' => '

The minimum MB of memory to allocate to run a model that you assign to an inference component.

', 'InferenceComponentComputeResourceRequirements$MaxMemoryRequiredInMb' => '

The maximum MB of memory to allocate to run a model that you assign to an inference component.

', ], ], 'MetadataProperties' => [ 'base' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'refs' => [ 'CreateActionRequest$MetadataProperties' => NULL, 'CreateArtifactRequest$MetadataProperties' => NULL, 'CreateModelPackageInput$MetadataProperties' => NULL, 'CreateTrialComponentRequest$MetadataProperties' => NULL, 'CreateTrialRequest$MetadataProperties' => NULL, 'DescribeActionResponse$MetadataProperties' => NULL, 'DescribeArtifactResponse$MetadataProperties' => NULL, 'DescribeModelPackageOutput$MetadataProperties' => NULL, 'DescribeTrialComponentResponse$MetadataProperties' => NULL, 'DescribeTrialResponse$MetadataProperties' => NULL, 'ModelPackage$MetadataProperties' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'Trial$MetadataProperties' => NULL, 'TrialComponent$MetadataProperties' => NULL, ], ], 'MetadataPropertyValue' => [ 'base' => NULL, 'refs' => [ 'MetadataProperties$CommitId' => '

The commit ID.

', 'MetadataProperties$Repository' => '

The repository.

', 'MetadataProperties$GeneratedBy' => '

The entity this entity was generated by.

', 'MetadataProperties$ProjectId' => '

The project ID.

', ], ], 'MetricData' => [ 'base' => '

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

', 'refs' => [ 'FinalMetricDataList$member' => NULL, ], ], 'MetricDataList' => [ 'base' => NULL, 'refs' => [ 'CandidateProperties$CandidateMetrics' => '

Information about the candidate metrics for an AutoML job.

', ], ], 'MetricDatum' => [ 'base' => '

Information about the metric for a candidate produced by an AutoML job.

', 'refs' => [ 'MetricDataList$member' => NULL, ], ], 'MetricDefinition' => [ 'base' => '

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

', 'refs' => [ 'MetricDefinitionList$member' => NULL, ], ], 'MetricDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$MetricDefinitions' => '

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

', 'HyperParameterAlgorithmSpecification$MetricDefinitions' => '

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

', 'TrainingSpecification$MetricDefinitions' => '

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$MetricName' => '

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

', 'HyperParameterTuningJobObjective$MetricName' => '

The name of the metric to use for the objective metric.

', 'MetricData$MetricName' => '

The name of the metric.

', 'MetricDefinition$Name' => '

The name of the metric.

', 'TrialComponentMetricSummary$MetricName' => '

The name of the metric.

', ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'MetricDefinition$Regex' => '

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

', ], ], 'MetricSetSource' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$Set' => '

The dataset split from which the AutoML job produced the metric.

', ], ], 'MetricSpecification' => [ 'base' => '

An object containing information about a metric.

', 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$MetricSpecification' => '

An object containing information about a metric.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Value' => '

The value of the metric with the best result.

', 'FinalHyperParameterTuningJobObjectiveMetric$Value' => '

The value of the objective metric.

', ], ], 'MetricsSource' => [ 'base' => '

Details about the metrics source.

', 'refs' => [ 'Bias$Report' => '

The bias report for a model

', 'Bias$PreTrainingReport' => '

The pre-training bias report for a model.

', 'Bias$PostTrainingReport' => '

The post-training bias report for a model.

', 'DriftCheckBias$PreTrainingConstraints' => '

The pre-training constraints.

', 'DriftCheckBias$PostTrainingConstraints' => '

The post-training constraints.

', 'DriftCheckExplainability$Constraints' => '

The drift check explainability constraints.

', 'DriftCheckModelDataQuality$Statistics' => '

The drift check model data quality statistics.

', 'DriftCheckModelDataQuality$Constraints' => '

The drift check model data quality constraints.

', 'DriftCheckModelQuality$Statistics' => '

The drift check model quality statistics.

', 'DriftCheckModelQuality$Constraints' => '

The drift check model quality constraints.

', 'Explainability$Report' => '

The explainability report for a model.

', 'ModelDataQuality$Statistics' => '

Data quality statistics for a model.

', 'ModelDataQuality$Constraints' => '

Data quality constraints for a model.

', 'ModelQuality$Statistics' => '

Model quality statistics.

', 'ModelQuality$Constraints' => '

Model quality constraints.

', ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion' => '

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

', ], ], 'Model' => [ 'base' => '

The properties of a model as returned by the Search API.

', 'refs' => [ 'ModelDashboardModel$Model' => '

A model displayed in the Model Dashboard.

', ], ], 'ModelAccessConfig' => [ 'base' => '

The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.

', 'refs' => [ 'S3ModelDataSource$ModelAccessConfig' => '

Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', 'TextGenerationJobConfig$ModelAccessConfig' => NULL, ], ], 'ModelApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model.

', 'CreateModelPackageInput$ModelApprovalStatus' => '

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

', 'DescribeModelPackageOutput$ModelApprovalStatus' => '

The approval status of the model package.

', 'ListModelPackagesInput$ModelApprovalStatus' => '

A filter that returns only the model packages with the specified approval status.

', 'ModelPackage$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'ModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'UpdateModelPackageInput$ModelApprovalStatus' => '

The approval status of the model.

', ], ], 'ModelArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelOutput$ModelArn' => '

The ARN of the model created in SageMaker.

', 'DescribeModelOutput$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn' => '

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

', 'LabelingJobOutput$FinalActiveLearningModelArn' => '

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

', 'Model$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'ModelSummary$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelArtifacts' => [ 'base' => '

Provides information about the location that is configured for storing model artifacts.

Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the /opt/ml/model directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelArtifacts' => '

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

', 'DescribeTrainingJobResponse$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', 'TrainingJob$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', ], ], 'ModelBiasAppSpecification' => [ 'base' => '

Docker container image configuration object for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', ], ], 'ModelBiasBaselineConfig' => [ 'base' => '

The configuration for a baseline model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', ], ], 'ModelBiasJobInput' => [ 'base' => '

Inputs for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasJobInput' => '

Inputs for the model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput' => '

Inputs for the model bias job.

', ], ], 'ModelCacheSetting' => [ 'base' => NULL, 'refs' => [ 'MultiModelConfig$ModelCacheSetting' => '

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

', ], ], 'ModelCard' => [ 'base' => '

An Amazon SageMaker Model Card.

', 'refs' => [ 'SearchRecord$ModelCard' => '

An Amazon SageMaker Model Card that documents details about a machine learning model.

', ], ], 'ModelCardArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the successfully created model card.

', 'DescribeModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardVersionSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelDashboardModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) for a model card.

', 'UpdateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the updated model card.

', ], ], 'ModelCardContent' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$Content' => '

The content of the model card. Content must be in model card JSON schema and provided as a string.

', 'DescribeModelCardResponse$Content' => '

The content of the model card.

', 'ModelCard$Content' => '

The content of the model card. Content uses the model card JSON schema and provided as a string.

', 'UpdateModelCardRequest$Content' => '

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

', ], ], 'ModelCardExportArtifacts' => [ 'base' => '

The artifacts of the model card export job.

', 'refs' => [ 'DescribeModelCardExportJobResponse$ExportArtifacts' => '

The exported model card artifacts.

', ], ], 'ModelCardExportJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'DescribeModelCardExportJobRequest$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'ModelCardExportJobSummary$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', ], ], 'ModelCardExportJobSortBy' => [ 'base' => 'Attribute by which to sort returned export jobs.', 'refs' => [ 'ListModelCardExportJobsRequest$SortBy' => '

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardExportJobSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsRequest$SortOrder' => '

Sort model card export jobs by ascending or descending order.

', ], ], 'ModelCardExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardExportJobResponse$Status' => '

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.

  • Completed: The model card export job is complete.

  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

', 'ListModelCardExportJobsRequest$StatusEquals' => '

Only list model card export jobs with the specified status.

', 'ModelCardExportJobSummary$Status' => '

The completion status of the model card export job.

', ], ], 'ModelCardExportJobSummary' => [ 'base' => '

The summary of the Amazon SageMaker Model Card export job.

', 'refs' => [ 'ModelCardExportJobSummaryList$member' => NULL, ], ], 'ModelCardExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsResponse$ModelCardExportJobSummaries' => '

The summaries of the listed model card export jobs.

', ], ], 'ModelCardExportOutputConfig' => [ 'base' => '

Configure the export output details for an Amazon SageMaker Model Card.

', 'refs' => [ 'CreateModelCardExportJobRequest$OutputConfig' => '

The model card output configuration that specifies the Amazon S3 path for exporting.

', 'DescribeModelCardExportJobResponse$OutputConfig' => '

The export output details for the model card.

', ], ], 'ModelCardNameOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to export.

', 'DescribeModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to describe.

', 'ListModelCardVersionsRequest$ModelCardName' => '

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

', 'UpdateModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to update.

', ], ], 'ModelCardProcessingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardResponse$ModelCardProcessingStatus' => '

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

', ], ], 'ModelCardSecurityConfig' => [ 'base' => '

Configure the security settings to protect model card data.

', 'refs' => [ 'CreateModelCardRequest$SecurityConfig' => '

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

', 'DescribeModelCardResponse$SecurityConfig' => '

The security configuration used to protect model card content.

', 'ModelCard$SecurityConfig' => '

The security configuration used to protect model card data.

', 'ModelDashboardModelCard$SecurityConfig' => '

The KMS Key ID (KMSKeyId) for encryption of model card information.

', ], ], 'ModelCardSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsRequest$SortBy' => '

Sort model cards by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortOrder' => '

Sort model card versions by ascending or descending order.

', 'ListModelCardsRequest$SortOrder' => '

Sort model cards by ascending or descending order.

', ], ], 'ModelCardStatus' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'DescribeModelCardResponse$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ListModelCardVersionsRequest$ModelCardStatus' => '

Only list model card versions with the specified approval status.

', 'ListModelCardsRequest$ModelCardStatus' => '

Only list model cards with the specified approval status.

', 'ModelCard$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardSummary$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardVersionSummary$ModelCardStatus' => '

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelDashboardModelCard$ModelCardStatus' => '

The model card status.

', 'UpdateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', ], ], 'ModelCardSummary' => [ 'base' => '

A summary of the model card.

', 'refs' => [ 'ModelCardSummaryList$member' => NULL, ], ], 'ModelCardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsResponse$ModelCardSummaries' => '

The summaries of the listed model cards.

', ], ], 'ModelCardVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortBy' => '

Sort listed model card versions by version. Sorts by version by default.

', ], ], 'ModelCardVersionSummary' => [ 'base' => '

A summary of a specific version of the model card.

', 'refs' => [ 'ModelCardVersionSummaryList$member' => NULL, ], ], 'ModelCardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsResponse$ModelCardVersionSummaryList' => '

The summaries of the listed versions of the model card.

', ], ], 'ModelClientConfig' => [ 'base' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'refs' => [ 'CreateTransformJobRequest$ModelClientConfig' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'DescribeTransformJobResponse$ModelClientConfig' => '

The timeout and maximum number of retries for processing a transform job invocation.

', 'TransformJob$ModelClientConfig' => NULL, ], ], 'ModelCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$CompressionType' => '

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

  • If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.

  • If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.

  • Do not use any of the following as file names or directory names:

    • An empty or blank string

    • A string which contains null bytes

    • A string longer than 255 bytes

    • A single dot (.)

    • A double dot (..)

  • Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).

  • Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

', ], ], 'ModelConfiguration' => [ 'base' => '

Defines the model configuration. Includes the specification name and environment parameters.

', 'refs' => [ 'InferenceRecommendation$ModelConfiguration' => '

Defines the model configuration.

', 'RecommendationJobInferenceBenchmark$ModelConfiguration' => NULL, ], ], 'ModelDashboardEndpoint' => [ 'base' => '

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardEndpoints$member' => NULL, ], ], 'ModelDashboardEndpoints' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$Endpoints' => '

The endpoints that host a model.

', ], ], 'ModelDashboardIndicatorAction' => [ 'base' => '

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

', 'refs' => [ 'MonitoringAlertActions$ModelDashboardIndicator' => '

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

', ], ], 'ModelDashboardModel' => [ 'base' => '

A model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'SearchRecord$Model' => NULL, ], ], 'ModelDashboardModelCard' => [ 'base' => '

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardModel$ModelCard' => '

The model card for a model.

', ], ], 'ModelDashboardMonitoringSchedule' => [ 'base' => '

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardMonitoringSchedules$member' => NULL, ], ], 'ModelDashboardMonitoringSchedules' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$MonitoringSchedules' => '

The monitoring schedules for a model.

', ], ], 'ModelDataQuality' => [ 'base' => '

Data quality constraints and statistics for a model.

', 'refs' => [ 'ModelMetrics$ModelDataQuality' => '

Metrics that measure the quality of the input data for a model.

', ], ], 'ModelDataSource' => [ 'base' => '

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

', 'refs' => [ 'ContainerDefinition$ModelDataSource' => '

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

', 'ModelPackageContainerDefinition$ModelDataSource' => '

Specifies the location of ML model data to deploy during endpoint creation.

', 'SourceAlgorithm$ModelDataSource' => '

Specifies the location of ML model data to deploy during endpoint creation.

', ], ], 'ModelDeployConfig' => [ 'base' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'refs' => [ 'CreateAutoMLJobRequest$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'CreateAutoMLJobV2Request$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'DescribeAutoMLJobResponse$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', 'DescribeAutoMLJobV2Response$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', ], ], 'ModelDeployResult' => [ 'base' => '

Provides information about the endpoint of the model deployment.

', 'refs' => [ 'DescribeAutoMLJobResponse$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', 'DescribeAutoMLJobV2Response$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', ], ], 'ModelDigests' => [ 'base' => '

Provides information to verify the integrity of stored model artifacts.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelDigests' => '

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

', ], ], 'ModelExplainabilityAppSpecification' => [ 'base' => '

Docker container image configuration object for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', ], ], 'ModelExplainabilityBaselineConfig' => [ 'base' => '

The configuration for a baseline model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', ], ], 'ModelExplainabilityJobInput' => [ 'base' => '

Inputs for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', ], ], 'ModelInfrastructureConfig' => [ 'base' => '

The configuration for the infrastructure that the model will be deployed to.

', 'refs' => [ 'ModelVariantConfig$InfrastructureConfig' => '

The configuration for the infrastructure that the model will be deployed to.

', 'ModelVariantConfigSummary$InfrastructureConfig' => '

The configuration of the infrastructure that the model has been deployed to.

', ], ], 'ModelInfrastructureType' => [ 'base' => NULL, 'refs' => [ 'ModelInfrastructureConfig$InfrastructureType' => '

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

', ], ], 'ModelInput' => [ 'base' => '

Input object for the model.

', 'refs' => [ 'ModelPackageContainerDefinition$ModelInput' => '

A structure with Model Input details.

', ], ], 'ModelInsightsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$ModelInsights' => '

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

', ], ], 'ModelLatencyThreshold' => [ 'base' => '

The model latency threshold.

', 'refs' => [ 'ModelLatencyThresholds$member' => NULL, ], ], 'ModelLatencyThresholds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$ModelLatencyThresholds' => '

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', ], ], 'ModelMetadataFilter' => [ 'base' => '

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

', 'refs' => [ 'ModelMetadataFilters$member' => NULL, ], ], 'ModelMetadataFilterType' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataFilter$Name' => '

The name of the of the model to filter by.

', ], ], 'ModelMetadataFilters' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataSearchExpression$Filters' => '

A list of filter objects.

', ], ], 'ModelMetadataSearchExpression' => [ 'base' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results

', 'refs' => [ 'ListModelMetadataRequest$SearchExpression' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

', ], ], 'ModelMetadataSummaries' => [ 'base' => NULL, 'refs' => [ 'ListModelMetadataResponse$ModelMetadataSummaries' => '

A structure that holds model metadata.

', ], ], 'ModelMetadataSummary' => [ 'base' => '

A summary of the model metadata.

', 'refs' => [ 'ModelMetadataSummaries$member' => NULL, ], ], 'ModelMetrics' => [ 'base' => '

Contains metrics captured from a model.

', 'refs' => [ 'CreateModelPackageInput$ModelMetrics' => '

A structure that contains model metrics reports.

', 'DescribeModelPackageOutput$ModelMetrics' => '

Metrics for the model.

', 'ModelPackage$ModelMetrics' => '

Metrics for the model.

', ], ], 'ModelName' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$ModelName' => '

The name of the new model.

', 'CreateTransformJobRequest$ModelName' => '

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

', 'DeleteModelInput$ModelName' => '

The name of the model to delete.

', 'DescribeModelInput$ModelName' => '

The name of the model.

', 'DescribeModelOutput$ModelName' => '

Name of the SageMaker model.

', 'DescribeTransformJobResponse$ModelName' => '

The name of the model used in the transform job.

', 'InferenceComponentSpecification$ModelName' => '

The name of an existing SageMaker model object in your account that you want to deploy with the inference component.

', 'InferenceComponentSpecificationSummary$ModelName' => '

The name of the SageMaker model object that is deployed with the inference component.

', 'InferenceRecommendationsJob$ModelName' => '

The name of the created model.

', 'ListInferenceRecommendationsJobsRequest$ModelNameEquals' => '

A filter that returns only jobs that were created for this model.

', 'Model$ModelName' => '

The name of the model.

', 'ModelSummary$ModelName' => '

The name of the model that you want a summary for.

', 'ModelVariantConfig$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ModelVariantConfigSummary$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ProductionVariant$ModelName' => '

The name of the model that you want to host. This is the name that you specified when creating the model.

', 'RecommendationJobInputConfig$ModelName' => '

The name of the created model.

', 'TransformJob$ModelName' => '

The name of the model associated with the transform job.

', ], ], 'ModelNameContains' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$NameContains' => '

A string in the model name. This filter returns only models whose name contains the specified string.

', ], ], 'ModelPackage' => [ 'base' => '

A versioned model that can be deployed for SageMaker inference.

', 'refs' => [ 'SearchRecord$ModelPackage' => NULL, ], ], 'ModelPackageArn' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageErrorMap$key' => NULL, 'BatchDescribeModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'CreateCompilationJobRequest$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

', 'CreateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the new model package.

', 'DescribeCompilationJobResponse$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

', 'DescribeModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'InferenceRecommendationsJob$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals' => '

A filter that returns only jobs that were created for this versioned model package.

', 'ModelPackage$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'ModelPackageArnList$member' => NULL, 'ModelPackageSummaries$key' => NULL, 'ModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'RecommendationJobInputConfig$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'UpdateModelPackageInput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'UpdateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelPackageArnList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageInput$ModelPackageArnList' => '

The list of Amazon Resource Name (ARN) of the model package groups.

', ], ], 'ModelPackageContainerDefinition' => [ 'base' => '

Describes the Docker container for the model package.

', 'refs' => [ 'ModelPackageContainerDefinitionList$member' => NULL, ], ], 'ModelPackageContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', 'InferenceSpecification$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', ], ], 'ModelPackageFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$FrameworkVersion' => '

The framework version of the Model Package Container Image.

', ], ], 'ModelPackageGroup' => [ 'base' => '

A group of versioned models in the model registry.

', 'refs' => [ 'SearchRecord$ModelPackageGroup' => NULL, ], ], 'ModelPackageGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroup$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'PutModelPackageGroupPolicyOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model package group.

', ], ], 'ModelPackageGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ModelPackageGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageGroupOutput$ModelPackageGroupStatus' => '

The status of the model group.

', 'ModelPackageGroup$ModelPackageGroupStatus' => '

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.

  • IN_PROGRESS - The model group is in the process of being created.

  • COMPLETED - The model group was successfully created.

  • FAILED - The model group failed.

  • DELETING - The model group is in the process of being deleted.

  • DELETE_FAILED - SageMaker failed to delete the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupStatus' => '

The status of the model group.

', ], ], 'ModelPackageGroupSummary' => [ 'base' => '

Summary information about a model group.

', 'refs' => [ 'ModelPackageGroupSummaryList$member' => NULL, ], ], 'ModelPackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsOutput$ModelPackageGroupSummaryList' => '

A list of summaries of the model groups in your Amazon Web Services account.

', ], ], 'ModelPackageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'ModelPackageSourceUri' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$SourceUri' => '

The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.

', 'DescribeModelPackageOutput$SourceUri' => '

The URI of the source for the model package.

', 'ModelPackage$SourceUri' => '

The URI of the source for the model package.

', 'UpdateModelPackageInput$SourceUri' => '

The URI of the source for the model package.

', ], ], 'ModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageStatus' => '

The status of the mortgage package.

', 'DescribeModelPackageOutput$ModelPackageStatus' => '

The current status of the model package.

', 'ModelPackage$ModelPackageStatus' => '

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

', 'ModelPackageSummary$ModelPackageStatus' => '

The overall status of the model package.

', ], ], 'ModelPackageStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the model package.

', 'refs' => [ 'DescribeModelPackageOutput$ModelPackageStatusDetails' => '

Details about the current status of the model package.

', 'ModelPackage$ModelPackageStatusDetails' => '

Specifies the validation and image scan statuses of the model package.

', ], ], 'ModelPackageStatusItem' => [ 'base' => '

Represents the overall status of a model package.

', 'refs' => [ 'ModelPackageStatusItemList$member' => NULL, ], ], 'ModelPackageStatusItemList' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusDetails$ValidationStatuses' => '

The validation status of the model package.

', 'ModelPackageStatusDetails$ImageScanStatuses' => '

The status of the scan of the Docker image container for the model package.

', ], ], 'ModelPackageSummaries' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$ModelPackageSummaries' => '

The summaries for the model package versions

', ], ], 'ModelPackageSummary' => [ 'base' => '

Provides summary information about a model package.

', 'refs' => [ 'ModelPackageSummaryList$member' => NULL, ], ], 'ModelPackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesOutput$ModelPackageSummaryList' => '

An array of ModelPackageSummary objects, each of which lists a model package.

', ], ], 'ModelPackageType' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$ModelPackageType' => '

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

', ], ], 'ModelPackageValidationProfile' => [ 'base' => '

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'ModelPackageValidationProfiles$member' => NULL, ], ], 'ModelPackageValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'ModelPackageValidationSpecification$ValidationProfiles' => '

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

', ], ], 'ModelPackageValidationSpecification' => [ 'base' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', 'refs' => [ 'CreateModelPackageInput$ValidationSpecification' => '

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'DescribeModelPackageOutput$ValidationSpecification' => '

Configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'ModelPackage$ValidationSpecification' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', ], ], 'ModelPackageVersion' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageVersion' => '

The version number of a versioned model.

', 'DescribeModelPackageOutput$ModelPackageVersion' => '

The version of the model package.

', 'ModelPackage$ModelPackageVersion' => '

The version number of a versioned model.

', 'ModelPackageSummary$ModelPackageVersion' => '

If the model package is a versioned model, the version of the model.

', ], ], 'ModelQuality' => [ 'base' => '

Model quality statistics and constraints.

', 'refs' => [ 'ModelMetrics$ModelQuality' => '

Metrics that measure the quality of a model.

', ], ], 'ModelQualityAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification' => '

The container that runs the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification' => '

Configures the model quality job to run a specified Docker container image.

', ], ], 'ModelQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig' => '

Specifies the constraints and baselines for the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig' => '

The baseline configuration for a model quality job.

', ], ], 'ModelQualityJobInput' => [ 'base' => '

The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityJobInput' => '

A list of the inputs that are monitored. Currently endpoints are supported.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput' => '

Inputs for the model quality job.

', ], ], 'ModelRegisterSettings' => [ 'base' => '

The model registry settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$ModelRegisterSettings' => '

The model registry settings for the SageMaker Canvas application.

', ], ], 'ModelSetupTime' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$ModelSetupTime' => '

The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.

NaN indicates that the value is not available.

', ], ], 'ModelSortKey' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'ModelStepMetadata' => [ 'base' => '

Metadata for Model steps.

', 'refs' => [ 'PipelineExecutionStepMetadata$Model' => '

The Amazon Resource Name (ARN) of the model that was created by this step execution.

', ], ], 'ModelSummary' => [ 'base' => '

Provides summary information about a model.

', 'refs' => [ 'ModelSummaryList$member' => NULL, ], ], 'ModelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelsOutput$Models' => '

An array of ModelSummary objects, each of which lists a model.

', ], ], 'ModelVariantAction' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$value' => NULL, ], ], 'ModelVariantActionMap' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$ModelVariantActions' => '

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant

  • Remove - Delete the variant

  • Retain - Keep the variant as it is

', ], ], 'ModelVariantConfig' => [ 'base' => '

Contains information about the deployment options of a model.

', 'refs' => [ 'ModelVariantConfigList$member' => NULL, ], ], 'ModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

', 'StopInferenceExperimentRequest$DesiredModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

', 'UpdateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

', ], ], 'ModelVariantConfigSummary' => [ 'base' => '

Summary of the deployment configuration of a model.

', 'refs' => [ 'ModelVariantConfigSummaryList$member' => NULL, ], ], 'ModelVariantConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$ModelVariants' => '

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

', ], ], 'ModelVariantName' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$key' => NULL, 'ModelVariantConfig$VariantName' => '

The name of the variant.

', 'ModelVariantConfigSummary$VariantName' => '

The name of the variant.

', 'ShadowModeConfig$SourceModelVariantName' => '

The name of the production variant, which takes all the inference requests.

', 'ShadowModelVariantConfig$ShadowModelVariantName' => '

The name of the shadow variant.

', ], ], 'ModelVariantStatus' => [ 'base' => NULL, 'refs' => [ 'ModelVariantConfigSummary$Status' => '

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.

  • InService - The model variant is running on the hosted inference endpoint.

  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.

  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.

  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

', ], ], 'MonitoringAlertActions' => [ 'base' => '

A list of alert actions taken in response to an alert going into InAlert status.

', 'refs' => [ 'MonitoringAlertSummary$Actions' => '

A list of alert actions taken in response to an alert going into InAlert status.

', ], ], 'MonitoringAlertHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryResponse$MonitoringAlertHistory' => '

An alert history for a model monitoring schedule.

', ], ], 'MonitoringAlertHistorySortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$SortBy' => '

The field used to sort results. The default is CreationTime.

', ], ], 'MonitoringAlertHistorySummary' => [ 'base' => '

Provides summary information of an alert\'s history.

', 'refs' => [ 'MonitoringAlertHistoryList$member' => NULL, ], ], 'MonitoringAlertName' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertHistorySummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertSummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertResponse$MonitoringAlertName' => '

The name of a monitoring alert.

', ], ], 'MonitoringAlertStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$StatusEquals' => '

A filter that retrieves only alerts with a specific status.

', 'MonitoringAlertHistorySummary$AlertStatus' => '

The current alert status of an alert.

', 'MonitoringAlertSummary$AlertStatus' => '

The current status of an alert.

', ], ], 'MonitoringAlertSummary' => [ 'base' => '

Provides summary information about a monitor alert.

', 'refs' => [ 'MonitoringAlertSummaryList$member' => NULL, ], ], 'MonitoringAlertSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertsResponse$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', 'ModelDashboardMonitoringSchedule$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', ], ], 'MonitoringAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'MonitoringJobDefinition$MonitoringAppSpecification' => '

Configures the monitoring job to run a specified Docker container image.

', ], ], 'MonitoringBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'MonitoringJobDefinition$BaselineConfig' => '

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

', ], ], 'MonitoringClusterConfig' => [ 'base' => '

Configuration for the cluster used to run model monitoring jobs.

', 'refs' => [ 'MonitoringResources$ClusterConfig' => '

The configuration for the cluster resources used to run the processing job.

', ], ], 'MonitoringConstraintsResource' => [ 'base' => '

The constraints resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$ConstraintsResource' => NULL, 'ModelBiasBaselineConfig$ConstraintsResource' => NULL, 'ModelExplainabilityBaselineConfig$ConstraintsResource' => NULL, 'ModelQualityBaselineConfig$ConstraintsResource' => NULL, 'MonitoringBaselineConfig$ConstraintsResource' => '

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

', ], ], 'MonitoringContainerArguments' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$ContainerArguments' => '

The arguments to send to the container that the monitoring job runs.

', 'ModelQualityAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', 'MonitoringAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', ], ], 'MonitoringCsvDatasetFormat' => [ 'base' => '

Represents the CSV dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Csv' => '

The CSV dataset used in the monitoring job.

', ], ], 'MonitoringDatapointsToAlert' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', 'UpdateMonitoringAlertRequest$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', ], ], 'MonitoringDatasetFormat' => [ 'base' => '

Represents the dataset format used when running a monitoring job.

', 'refs' => [ 'BatchTransformInput$DatasetFormat' => '

The dataset format for your batch transform job.

', ], ], 'MonitoringEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'ModelBiasAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelExplainabilityAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'MonitoringJobDefinition$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'MonitoringEvaluationPeriod' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', 'UpdateMonitoringAlertRequest$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', ], ], 'MonitoringExecutionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringExecutionSummary' => [ 'base' => '

Summary of information about the last monitoring job to run.

', 'refs' => [ 'DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary' => '

Describes metadata on the last execution to run, if there was one.

', 'ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary' => NULL, 'MonitoringExecutionSummaryList$member' => NULL, 'MonitoringSchedule$LastMonitoringExecutionSummary' => NULL, ], ], 'MonitoringExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsResponse$MonitoringExecutionSummaries' => '

A JSON array in which each element is a summary for a monitoring execution.

', ], ], 'MonitoringGroundTruthS3Input' => [ 'base' => '

The ground truth labels for the dataset used for the monitoring job.

', 'refs' => [ 'ModelBiasJobInput$GroundTruthS3Input' => '

Location of ground truth labels to use in model bias job.

', 'ModelQualityJobInput$GroundTruthS3Input' => '

The ground truth label provided for the model.

', ], ], 'MonitoringInput' => [ 'base' => '

The inputs for a monitoring job.

', 'refs' => [ 'MonitoringInputs$member' => NULL, ], ], 'MonitoringInputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringJobDefinition$MonitoringInputs' => '

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

', ], ], 'MonitoringJobDefinition' => [ 'base' => '

Defines the monitoring job.

', 'refs' => [ 'MonitoringScheduleConfig$MonitoringJobDefinition' => '

Defines the monitoring job.

', ], ], 'MonitoringJobDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the job definition.

', 'CreateModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'CreateModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', ], ], 'MonitoringJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name for the monitoring job definition.

', 'CreateModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the monitoring job definition.

', 'DeleteDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to delete.

', 'DeleteModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition to delete.

', 'DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition to delete.

', 'DeleteModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality monitoring job definition to delete.

', 'DescribeDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to describe.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName' => '

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ListMonitoringExecutionsRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring job runs of the specified monitoring job definitions.

', 'ListMonitoringSchedulesRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring schedules for the specified monitoring job definition.

', 'MonitoringExecutionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringScheduleConfig$MonitoringJobDefinitionName' => '

The name of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job definition that the schedule is for.

', ], ], 'MonitoringJobDefinitionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListModelBiasJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelExplainabilityJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'MonitoringJobDefinitionSummary' => [ 'base' => '

Summary information about a monitoring job.

', 'refs' => [ 'MonitoringJobDefinitionSummaryList$member' => NULL, ], ], 'MonitoringJobDefinitionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of data quality monitoring job definitions.

', 'ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a model bias jobs.

', 'ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a explainability bias jobs.

', 'ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of summaries of model quality monitoring job definitions.

', ], ], 'MonitoringJsonDatasetFormat' => [ 'base' => '

Represents the JSON dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Json' => '

The JSON dataset used in the monitoring job

', ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'MonitoringStoppingCondition$MaxRuntimeInSeconds' => '

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

', ], ], 'MonitoringNetworkConfig' => [ 'base' => '

The networking configuration for the monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$NetworkConfig' => '

Specifies networking configuration for the monitoring job.

', 'CreateModelBiasJobDefinitionRequest$NetworkConfig' => '

Networking options for a model bias job.

', 'CreateModelExplainabilityJobDefinitionRequest$NetworkConfig' => '

Networking options for a model explainability job.

', 'CreateModelQualityJobDefinitionRequest$NetworkConfig' => '

Specifies the network configuration for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$NetworkConfig' => '

The networking configuration for the data quality monitoring job.

', 'DescribeModelBiasJobDefinitionResponse$NetworkConfig' => '

Networking options for a model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model quality job.

', ], ], 'MonitoringOutput' => [ 'base' => '

The output object for a monitoring job.

', 'refs' => [ 'MonitoringOutputs$member' => NULL, ], ], 'MonitoringOutputConfig' => [ 'base' => '

The output configuration for monitoring jobs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig' => NULL, 'CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig' => NULL, 'CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig' => NULL, 'DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig' => NULL, 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig' => NULL, 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig' => NULL, 'MonitoringJobDefinition$MonitoringOutputConfig' => '

The array of outputs from the monitoring job to be uploaded to Amazon S3.

', ], ], 'MonitoringOutputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringOutputConfig$MonitoringOutputs' => '

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

', ], ], 'MonitoringParquetDatasetFormat' => [ 'base' => '

Represents the Parquet dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Parquet' => '

The Parquet dataset used in the monitoring job

', ], ], 'MonitoringProblemType' => [ 'base' => NULL, 'refs' => [ 'ModelQualityAppSpecification$ProblemType' => '

The machine learning problem type of the model that the monitoring job monitors.

', ], ], 'MonitoringResources' => [ 'base' => '

Identifies the resources to deploy for a monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobResources' => NULL, 'CreateModelBiasJobDefinitionRequest$JobResources' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$JobResources' => NULL, 'CreateModelQualityJobDefinitionRequest$JobResources' => NULL, 'DescribeDataQualityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelBiasJobDefinitionResponse$JobResources' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelQualityJobDefinitionResponse$JobResources' => NULL, 'MonitoringJobDefinition$MonitoringResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

', ], ], 'MonitoringS3Output' => [ 'base' => '

Information about where and how you want to store the results of a monitoring job.

', 'refs' => [ 'MonitoringOutput$S3Output' => '

The Amazon S3 storage location where the results of a monitoring job are saved.

', ], ], 'MonitoringS3Uri' => [ 'base' => NULL, 'refs' => [ 'MonitoringGroundTruthS3Input$S3Uri' => '

The address of the Amazon S3 location of the ground truth labels.

', 'MonitoringS3Output$S3Uri' => '

A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

', ], ], 'MonitoringSchedule' => [ 'base' => '

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'refs' => [ 'MonitoringScheduleList$member' => NULL, ], ], 'MonitoringScheduleArn' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeProcessingJobResponse$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of a monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'ProcessingJob$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'UpdateMonitoringAlertResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'UpdateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', ], ], 'MonitoringScheduleConfig' => [ 'base' => '

Configures the monitoring schedule and defines the monitoring job.

', 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleConfig' => NULL, 'MonitoringSchedule$MonitoringScheduleConfig' => NULL, 'UpdateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', ], ], 'MonitoringScheduleList' => [ 'base' => NULL, 'refs' => [ 'Endpoint$MonitoringSchedules' => '

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

', ], ], 'MonitoringScheduleName' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', 'DeleteMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule to delete.

', 'DescribeMonitoringScheduleRequest$MonitoringScheduleName' => '

Name of a previously created monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleName' => '

Name of the monitoring schedule.

', 'ListMonitoringAlertHistoryRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringAlertsRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringExecutionsRequest$MonitoringScheduleName' => '

Name of a specific schedule to fetch jobs for.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringAlertHistorySummary$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringExecutionSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'StartMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to start.

', 'StopMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to stop.

', 'UpdateMonitoringAlertRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'UpdateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', ], ], 'MonitoringScheduleSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringScheduleSummary' => [ 'base' => '

Summarizes the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleSummaryList$member' => NULL, ], ], 'MonitoringScheduleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesResponse$MonitoringScheduleSummaries' => '

A JSON array in which each element is a summary for a monitoring schedule.

', ], ], 'MonitoringStatisticsResource' => [ 'base' => '

The statistics resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$StatisticsResource' => NULL, 'MonitoringBaselineConfig$StatisticsResource' => '

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

', ], ], 'MonitoringStoppingCondition' => [ 'base' => '

A time limit for how long the monitoring job is allowed to run before stopping.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelBiasJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelQualityJobDefinitionRequest$StoppingCondition' => NULL, 'DescribeDataQualityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelBiasJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelQualityJobDefinitionResponse$StoppingCondition' => NULL, 'MonitoringJobDefinition$StoppingCondition' => '

Specifies a time limit for how long the monitoring job is allowed to run.

', ], ], 'MonitoringTimeOffsetString' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'BatchTransformInput$EndTimeOffset' => '

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$EndTimeOffset' => '

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', ], ], 'MonitoringType' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringType' => '

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

', 'ListMonitoringExecutionsRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring job runs of the specified monitoring type.

', 'ListMonitoringSchedulesRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring schedules for the specified monitoring type.

', 'ModelDashboardMonitoringSchedule$MonitoringType' => '

The monitor type of a model monitor.

', 'MonitoringExecutionSummary$MonitoringType' => '

The type of the monitoring job.

', 'MonitoringSchedule$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleConfig$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringType' => '

The type of the monitoring job definition that the schedule is for.

', ], ], 'MountPath' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$MountPath' => '

The path within the image to mount the user\'s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

', ], ], 'MultiModelConfig' => [ 'base' => '

Specifies additional configuration for hosting multi-model endpoints.

', 'refs' => [ 'ContainerDefinition$MultiModelConfig' => '

Specifies additional configuration for multi-model endpoints.

', ], ], 'NameContains' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$NameContains' => '

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

', 'ListClustersRequest$NameContains' => '

Set the maximum number of instances to print in the list.

', 'ListCompilationJobsRequest$NameContains' => '

A filter that returns the model compilation jobs whose name contains a specified string.

', 'ListDataQualityJobDefinitionsRequest$NameContains' => '

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

', 'ListDeviceFleetsRequest$NameContains' => '

Filter for fleets containing this name in their fleet device name.

', 'ListEdgeDeploymentPlansRequest$NameContains' => '

Selects edge deployment plans with names containing this name.

', 'ListEdgeDeploymentPlansRequest$DeviceFleetNameContains' => '

Selects edge deployment plans with a device fleet name containing this name.

', 'ListEdgePackagingJobsRequest$NameContains' => '

Filter for jobs containing this name in their packaging job name.

', 'ListEdgePackagingJobsRequest$ModelNameContains' => '

Filter for jobs where the model name contains this string.

', 'ListHubContentsRequest$NameContains' => '

Only list hub content if the name contains the specified string.

', 'ListHubsRequest$NameContains' => '

Only list hubs with names that contain the specified string.

', 'ListHyperParameterTuningJobsRequest$NameContains' => '

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

', 'ListInferenceExperimentsRequest$NameContains' => '

Selects inference experiments whose names contain this name.

', 'ListInferenceRecommendationsJobsRequest$NameContains' => '

A string in the job name. This filter returns only recommendations whose name contains the specified string.

', 'ListLabelingJobsRequest$NameContains' => '

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

', 'ListModelBiasJobDefinitionsRequest$NameContains' => '

Filter for model bias jobs whose name contains a specified string.

', 'ListModelExplainabilityJobDefinitionsRequest$NameContains' => '

Filter for model explainability jobs whose name contains a specified string.

', 'ListModelPackageGroupsInput$NameContains' => '

A string in the model group name. This filter returns only model groups whose name contains the specified string.

', 'ListModelPackagesInput$NameContains' => '

A string in the model package name. This filter returns only model packages whose name contains the specified string.

', 'ListModelQualityJobDefinitionsRequest$NameContains' => '

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

', 'ListMonitoringSchedulesRequest$NameContains' => '

Filter for monitoring schedules whose name contains a specified string.

', 'ListTrainingJobsRequest$NameContains' => '

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

', 'ListTransformJobsRequest$NameContains' => '

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

', ], ], 'NeoVpcConfig' => [ 'base' => '

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

', 'refs' => [ 'CreateCompilationJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeCompilationJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'NeoVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSecurityGroupIds$member' => NULL, ], ], 'NeoVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'NeoVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSubnets$member' => NULL, ], ], 'NeoVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$Subnets' => '

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

', ], ], 'NestedFilters' => [ 'base' => '

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job\'s InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • \'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}\',

  • \'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}\'

', 'refs' => [ 'NestedFiltersList$member' => NULL, ], ], 'NestedFiltersList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$NestedFilters' => '

A list of nested filter objects.

', ], ], 'NetworkConfig' => [ 'base' => '

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

', 'refs' => [ 'CreateProcessingJobRequest$NetworkConfig' => '

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

', 'DescribeProcessingJobResponse$NetworkConfig' => '

Networking options for a processing job.

', 'MonitoringJobDefinition$NetworkConfig' => '

Specifies networking options for an monitoring job.

', 'ProcessingJob$NetworkConfig' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NetworkInterfaceId' => '

The network interface IDs that SageMaker created at the time of creating the instance.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceRequest$NextToken' => '

Next token of device description.

', 'DescribeDeviceResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'DescribeEdgeDeploymentPlanRequest$NextToken' => '

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

', 'DescribeEdgeDeploymentPlanResponse$NextToken' => '

Token to use when calling the next set of stages in the edge deployment plan.

', 'DescribeFeatureGroupRequest$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

', 'DescribeFeatureGroupResponse$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions).

', 'ListActionsRequest$NextToken' => '

If the previous call to ListActions didn\'t return the full set of actions, the call returns a token for getting the next set of actions.

', 'ListActionsResponse$NextToken' => '

A token for getting the next set of actions, if there are any.

', 'ListAlgorithmsInput$NextToken' => '

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

', 'ListAlgorithmsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListAliasesRequest$NextToken' => '

If the previous call to ListAliases didn\'t return the full set of aliases, the call returns a token for retrieving the next set of aliases.

', 'ListAliasesResponse$NextToken' => '

A token for getting the next set of aliases, if more aliases exist.

', 'ListAppImageConfigsRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

', 'ListAppImageConfigsResponse$NextToken' => '

A token for getting the next set of AppImageConfigs, if there are any.

', 'ListAppsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListAppsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListArtifactsRequest$NextToken' => '

If the previous call to ListArtifacts didn\'t return the full set of artifacts, the call returns a token for getting the next set of artifacts.

', 'ListArtifactsResponse$NextToken' => '

A token for getting the next set of artifacts, if there are any.

', 'ListAssociationsRequest$NextToken' => '

If the previous call to ListAssociations didn\'t return the full set of associations, the call returns a token for getting the next set of associations.

', 'ListAssociationsResponse$NextToken' => '

A token for getting the next set of associations, if there are any.

', 'ListAutoMLJobsRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListAutoMLJobsResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListClusterNodesRequest$NextToken' => '

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

', 'ListClusterNodesResponse$NextToken' => '

The next token specified for listing instances in a SageMaker HyperPod cluster.

', 'ListClustersRequest$NextToken' => '

Set the next token to retrieve the list of SageMaker HyperPod clusters.

', 'ListClustersResponse$NextToken' => '

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

', 'ListCodeRepositoriesInput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCodeRepositoriesOutput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCompilationJobsRequest$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListCompilationJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

', 'ListContextsRequest$NextToken' => '

If the previous call to ListContexts didn\'t return the full set of contexts, the call returns a token for getting the next set of contexts.

', 'ListContextsResponse$NextToken' => '

A token for getting the next set of contexts, if there are any.

', 'ListDataQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

', 'ListDataQualityJobDefinitionsResponse$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.

', 'ListDeviceFleetsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDeviceFleetsResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDomainsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListDomainsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListEdgeDeploymentPlansRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgeDeploymentPlansResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListEdgePackagingJobsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgePackagingJobsResponse$NextToken' => '

Token to use when calling the next page of results.

', 'ListExperimentsRequest$NextToken' => '

If the previous call to ListExperiments didn\'t return the full set of experiments, the call returns a token for getting the next set of experiments.

', 'ListExperimentsResponse$NextToken' => '

A token for getting the next set of experiments, if there are any.

', 'ListFeatureGroupsRequest$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFeatureGroupsResponse$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFlowDefinitionsRequest$NextToken' => '

A token to resume pagination.

', 'ListFlowDefinitionsResponse$NextToken' => '

A token to resume pagination.

', 'ListHubContentVersionsRequest$NextToken' => '

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

', 'ListHubContentVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

', 'ListHubContentsRequest$NextToken' => '

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

', 'ListHubContentsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

', 'ListHubsRequest$NextToken' => '

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

', 'ListHubsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

', 'ListHumanTaskUisRequest$NextToken' => '

A token to resume pagination.

', 'ListHumanTaskUisResponse$NextToken' => '

A token to resume pagination.

', 'ListHyperParameterTuningJobsRequest$NextToken' => '

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListHyperParameterTuningJobsResponse$NextToken' => '

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListImageVersionsRequest$NextToken' => '

If the previous call to ListImageVersions didn\'t return the full set of versions, the call returns a token for getting the next set of versions.

', 'ListImageVersionsResponse$NextToken' => '

A token for getting the next set of versions, if there are any.

', 'ListImagesRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of images, the call returns a token for getting the next set of images.

', 'ListImagesResponse$NextToken' => '

A token for getting the next set of images, if there are any.

', 'ListInferenceExperimentsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListInferenceExperimentsResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListInferenceRecommendationsJobStepsRequest$NextToken' => '

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

', 'ListInferenceRecommendationsJobStepsResponse$NextToken' => '

A token that you can specify in your next request to return more results from the list.

', 'ListInferenceRecommendationsJobsRequest$NextToken' => '

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

', 'ListInferenceRecommendationsJobsResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListLabelingJobsForWorkteamRequest$NextToken' => '

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsForWorkteamResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLabelingJobsRequest$NextToken' => '

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLineageGroupsRequest$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListLineageGroupsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListModelBiasJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelBiasJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelCardExportJobsRequest$NextToken' => '

If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

', 'ListModelCardExportJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.

', 'ListModelCardVersionsRequest$NextToken' => '

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

', 'ListModelCardVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

', 'ListModelCardsRequest$NextToken' => '

If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

', 'ListModelCardsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

', 'ListModelExplainabilityJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelExplainabilityJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelMetadataRequest$NextToken' => '

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

', 'ListModelMetadataResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListModelPackageGroupsInput$NextToken' => '

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

', 'ListModelPackageGroupsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

', 'ListModelPackagesInput$NextToken' => '

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

', 'ListModelPackagesOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

', 'ListModelQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

', 'ListModelQualityJobDefinitionsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

', 'ListMonitoringAlertHistoryRequest$NextToken' => '

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertHistoryResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringAlertsRequest$NextToken' => '

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringExecutionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringExecutionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListNotebookInstanceLifecycleConfigsInput$NextToken' => '

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

', 'ListNotebookInstanceLifecycleConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

', 'ListNotebookInstancesInput$NextToken' => '

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

', 'ListNotebookInstancesOutput$NextToken' => '

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

', 'ListPipelineExecutionStepsRequest$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionStepsResponse$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionsRequest$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineExecutionsResponse$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineParametersForExecutionRequest$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelineParametersForExecutionResponse$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelinesRequest$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListPipelinesResponse$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListProcessingJobsRequest$NextToken' => '

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

', 'ListProcessingJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

', 'ListProjectsInput$NextToken' => '

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

', 'ListProjectsOutput$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListResourceCatalogsRequest$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListResourceCatalogsResponse$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListSpacesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSpacesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListStageDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to neeed tokening.

', 'ListStageDevicesResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListStudioLifecycleConfigsRequest$NextToken' => '

If the previous call to ListStudioLifecycleConfigs didn\'t return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

', 'ListStudioLifecycleConfigsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSubscribedWorkteamsRequest$NextToken' => '

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListSubscribedWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'ListTagsInput$NextToken' => '

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

', 'ListTagsOutput$NextToken' => '

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$NextToken' => '

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsForHyperParameterTuningJobResponse$NextToken' => '

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsRequest$NextToken' => '

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListTransformJobsRequest$NextToken' => '

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

', 'ListTransformJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

', 'ListTrialComponentsRequest$NextToken' => '

If the previous call to ListTrialComponents didn\'t return the full set of components, the call returns a token for getting the next set of components.

', 'ListTrialComponentsResponse$NextToken' => '

A token for getting the next set of components, if there are any.

', 'ListTrialsRequest$NextToken' => '

If the previous call to ListTrials didn\'t return the full set of trials, the call returns a token for getting the next set of trials.

', 'ListTrialsResponse$NextToken' => '

A token for getting the next set of trials, if there are any.

', 'ListUserProfilesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListUserProfilesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListWorkforcesRequest$NextToken' => '

A token to resume pagination.

', 'ListWorkforcesResponse$NextToken' => '

A token to resume pagination.

', 'ListWorkteamsRequest$NextToken' => '

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'SearchRequest$NextToken' => '

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

', 'SearchResponse$NextToken' => '

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

', ], ], 'NonEmptyString256' => [ 'base' => NULL, 'refs' => [ 'CustomImageContainerEntrypoint$member' => NULL, 'CustomImageContainerEnvironmentVariables$key' => NULL, ], ], 'NonEmptyString64' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the SageMaker Studio UI.

', 'CustomImageContainerArguments$member' => NULL, 'DescribeSpaceResponse$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', 'SpaceDetails$SpaceDisplayName' => '

The name of the space that appears in the Studio UI.

', 'UpdateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', ], ], 'NotebookInstanceAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceAcceleratorTypes$member' => NULL, ], ], 'NotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AcceleratorTypes' => '

A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'DescribeNotebookInstanceOutput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'UpdateNotebookInstanceInput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'NotebookInstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'DescribeNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', ], ], 'NotebookInstanceLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceLifecycleHook$Content' => '

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigInput$OnCreate' => '

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'CreateNotebookInstanceLifecycleConfigInput$OnStart' => '

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', ], ], 'NotebookInstanceLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to delete.

', 'DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to describe.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName' => '

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

', 'ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains' => '

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'NotebookInstanceSummary$NotebookInstanceLifecycleConfigName' => '

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$NameContains' => '

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

', ], ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'base' => '

Provides a summary of a notebook instance lifecycle configuration.

', 'refs' => [ 'NotebookInstanceLifecycleConfigSummaryList$member' => NULL, ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs' => '

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleHook' => [ 'base' => '

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'refs' => [ 'NotebookInstanceLifecycleConfigList$member' => NULL, ], ], 'NotebookInstanceName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$NotebookInstanceName' => '

The name of the new notebook instance.

', 'CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName' => '

The name of the notebook instance.

', 'DeleteNotebookInstanceInput$NotebookInstanceName' => '

The name of the SageMaker notebook instance to delete.

', 'DescribeNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance that you want information about.

', 'DescribeNotebookInstanceOutput$NotebookInstanceName' => '

The name of the SageMaker notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceName' => '

The name of the notebook instance that you want a summary for.

', 'StartNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to start.

', 'StopNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to terminate.

', 'UpdateNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to update.

', ], ], 'NotebookInstanceNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$NameContains' => '

A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.

', ], ], 'NotebookInstanceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'NotebookInstanceSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NotebookInstanceStatus' => '

The status of the notebook instance.

', 'ListNotebookInstancesInput$StatusEquals' => '

A filter that returns only notebook instances with the specified status.

', 'NotebookInstanceSummary$NotebookInstanceStatus' => '

The status of the notebook instance.

', ], ], 'NotebookInstanceSummary' => [ 'base' => '

Provides summary information for an SageMaker notebook instance.

', 'refs' => [ 'NotebookInstanceSummaryList$member' => NULL, ], ], 'NotebookInstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesOutput$NotebookInstances' => '

An array of NotebookInstanceSummary objects, one for each notebook instance.

', ], ], 'NotebookInstanceUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedNotebookInstanceUrlOutput$AuthorizedUrl' => '

A JSON object that contains the URL string.

', 'DescribeNotebookInstanceOutput$Url' => '

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

', 'NotebookInstanceSummary$Url' => '

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

', ], ], 'NotebookInstanceVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

', 'DescribeNotebookInstanceOutput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the notebook instance.

', 'UpdateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can\'t determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can\'t decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

', ], ], 'NotebookOutputOption' => [ 'base' => NULL, 'refs' => [ 'SharingSettings$NotebookOutputOption' => '

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

', ], ], 'NotificationConfiguration' => [ 'base' => '

Configures Amazon SNS notifications of available or expiring work items for work teams.

', 'refs' => [ 'CreateWorkteamRequest$NotificationConfiguration' => '

Configures notification of workers regarding available or expiring work items.

', 'UpdateWorkteamRequest$NotificationConfiguration' => '

Configures SNS topic notifications for available or expiring work items

', 'Workteam$NotificationConfiguration' => '

Configures SNS notifications of available or expiring work items for work teams.

', ], ], 'NotificationTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$NotificationTopicArn' => '

The ARN for the Amazon SNS topic to which notifications should be published.

', ], ], 'NumberOfAcceleratorDevices' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfAcceleratorDevicesRequired' => '

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

', ], ], 'NumberOfCpuCores' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfCpuCoresRequired' => '

The number of CPU cores to allocate to run a model that you assign to an inference component.

', ], ], 'NumberOfHumanWorkersPerDataObject' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$NumberOfHumanWorkersPerDataObject' => '

The number of human workers that will label an object.

', 'LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject' => '

The configured number of workers per data object.

', ], ], 'NumberOfSteps' => [ 'base' => NULL, 'refs' => [ 'Stairs$NumberOfSteps' => '

Specifies how many steps to perform during traffic.

', ], ], 'ObjectiveStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$ObjectiveStatus' => '

The objective\'s status.

', 'HyperParameterTrainingJobSummary$ObjectiveStatus' => '

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounter' => [ 'base' => NULL, 'refs' => [ 'ObjectiveStatusCounters$Succeeded' => '

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

', 'ObjectiveStatusCounters$Pending' => '

The number of training jobs that are in progress and pending evaluation of their final objective metric.

', 'ObjectiveStatusCounters$Failed' => '

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounters' => [ 'base' => '

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters' => NULL, 'HyperParameterTuningJobSummary$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

', ], ], 'OfflineStoreConfig' => [ 'base' => '

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

', 'refs' => [ 'CreateFeatureGroupRequest$OfflineStoreConfig' => '

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

', 'DescribeFeatureGroupResponse$OfflineStoreConfig' => '

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.

  • Configuration of the Glue data catalog.

  • Table format of the offline store.

  • Option to disable the automatic creation of a Glue table for the offline store.

  • Encryption configuration.

', 'FeatureGroup$OfflineStoreConfig' => NULL, ], ], 'OfflineStoreStatus' => [ 'base' => '

The status of OfflineStore.

', 'refs' => [ 'DescribeFeatureGroupResponse$OfflineStoreStatus' => '

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

', 'FeatureGroup$OfflineStoreStatus' => NULL, 'FeatureGroupSummary$OfflineStoreStatus' => '

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

', ], ], 'OfflineStoreStatusValue' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$OfflineStoreStatusEquals' => '

An OfflineStore status. Filters by OfflineStore status.

', 'OfflineStoreStatus$Status' => '

An OfflineStore status.

', ], ], 'OidcConfig' => [ 'base' => '

Use this parameter to configure your OIDC Identity Provider (IdP).

', 'refs' => [ 'CreateWorkforceRequest$OidcConfig' => '

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

', 'UpdateWorkforceRequest$OidcConfig' => '

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

', ], ], 'OidcConfigForResponse' => [ 'base' => '

Your OIDC IdP workforce configuration.

', 'refs' => [ 'Workforce$OidcConfig' => '

The configuration of an OIDC Identity Provider (IdP) private workforce.

', ], ], 'OidcEndpoint' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfig$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfig$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfig$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfig$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfig$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', 'OidcConfigForResponse$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfigForResponse$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfigForResponse$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfigForResponse$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfigForResponse$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfigForResponse$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', ], ], 'OidcMemberDefinition' => [ 'base' => '

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', 'refs' => [ 'MemberDefinition$OidcMemberDefinition' => '

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', ], ], 'OnlineStoreConfig' => [ 'base' => '

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

', 'refs' => [ 'CreateFeatureGroupRequest$OnlineStoreConfig' => '

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

', 'DescribeFeatureGroupResponse$OnlineStoreConfig' => '

The configuration for the OnlineStore.

', 'FeatureGroup$OnlineStoreConfig' => NULL, ], ], 'OnlineStoreConfigUpdate' => [ 'base' => '

Updates the feature group online store configuration.

', 'refs' => [ 'UpdateFeatureGroupRequest$OnlineStoreConfig' => '

Updates the feature group online store configuration.

', ], ], 'OnlineStoreSecurityConfig' => [ 'base' => '

The security configuration for OnlineStore.

', 'refs' => [ 'OnlineStoreConfig$SecurityConfig' => '

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

', ], ], 'OnlineStoreTotalSizeBytes' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$OnlineStoreTotalSizeBytes' => '

The size of the OnlineStore in bytes.

', ], ], 'Operator' => [ 'base' => NULL, 'refs' => [ 'Filter$Operator' => '

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn\'t equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "\'CONTAINS\' operator usage limit of 1 exceeded."

', ], ], 'OptionalDouble' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Max' => '

The maximum value of the metric.

', 'TrialComponentMetricSummary$Min' => '

The minimum value of the metric.

', 'TrialComponentMetricSummary$Last' => '

The most recent value of the metric.

', 'TrialComponentMetricSummary$Avg' => '

The average value of the metric.

', 'TrialComponentMetricSummary$StdDev' => '

The standard deviation of the metric.

', ], ], 'OptionalInteger' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Count' => '

The number of samples used to generate the metric.

', ], ], 'OptionalVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', 'HyperParameterTuningResourceConfig$VolumeSizeInGB' => '

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

', 'ProfilerRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', ], ], 'OrderKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListEndpointsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListInferenceComponentsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListModelsInput$SortOrder' => '

The sort order for results. The default is Descending.

', ], ], 'OutputCompressionType' => [ 'base' => NULL, 'refs' => [ 'OutputDataConfig$CompressionType' => '

The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

', ], ], 'OutputConfig' => [ 'base' => '

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

', 'refs' => [ 'CreateCompilationJobRequest$OutputConfig' => '

Provides information about the output location for the compiled model and the target device the model runs on.

', 'DescribeCompilationJobResponse$OutputConfig' => '

Information about the output location for the compiled model and the target device that the model runs on.

', ], ], 'OutputDataConfig' => [ 'base' => '

Provides information about how to store model training results (model artifacts).

', 'refs' => [ 'CreateTrainingJobRequest$OutputDataConfig' => '

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', 'DescribeTrainingJobResponse$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'HyperParameterTrainingJobDefinition$OutputDataConfig' => '

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

', 'TrainingJob$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'TrainingJobDefinition$OutputDataConfig' => '

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', ], ], 'OutputParameter' => [ 'base' => '

An output parameter of a pipeline step.

', 'refs' => [ 'OutputParameterList$member' => NULL, ], ], 'OutputParameterList' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$OutputParameters' => '

A list of the output parameters of the callback step.

', 'LambdaStepMetadata$OutputParameters' => '

A list of the output parameters of the Lambda step.

', 'SendPipelineExecutionStepSuccessRequest$OutputParameters' => '

A list of the output parameters of the callback step.

', ], ], 'OwnershipSettings' => [ 'base' => '

The collection of ownership settings for a space.

', 'refs' => [ 'CreateSpaceRequest$OwnershipSettings' => '

A collection of ownership settings.

', 'DescribeSpaceResponse$OwnershipSettings' => '

The collection of ownership settings for a space.

', ], ], 'OwnershipSettingsSummary' => [ 'base' => '

Specifies summary information about the ownership settings.

', 'refs' => [ 'SpaceDetails$OwnershipSettingsSummary' => '

Specifies summary information about the ownership settings.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NextToken' => '

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

', 'ListEndpointConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

', 'ListEndpointsInput$NextToken' => '

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

', 'ListEndpointsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListInferenceComponentsInput$NextToken' => '

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

', 'ListInferenceComponentsOutput$NextToken' => '

The token to use in a subsequent request to get the next set of results following a truncated response.

', 'ListModelsInput$NextToken' => '

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

', 'ListModelsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

', ], ], 'ParallelismConfiguration' => [ 'base' => '

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

', 'refs' => [ 'CreatePipelineRequest$ParallelismConfiguration' => '

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

', 'DescribePipelineExecutionResponse$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'DescribePipelineResponse$ParallelismConfiguration' => '

Lists the parallelism configuration applied to the pipeline.

', 'Pipeline$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'PipelineExecution$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline execution.

', 'RetryPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

', 'StartPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineRequest$ParallelismConfiguration' => '

If specified, it applies to all executions of this pipeline by default.

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

Assigns a value to a named Pipeline parameter.

', 'refs' => [ 'ParameterList$member' => NULL, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$Name' => '

The name of the hyperparameter to optimize using Autotune.

', 'CategoricalParameterRange$Name' => '

The name of the categorical hyperparameter to tune.

', 'ContinuousParameterRange$Name' => '

The name of the continuous hyperparameter to tune.

', 'IntegerParameterRange$Name' => '

The name of the hyperparameter to search.

', ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineParametersForExecutionResponse$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'PipelineExecution$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'StartPipelineExecutionRequest$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Name' => '

The name of this hyperparameter. The name must be unique.

', ], ], 'ParameterRange' => [ 'base' => '

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecification$Range' => '

The allowed range for this hyperparameter.

', ], ], 'ParameterRanges' => [ 'base' => '

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can\'t exceed the maximum number specified.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterRanges' => NULL, 'HyperParameterTuningJobConfig$ParameterRanges' => '

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Type' => '

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$ValueHint' => '

An example value of the hyperparameter to optimize using Autotune.

', 'ContinuousParameterRange$MinValue' => '

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

', 'ContinuousParameterRange$MaxValue' => '

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

', 'ContinuousParameterRangeSpecification$MinValue' => '

The minimum floating-point value allowed.

', 'ContinuousParameterRangeSpecification$MaxValue' => '

The maximum floating-point value allowed.

', 'IntegerParameterRange$MinValue' => '

The minimum value of the hyperparameter to search.

', 'IntegerParameterRange$MaxValue' => '

The maximum value of the hyperparameter to search.

', 'IntegerParameterRangeSpecification$MinValue' => '

The minimum integer value allowed.

', 'IntegerParameterRangeSpecification$MaxValue' => '

The maximum integer value allowed.

', 'ParameterValues$member' => NULL, ], ], 'ParameterValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRange$Values' => '

A list of the categories for the hyperparameter.

', 'CategoricalParameterRangeSpecification$Values' => '

The allowed categories for the hyperparameter.

', ], ], 'Parent' => [ 'base' => '

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

', 'refs' => [ 'Parents$member' => NULL, ], ], 'ParentHyperParameterTuningJob' => [ 'base' => '

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'refs' => [ 'ParentHyperParameterTuningJobs$member' => NULL, ], ], 'ParentHyperParameterTuningJobs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs' => '

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

', ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'TrialComponent$Parents' => '

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

', ], ], 'PendingDeploymentSummary' => [ 'base' => '

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

', 'refs' => [ 'DescribeEndpointOutput$PendingDeploymentSummary' => '

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

', ], ], 'PendingProductionVariantSummary' => [ 'base' => '

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

', 'refs' => [ 'PendingProductionVariantSummaryList$member' => NULL, ], ], 'PendingProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'PendingDeploymentSummary$ProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

', 'PendingDeploymentSummary$ShadowProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$Percentage' => '

Percentage of devices in the fleet to deploy to the current stage.

', 'ShadowModelVariantConfig$SamplingPercentage' => '

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

', ], ], 'Phase' => [ 'base' => '

Defines the traffic pattern.

', 'refs' => [ 'Phases$member' => NULL, ], ], 'Phases' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$Phases' => '

Defines the phases traffic specification.

', ], ], 'Pipeline' => [ 'base' => '

A SageMaker Model Building Pipeline instance.

', 'refs' => [ 'SearchRecord$Pipeline' => NULL, ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the created pipeline.

', 'DeletePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline to delete.

', 'DescribePipelineExecutionResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'DescribePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'Pipeline$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'PipelineExecution$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline that was executed.

', 'PipelineSummary$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'UpdatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the updated pipeline.

', ], ], 'PipelineDefinition' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition of the pipeline.

', 'DescribePipelineDefinitionForExecutionResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'DescribePipelineResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'UpdatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition.

', ], ], 'PipelineDefinitionS3Location' => [ 'base' => '

The location of the pipeline definition stored in Amazon S3.

', 'refs' => [ 'CreatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', 'UpdatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', ], ], 'PipelineDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDescription' => '

A description of the pipeline.

', 'DescribePipelineResponse$PipelineDescription' => '

The description of the pipeline.

', 'Pipeline$PipelineDescription' => '

The description of the pipeline.

', 'PipelineSummary$PipelineDescription' => '

The description of the pipeline.

', 'UpdatePipelineRequest$PipelineDescription' => '

The description of the pipeline.

', ], ], 'PipelineExecution' => [ 'base' => '

An execution of a pipeline.

', 'refs' => [ 'SearchRecord$PipelineExecution' => NULL, ], ], 'PipelineExecutionArn' => [ 'base' => NULL, 'refs' => [ 'CacheHitResult$SourcePipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineExecutionStepsRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineParametersForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecution$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SelectiveExecutionConfig$SourcePipelineExecutionArn' => '

The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.

', 'SelectiveExecutionResult$SourcePipelineExecutionArn' => '

The ARN from an execution of the current pipeline.

', 'SendPipelineExecutionStepFailureResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StartPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the updated pipeline execution.

', ], ], 'PipelineExecutionDescription' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', ], ], 'PipelineExecutionFailureReason' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$FailureReason' => '

If the execution failed, a message describing why.

', 'PipelineExecution$FailureReason' => '

If the execution failed, a message describing why.

', ], ], 'PipelineExecutionName' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', ], ], 'PipelineExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionStatus' => '

The status of the pipeline execution.

', 'PipelineExecution$PipelineExecutionStatus' => '

The status of the pipeline status.

', 'PipelineExecutionSummary$PipelineExecutionStatus' => '

The status of the pipeline execution.

', ], ], 'PipelineExecutionStep' => [ 'base' => '

An execution of a step in a pipeline.

', 'refs' => [ 'PipelineExecutionStepList$member' => NULL, ], ], 'PipelineExecutionStepList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionStepsResponse$PipelineExecutionSteps' => '

A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

', ], ], 'PipelineExecutionStepMetadata' => [ 'base' => '

Metadata for a step execution.

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

Metadata to run the pipeline step.

', ], ], 'PipelineExecutionSummary' => [ 'base' => '

A pipeline execution summary.

', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsResponse$PipelineExecutionSummaries' => '

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

', ], ], 'PipelineExperimentConfig' => [ 'base' => '

Specifies the names of the experiment and trial created by a pipeline.

', 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExperimentConfig' => NULL, 'PipelineExecution$PipelineExperimentConfig' => NULL, ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => '

The name of the pipeline.

', 'CreatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', 'DeletePipelineRequest$PipelineName' => '

The name of the pipeline to delete.

', 'DescribePipelineResponse$PipelineName' => '

The name of the pipeline.

', 'DescribePipelineResponse$PipelineDisplayName' => '

The display name of the pipeline.

', 'ListPipelinesRequest$PipelineNamePrefix' => '

The prefix of the pipeline name.

', 'Pipeline$PipelineName' => '

The name of the pipeline.

', 'Pipeline$PipelineDisplayName' => '

The display name of the pipeline.

', 'PipelineSummary$PipelineName' => '

The name of the pipeline.

', 'PipelineSummary$PipelineDisplayName' => '

The display name of the pipeline.

', 'UpdatePipelineRequest$PipelineName' => '

The name of the pipeline to update.

', 'UpdatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', ], ], 'PipelineNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline to describe.

', 'ListPipelineExecutionsRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', 'StartPipelineExecutionRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', ], ], 'PipelineParameterName' => [ 'base' => NULL, 'refs' => [ 'Parameter$Name' => '

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineResponse$PipelineStatus' => '

The status of the pipeline execution.

', 'Pipeline$PipelineStatus' => '

The status of the pipeline.

', ], ], 'PipelineSummary' => [ 'base' => '

A summary of a pipeline.

', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$PipelineSummaries' => '

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

', ], ], 'PlatformIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', 'DescribeNotebookInstanceOutput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetModelPackageGroupPolicyOutput$ResourcePolicy' => '

The resource policy for the model group.

', 'PutModelPackageGroupPolicyInput$ResourcePolicy' => '

The resource policy for the model group.

', ], ], 'PredefinedMetricSpecification' => [ 'base' => '

A specification for a predefined metric.

', 'refs' => [ 'MetricSpecification$Predefined' => '

Information about a predefined metric.

', ], ], 'PresignedDomainUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlResponse$AuthorizedUrl' => '

The presigned URL.

', ], ], 'ProbabilityThresholdAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', 'EndpointInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', ], ], 'ProblemType' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$ProblemType' => '

Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.

', 'DescribeAutoMLJobResponse$ProblemType' => '

Returns the job\'s problem type.

', 'ResolvedAttributes$ProblemType' => '

The problem type.

', 'TabularJobConfig$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see SageMaker Autopilot problem types.

You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.

', 'TabularResolvedAttributes$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see SageMaker Autopilot problem types.

', ], ], 'ProcessingClusterConfig' => [ 'base' => '

Configuration for the cluster used to run a processing job.

', 'refs' => [ 'ProcessingResources$ClusterConfig' => '

The configuration for the resources in a cluster used to run the processing job.

', ], ], 'ProcessingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$key' => NULL, 'ProcessingEnvironmentMap$key' => NULL, ], ], 'ProcessingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$Environment' => '

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

', 'DescribeProcessingJobResponse$Environment' => '

The environment variables set in the Docker container.

', 'ProcessingJob$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'ProcessingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$value' => NULL, 'ProcessingEnvironmentMap$value' => NULL, ], ], 'ProcessingFeatureStoreOutput' => [ 'base' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store.

', 'refs' => [ 'ProcessingOutput$FeatureStoreOutput' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

', ], ], 'ProcessingInput' => [ 'base' => '

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

', 'refs' => [ 'ProcessingInputs$member' => NULL, ], ], 'ProcessingInputs' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingInputs' => '

An array of inputs configuring the data to download into the processing container.

', 'DescribeProcessingJobResponse$ProcessingInputs' => '

The inputs for a processing job.

', 'ProcessingJob$ProcessingInputs' => '

List of input configurations for the processing job.

', ], ], 'ProcessingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', 'ProcessingClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', ], ], 'ProcessingInstanceType' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for debugging a training job.

', 'MonitoringClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProcessingClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProfilerRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for profiling a training job.

', ], ], 'ProcessingJob' => [ 'base' => '

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

', 'refs' => [ 'TrialComponentSourceDetail$ProcessingJob' => '

Information about a processing job that\'s the source of a trial component.

', ], ], 'ProcessingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'DebugRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', 'DescribeProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'MonitoringExecutionSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', 'ProcessingJob$ProcessingJobArn' => '

The ARN of the processing job.

', 'ProcessingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'ProcessingJobSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job..

', 'ProfilerRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', ], ], 'ProcessingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DataQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the data quality monitoring job.

', 'DescribeProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeProcessingJobResponse$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ModelBiasBaselineConfig$BaseliningJobName' => '

The name of the baseline model bias job.

', 'ModelExplainabilityBaselineConfig$BaseliningJobName' => '

The name of the baseline model explainability job.

', 'ModelQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'MonitoringBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'ProcessingJob$ProcessingJobName' => '

The name of the processing job.

', 'ProcessingJobSummary$ProcessingJobName' => '

The name of the processing job.

', 'StopProcessingJobRequest$ProcessingJobName' => '

The name of the processing job to stop.

', ], ], 'ProcessingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ProcessingJobStatus' => '

Provides the status of a processing job.

', 'ListProcessingJobsRequest$StatusEquals' => '

A filter that retrieves only processing jobs with a specific status.

', 'ProcessingJob$ProcessingJobStatus' => '

The status of the processing job.

', 'ProcessingJobSummary$ProcessingJobStatus' => '

The status of the processing job.

', ], ], 'ProcessingJobStepMetadata' => [ 'base' => '

Metadata for a processing job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$ProcessingJob' => '

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

', ], ], 'ProcessingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProcessingJobsResponse$ProcessingJobSummaries' => '

An array of ProcessingJobSummary objects, each listing a processing job.

', ], ], 'ProcessingJobSummary' => [ 'base' => '

Summary of information about a processing job.

', 'refs' => [ 'ProcessingJobSummaries$member' => NULL, ], ], 'ProcessingLocalPath' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$LocalPath' => '

Path to the filesystem where the batch transform data is available to the container.

', 'DatasetDefinition$LocalPath' => '

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

', 'EndpointInput$LocalPath' => '

Path to the filesystem where the endpoint data is available to the container.

', 'MonitoringS3Output$LocalPath' => '

The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

', 'ProcessingS3Input$LocalPath' => '

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

', 'ProcessingS3Output$LocalPath' => '

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container\'s entrypoint is invoked.

', ], ], 'ProcessingMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ProcessingStoppingCondition$MaxRuntimeInSeconds' => '

Specifies the maximum runtime in seconds.

', ], ], 'ProcessingOutput' => [ 'base' => '

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

', 'refs' => [ 'ProcessingOutputs$member' => NULL, ], ], 'ProcessingOutputConfig' => [ 'base' => '

Configuration for uploading output from the processing container.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'DescribeProcessingJobResponse$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'ProcessingJob$ProcessingOutputConfig' => NULL, ], ], 'ProcessingOutputs' => [ 'base' => NULL, 'refs' => [ 'ProcessingOutputConfig$Outputs' => '

An array of outputs configuring the data to upload from the processing container.

', ], ], 'ProcessingResources' => [ 'base' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'DescribeProcessingJobResponse$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'ProcessingJob$ProcessingResources' => NULL, ], ], 'ProcessingS3CompressionType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3CompressionType' => '

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

', ], ], 'ProcessingS3DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

', 'EndpointInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

', 'ProcessingS3Input$S3DataDistributionType' => '

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

', ], ], 'ProcessingS3DataType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3DataType' => '

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

', ], ], 'ProcessingS3Input' => [ 'base' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', 'refs' => [ 'ProcessingInput$S3Input' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', ], ], 'ProcessingS3InputMode' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'EndpointInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'ProcessingS3Input$S3InputMode' => '

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

', ], ], 'ProcessingS3Output' => [ 'base' => '

Configuration for uploading output data to Amazon S3 from the processing container.

', 'refs' => [ 'ProcessingOutput$S3Output' => '

Configuration for processing job outputs in Amazon S3.

', ], ], 'ProcessingS3UploadMode' => [ 'base' => NULL, 'refs' => [ 'MonitoringS3Output$S3UploadMode' => '

Whether to upload the results of the monitoring job continuously or after the job completes.

', 'ProcessingS3Output$S3UploadMode' => '

Whether to upload the results of the processing job continuously or after the job completes.

', ], ], 'ProcessingStoppingCondition' => [ 'base' => '

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

', 'refs' => [ 'CreateProcessingJobRequest$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'DescribeProcessingJobResponse$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'ProcessingJob$StoppingCondition' => NULL, ], ], 'ProcessingVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

', 'ProcessingClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can\'t request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

', ], ], 'Processor' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'DescribeImageVersionResponse$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'UpdateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', ], ], 'ProductId' => [ 'base' => NULL, 'refs' => [ 'DescribeAlgorithmOutput$ProductId' => '

The product identifier of the algorithm.

', 'ModelPackageContainerDefinition$ProductId' => '

The Amazon Web Services Marketplace product ID of the model package.

', ], ], 'ProductListings' => [ 'base' => NULL, 'refs' => [ 'Workteam$ProductListingIds' => '

The Amazon Marketplace identifier for a vendor\'s work team.

', ], ], 'ProductionVariant' => [ 'base' => '

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

', 'refs' => [ 'ProductionVariantList$member' => NULL, ], ], 'ProductionVariantAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'ProductionVariant$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', 'ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', ], ], 'ProductionVariantCoreDumpConfig' => [ 'base' => '

Specifies configuration for a core dump from the model container when the process crashes.

', 'refs' => [ 'ProductionVariant$CoreDumpConfig' => '

Specifies configuration for a core dump from the model container when the process crashes.

', ], ], 'ProductionVariantInstanceType' => [ 'base' => NULL, 'refs' => [ 'EndpointInputConfiguration$InstanceType' => '

The instance types to use for the load test.

', 'EndpointOutputConfiguration$InstanceType' => '

The instance type recommended by Amazon SageMaker Inference Recommender.

', 'PendingProductionVariantSummary$InstanceType' => '

The type of instances associated with the variant.

', 'ProductionVariant$InstanceType' => '

The ML compute instance type.

', 'RealTimeInferenceRecommendation$InstanceType' => '

The recommended instance type for Real-Time Inference.

', 'RealtimeInferenceInstanceTypes$member' => NULL, ], ], 'ProductionVariantList' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'CreateEndpointConfigInput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

', 'DescribeEndpointConfigOutput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'DescribeEndpointConfigOutput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', ], ], 'ProductionVariantManagedInstanceScaling' => [ 'base' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'refs' => [ 'PendingProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariant$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

', 'ProductionVariant$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

', ], ], 'ProductionVariantRoutingConfig' => [ 'base' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'refs' => [ 'PendingProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariant$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', ], ], 'ProductionVariantSSMAccess' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$EnableSSMAccess' => '

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

', ], ], 'ProductionVariantServerlessConfig' => [ 'base' => '

Specifies the serverless configuration for an endpoint variant.

', 'refs' => [ 'EndpointInputConfiguration$ServerlessConfig' => NULL, 'EndpointOutputConfiguration$ServerlessConfig' => NULL, 'PendingProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'PendingProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

', 'ProductionVariant$ServerlessConfig' => '

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

', 'ProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'ProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for the endpoint update.

', ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'base' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', 'refs' => [ 'DesiredWeightAndCapacity$ServerlessUpdateConfig' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', ], ], 'ProductionVariantStatus' => [ 'base' => '

Describes the status of the production variant.

', 'refs' => [ 'ProductionVariantStatusList$member' => NULL, ], ], 'ProductionVariantStatusList' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', 'ProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', ], ], 'ProductionVariantSummary' => [ 'base' => '

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

', 'refs' => [ 'ProductionVariantSummaryList$member' => NULL, ], ], 'ProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$ProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

', 'DescribeEndpointOutput$ShadowProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', 'Endpoint$ProductionVariants' => '

A list of the production variants hosted on the endpoint. Each production variant is a model.

', 'Endpoint$ShadowProductionVariants' => '

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

', ], ], 'ProductionVariantVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

', ], ], 'ProfilerConfig' => [ 'base' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', 'refs' => [ 'CreateTrainingJobRequest$ProfilerConfig' => NULL, 'DescribeTrainingJobResponse$ProfilerConfig' => NULL, 'TrainingJob$ProfilerConfig' => NULL, ], ], 'ProfilerConfigForUpdate' => [ 'base' => '

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

', 'refs' => [ 'UpdateTrainingJobRequest$ProfilerConfig' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', ], ], 'ProfilerRuleConfiguration' => [ 'base' => '

Configuration information for profiling rules.

', 'refs' => [ 'ProfilerRuleConfigurations$member' => NULL, ], ], 'ProfilerRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'DescribeTrainingJobResponse$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'UpdateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', ], ], 'ProfilerRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'ProfilerRuleEvaluationStatuses$member' => NULL, ], ], 'ProfilerRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

', ], ], 'ProfilingIntervalInMilliseconds' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', 'ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', ], ], 'ProfilingParameters' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'ProfilerConfigForUpdate$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'ProfilingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilingStatus' => '

Profiling status of a training job.

', ], ], 'ProgrammingLang' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', 'DescribeImageVersionResponse$ProgrammingLang' => '

The supported programming language and its version.

', 'UpdateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', ], ], 'Project' => [ 'base' => '

The properties of a project as returned by the Search API.

', 'refs' => [ 'SearchRecord$Project' => '

The properties of a project.

', ], ], 'ProjectArn' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'DescribeProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'Project$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'ProjectSummary$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'UpdateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', ], ], 'ProjectEntityName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$ProjectName' => '

The name of the project.

', 'DeleteProjectInput$ProjectName' => '

The name of the project to delete.

', 'DescribeProjectInput$ProjectName' => '

The name of the project to describe.

', 'DescribeProjectOutput$ProjectName' => '

The name of the project.

', 'ListProjectsInput$NameContains' => '

A filter that returns the projects whose name contains a specified string.

', 'Project$ProjectName' => '

The name of the project.

', 'ProjectSummary$ProjectName' => '

The name of the project.

', 'UpdateProjectInput$ProjectName' => '

The name of the project.

', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectId' => '

The ID of the new project.

', 'DescribeProjectOutput$ProjectId' => '

The ID of the project.

', 'Project$ProjectId' => '

The ID of the project.

', 'ProjectSummary$ProjectId' => '

The ID of the project.

', ], ], 'ProjectSortBy' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ProjectSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'ProjectStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProjectOutput$ProjectStatus' => '

The status of the project.

', 'Project$ProjectStatus' => '

The status of the project.

', 'ProjectSummary$ProjectStatus' => '

The status of the project.

', ], ], 'ProjectSummary' => [ 'base' => '

Information about a project.

', 'refs' => [ 'ProjectSummaryList$member' => NULL, ], ], 'ProjectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListProjectsOutput$ProjectSummaryList' => '

A list of summaries of projects.

', ], ], 'PropertyNameHint' => [ 'base' => NULL, 'refs' => [ 'PropertyNameQuery$PropertyNameHint' => '

Text that begins a property\'s name.

', ], ], 'PropertyNameQuery' => [ 'base' => '

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

', 'refs' => [ 'SuggestionQuery$PropertyNameQuery' => '

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

', ], ], 'PropertyNameSuggestion' => [ 'base' => '

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

', 'refs' => [ 'PropertyNameSuggestionList$member' => NULL, ], ], 'PropertyNameSuggestionList' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsResponse$PropertyNameSuggestions' => '

A list of property names for a Resource that match a SuggestionQuery.

', ], ], 'ProvisionedProductStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductStatusMessage' => '

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', ], ], 'ProvisioningParameter' => [ 'base' => '

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Key' => '

The key that identifies a provisioning parameter.

', ], ], 'ProvisioningParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => '

The value of the provisioning parameter.

', ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisioningDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', ], ], 'PublicWorkforceTaskPrice' => [ 'base' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

', 'refs' => [ 'HumanLoopConfig$PublicWorkforceTaskPrice' => NULL, 'HumanTaskConfig$PublicWorkforceTaskPrice' => '

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

', ], ], 'PutModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'QualityCheckStepMetadata' => [ 'base' => '

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$QualityCheck' => '

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The Boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'QueryFilters' => [ 'base' => '

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

', 'refs' => [ 'QueryLineageRequest$Filters' => '

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities\' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

', ], ], 'QueryLineageMaxDepth' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxDepth' => '

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

', ], ], 'QueryLineageMaxResults' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxResults' => '

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'QueryLineageRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageStartArns' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$StartArns' => '

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

', ], ], 'QueryLineageTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$LineageTypes' => '

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

', ], ], 'QueryProperties' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Properties' => '

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

', ], ], 'QueryTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Types' => '

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

', ], ], 'RSessionAppSettings' => [ 'base' => '

A collection of settings that apply to an RSessionGateway app.

', 'refs' => [ 'UserSettings$RSessionAppSettings' => '

A collection of settings that configure the RSessionGateway app.

', ], ], 'RStudioServerProAccessStatus' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$AccessStatus' => '

Indicates whether the current user has access to the RStudioServerPro app.

', ], ], 'RStudioServerProAppSettings' => [ 'base' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', 'refs' => [ 'UserSettings$RStudioServerProAppSettings' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', ], ], 'RStudioServerProDomainSettings' => [ 'base' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettings$RStudioServerProDomainSettings' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'base' => '

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettingsForUpdate$RStudioServerProDomainSettingsForUpdate' => '

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

', ], ], 'RStudioServerProUserGroup' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$UserGroup' => '

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

', ], ], 'RandomSeed' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$RandomSeed' => '

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

', ], ], 'RealTimeInferenceConfig' => [ 'base' => '

The infrastructure configuration for deploying the model to a real-time inference endpoint.

', 'refs' => [ 'ModelInfrastructureConfig$RealTimeInferenceConfig' => '

The infrastructure configuration for deploying the model to real-time inference.

', ], ], 'RealTimeInferenceRecommendation' => [ 'base' => '

The recommended configuration to use for Real-Time Inference.

', 'refs' => [ 'RealTimeInferenceRecommendations$member' => NULL, ], ], 'RealTimeInferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RealTimeInferenceRecommendations' => '

A list of RealTimeInferenceRecommendation items.

', ], ], 'RealtimeInferenceInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', 'InferenceSpecification$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'RecommendationFailureReason' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInferenceBenchmark$FailureReason' => '

The reason why a benchmark failed.

', ], ], 'RecommendationJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'InferenceRecommendationsJob$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', ], ], 'RecommendationJobCompilationJobName' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$CompilationJobName' => '

The name of the compilation job used to create the recommended model artifacts.

', ], ], 'RecommendationJobCompiledOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'RecommendationJobOutputConfig$CompiledOutputConfig' => '

Provides information about the output configuration for the compiled model.

', ], ], 'RecommendationJobContainerConfig' => [ 'base' => '

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don\'t want to edit them in your model package.

', 'refs' => [ 'RecommendationJobInputConfig$ContainerConfig' => '

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

', ], ], 'RecommendationJobDataInputConfig' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

', ], ], 'RecommendationJobDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobDescription' => '

Description of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobDescription' => '

The job description that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobDescription' => '

The job description.

', ], ], 'RecommendationJobFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$FrameworkVersion' => '

The framework version of the container image.

', ], ], 'RecommendationJobInferenceBenchmark' => [ 'base' => '

The details for a specific benchmark from an Inference Recommender job.

', 'refs' => [ 'InferenceRecommendationsJobStep$InferenceBenchmark' => '

The details for a specific benchmark.

', ], ], 'RecommendationJobInputConfig' => [ 'base' => '

The input configuration of the recommendation job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$InputConfig' => '

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

', 'DescribeInferenceRecommendationsJobResponse$InputConfig' => '

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

', ], ], 'RecommendationJobName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobName' => '

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

', 'DescribeInferenceRecommendationsJobRequest$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeInferenceRecommendationsJobResponse$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'InferenceRecommendationsJob$JobName' => '

The name of the job.

', 'InferenceRecommendationsJobStep$JobName' => '

The name of the Inference Recommender job.

', 'ListInferenceRecommendationsJobStepsRequest$JobName' => '

The name for the Inference Recommender job.

', 'StopInferenceRecommendationsJobRequest$JobName' => '

The name of the job you want to stop.

', ], ], 'RecommendationJobOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$OutputConfig' => '

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

', ], ], 'RecommendationJobPayloadConfig' => [ 'base' => '

The configuration for the payload for a recommendation job.

', 'refs' => [ 'RecommendationJobContainerConfig$PayloadConfig' => '

Specifies the SamplePayloadUrl and all other sample payload-related fields.

', ], ], 'RecommendationJobResourceLimit' => [ 'base' => '

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

', 'refs' => [ 'RecommendationJobInputConfig$ResourceLimit' => '

Defines the resource limit of the job.

', ], ], 'RecommendationJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$Status' => '

The status of the job.

', 'InferenceRecommendationsJob$Status' => '

The status of the job.

', 'InferenceRecommendationsJobStep$Status' => '

The current status of the benchmark.

', 'ListInferenceRecommendationsJobStepsRequest$Status' => '

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

', 'ListInferenceRecommendationsJobsRequest$StatusEquals' => '

A filter that retrieves only inference recommendations jobs with a specific status.

', ], ], 'RecommendationJobStoppingConditions' => [ 'base' => '

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$StoppingConditions' => '

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

', 'DescribeInferenceRecommendationsJobResponse$StoppingConditions' => '

The stopping conditions that you provided when you initiated the job.

', ], ], 'RecommendationJobSupportedContentType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedContentTypes$member' => NULL, ], ], 'RecommendationJobSupportedContentTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobPayloadConfig$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'RecommendationJobSupportedEndpointType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedEndpointType' => '

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedResponseMIMETypes$member' => NULL, ], ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RecommendationJobType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobType' => '

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

', 'DescribeInferenceRecommendationsJobResponse$JobType' => '

The job type that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobType' => '

The recommendation job type.

', ], ], 'RecommendationJobVpcConfig' => [ 'base' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', 'refs' => [ 'RecommendationJobInputConfig$VpcConfig' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSecurityGroupIds$member' => NULL, ], ], 'RecommendationJobVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'RecommendationJobVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSubnets$member' => NULL, ], ], 'RecommendationJobVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your model.

', ], ], 'RecommendationMetrics' => [ 'base' => '

The metrics of recommendations.

', 'refs' => [ 'InferenceRecommendation$Metrics' => '

The metrics used to decide what recommendation to make.

', 'RecommendationJobInferenceBenchmark$Metrics' => NULL, ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RecommendationStatus' => '

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

', ], ], 'RecommendationStepType' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendationsJobStep$StepType' => '

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobStepsRequest$StepType' => '

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', ], ], 'RecordWrapper' => [ 'base' => NULL, 'refs' => [ 'Channel$RecordWrapperType' => '

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don\'t need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

', ], ], 'RedshiftClusterId' => [ 'base' => '

The Redshift cluster Identifier.

', 'refs' => [ 'RedshiftDatasetDefinition$ClusterId' => NULL, ], ], 'RedshiftDatabase' => [ 'base' => '

The name of the Redshift database used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$Database' => NULL, ], ], 'RedshiftDatasetDefinition' => [ 'base' => '

Configuration for Redshift Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$RedshiftDatasetDefinition' => NULL, ], ], 'RedshiftQueryString' => [ 'base' => '

The SQL query statements to be executed.

', 'refs' => [ 'RedshiftDatasetDefinition$QueryString' => NULL, ], ], 'RedshiftResultCompressionType' => [ 'base' => '

The compression used for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputCompression' => NULL, ], ], 'RedshiftResultFormat' => [ 'base' => '

The data storage format for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputFormat' => NULL, ], ], 'RedshiftUserName' => [ 'base' => '

The database user name used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$DbUser' => NULL, ], ], 'RegisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterModelStepMetadata' => [ 'base' => '

Metadata for a register model job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$RegisterModel' => '

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', 'DescribeImageVersionResponse$ReleaseNotes' => '

The maintainer description of the image version.

', 'UpdateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', ], ], 'RemoteDebugConfig' => [ 'base' => '

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'CreateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'DescribeTrainingJobResponse$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RemoteDebugConfigForUpdate' => [ 'base' => '

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'UpdateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RenderUiTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RenderUiTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderableTask' => [ 'base' => '

Contains input values for a task.

', 'refs' => [ 'RenderUiTemplateRequest$Task' => '

A RenderableTask object containing a representative task to render.

', ], ], 'RenderingError' => [ 'base' => '

A description of an error that occurred while rendering the template.

', 'refs' => [ 'RenderingErrorList$member' => NULL, ], ], 'RenderingErrorList' => [ 'base' => NULL, 'refs' => [ 'RenderUiTemplateResponse$Errors' => '

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

', ], ], 'RepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'ImageConfig$RepositoryAccessMode' => '

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.

  • Vpc - The model image is hosted in a private Docker registry in your VPC.

', ], ], 'RepositoryAuthConfig' => [ 'base' => '

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

', 'refs' => [ 'ImageConfig$RepositoryAuthConfig' => '

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

', ], ], 'RepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'RepositoryAuthConfig$RepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

', ], ], 'RepositoryUrl' => [ 'base' => NULL, 'refs' => [ 'CodeRepository$RepositoryUrl' => '

The URL of the Git repository.

', ], ], 'ResolvedAttributes' => [ 'base' => '

The resolved attributes.

', 'refs' => [ 'DescribeAutoMLJobResponse$ResolvedAttributes' => '

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to tag.

', 'DeleteTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

', 'ListTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

', ], ], 'ResourceCatalog' => [ 'base' => '

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'ResourceCatalogList$member' => NULL, ], ], 'ResourceCatalogArn' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$ResourceCatalogArn' => '

The Amazon Resource Name (ARN) of the ResourceCatalog.

', ], ], 'ResourceCatalogDescription' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$Description' => '

A free form description of the ResourceCatalog.

', ], ], 'ResourceCatalogList' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsResponse$ResourceCatalogs' => '

A list of the requested ResourceCatalogs.

', ], ], 'ResourceCatalogName' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$NameContains' => '

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

', 'ResourceCatalog$ResourceCatalogName' => '

The name of the ResourceCatalog.

', ], ], 'ResourceCatalogSortBy' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortBy' => '

The value on which the resource catalog list is sorted.

', ], ], 'ResourceCatalogSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortOrder' => '

The order in which the resource catalogs are listed.

', ], ], 'ResourceConfig' => [ 'base' => '

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

', 'refs' => [ 'CreateTrainingJobRequest$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

', 'DescribeTrainingJobResponse$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'HyperParameterTrainingJobDefinition$ResourceConfig' => '

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

', 'TrainingJob$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'TrainingJobDefinition$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

', ], ], 'ResourceConfigForUpdate' => [ 'base' => '

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

', 'refs' => [ 'UpdateTrainingJobRequest$ResourceConfig' => '

The training job ResourceConfig to update warm pool retention length.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$HomeEfsFileSystemId' => '

The ID of the Amazon Elastic File System managed by this Domain.

', ], ], 'ResourceInUse' => [ 'base' => '

Resource being accessed is in use.

', 'refs' => [], ], 'ResourceLimitExceeded' => [ 'base' => '

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

', 'refs' => [], ], 'ResourceLimits' => [ 'base' => '

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

', 'refs' => [ 'HyperParameterTuningJobConfig$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

', ], ], 'ResourceNotFound' => [ 'base' => '

Resource being access is not found.

', 'refs' => [], ], 'ResourcePolicyString' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyResponse$ResourcePolicy' => '

The resource policy that gives access to the lineage group in another account.

', ], ], 'ResourcePropertyName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

', 'NestedFilters$NestedPropertyName' => '

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

', 'PropertyNameSuggestion$PropertyName' => '

A suggested property name based on what you entered in the search textbox in the SageMaker console.

', 'SearchRequest$SortBy' => '

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

', ], ], 'ResourceRetainedBillableTimeInSeconds' => [ 'base' => 'Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.', 'refs' => [ 'WarmPoolStatus$ResourceRetainedBillableTimeInSeconds' => '

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

', ], ], 'ResourceSpec' => [ 'base' => '

Specifies the ARN\'s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

', 'refs' => [ 'AppDetails$ResourceSpec' => NULL, 'CodeEditorAppSettings$DefaultResourceSpec' => NULL, 'CreateAppRequest$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

', 'DescribeAppResponse$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', 'JupyterLabAppSettings$DefaultResourceSpec' => NULL, 'JupyterServerAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

', 'KernelGatewayAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

', 'RSessionAppSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettingsForUpdate$DefaultResourceSpec' => NULL, 'SpaceCodeEditorAppSettings$DefaultResourceSpec' => NULL, 'SpaceJupyterLabAppSettings$DefaultResourceSpec' => NULL, 'TensorBoardAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsRequest$Resource' => '

The name of the SageMaker resource to search for.

', 'SearchRequest$Resource' => '

The name of the SageMaker resource to search for.

', ], ], 'ResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'ResponseMIMETypes$member' => NULL, ], ], 'ResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', 'InferenceSpecification$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RetentionPolicy' => [ 'base' => '

The retention policy for data stored on an Amazon Elastic File System volume.

', 'refs' => [ 'DeleteDomainRequest$RetentionPolicy' => '

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

', ], ], 'RetentionType' => [ 'base' => NULL, 'refs' => [ 'RetentionPolicy$HomeEfsFileSystem' => '

The default is Retain, which specifies to keep the data stored on the Amazon EFS volume.

Specify Delete to delete the data stored on the Amazon EFS volume.

', ], ], 'RetryPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetryPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetryStrategy' => [ 'base' => '

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

', 'refs' => [ 'CreateTrainingJobRequest$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'DescribeTrainingJobResponse$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'HyperParameterTrainingJobDefinition$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'TrainingJob$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationRole' => '

The IAM roles that SageMaker uses to run the training jobs.

', 'ClusterInstanceGroupDetails$ExecutionRole' => '

The execution role for the instance group to assume.

', 'ClusterInstanceGroupSpecification$ExecutionRole' => '

Specifies an IAM execution role to be assumed by the instance group.

', 'CreateAutoMLJobRequest$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateAutoMLJobV2Request$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateCompilationJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

', 'CreateDataQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'CreateEdgePackagingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

', 'CreateEndpointConfigInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

', 'CreateFeatureGroupRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'CreateFlowDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

', 'CreateImageRequest$RoleArn' => '

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateInferenceExperimentRequest$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'CreateInferenceRecommendationsJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateLabelingJobRequest$RoleArn' => '

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

', 'CreateModelBiasJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelExplainabilityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreateModelQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateNotebookInstanceInput$RoleArn' => '

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

', 'CreateProcessingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateTrainingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'DefaultSpaceSettings$ExecutionRole' => '

The ARN of the execution role for the space.

', 'DescribeAutoMLJobResponse$RoleArn' => '

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeAutoMLJobV2Response$RoleArn' => '

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeCompilationJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

', 'DescribeDataQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeDeviceFleetResponse$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'DescribeEdgePackagingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

', 'DescribeEndpointConfigOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

', 'DescribeFeatureGroupResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'DescribeFlowDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

', 'DescribeImageResponse$RoleArn' => '

The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'DescribeInferenceExperimentResponse$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'DescribeInferenceRecommendationsJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

', 'DescribeLabelingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

', 'DescribeModelBiasJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelExplainabilityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'DescribeModelQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeNotebookInstanceOutput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

', 'DescribePipelineResponse$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'DescribeProcessingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeTrainingJobResponse$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'FeatureGroup$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

', 'GenerativeAiSettings$AmazonBedrockRoleArn' => '

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

', 'HyperParameterTrainingJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

', 'InferenceExperimentSummary$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'InferenceRecommendationsJob$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'Model$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'ModelPackageValidationSpecification$ValidationRole' => '

The IAM roles to be used for the validation of the model package.

', 'ModelRegisterSettings$CrossAccountModelRegisterRoleArn' => '

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

', 'MonitoringJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'Pipeline$RoleArn' => '

The Amazon Resource Name (ARN) of the role that created the pipeline.

', 'PipelineSummary$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline used to execute.

', 'ProcessingJob$RoleArn' => '

The ARN of the role used to create the processing job.

', 'RStudioServerProDomainSettings$DomainExecutionRoleArn' => '

The ARN of the execution role for the RStudioServerPro Domain-level app.

', 'RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn' => '

The execution role for the RStudioServerPro Domain-level app.

', 'RedshiftDatasetDefinition$ClusterRoleArn' => '

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

', 'RenderUiTemplateRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

', 'TimeSeriesForecastingSettings$AmazonForecastRoleArn' => '

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

', 'TrainingJob$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'UpdateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the device.

', 'UpdateImageRequest$RoleArn' => '

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'UpdateNotebookInstanceInput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'UpdatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'UserSettings$ExecutionRole' => '

The execution role for the user.

', ], ], 'RollingUpdatePolicy' => [ 'base' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', 'refs' => [ 'DeploymentConfig$RollingUpdatePolicy' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', ], ], 'RootAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'DescribeNotebookInstanceOutput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'UpdateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don\'t have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

', ], ], 'RoutingStrategy' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantRoutingConfig$RoutingStrategy' => '

Sets how the endpoint routes incoming traffic:

  • LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.

  • RANDOM: The endpoint routes each request to a randomly chosen instance.

', ], ], 'RuleConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'DebugRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', 'ProfilerRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'ProfilerRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', ], ], 'RuleEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', 'ProfilerRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', ], ], 'RuleParameters' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', 'ProfilerRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', ], ], 'S3DataDistribution' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataDistributionType' => '

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don\'t choose more ML compute instances for training than available S3 objects. If you do, some nodes won\'t get any data and you will pay for nodes that aren\'t getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

', ], ], 'S3DataSource' => [ 'base' => '

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

', 'refs' => [ 'DataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'S3DataType' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel\'s input mode is Pipe.

', 'TransformS3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

', ], ], 'S3ModelDataSource' => [ 'base' => '

Specifies the S3 location of ML model data to deploy.

', 'refs' => [ 'ModelDataSource$S3DataSource' => '

Specifies the S3 location of ML model data to deploy.

', ], ], 'S3ModelDataType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3DataType' => '

Specifies the type of ML model data to deploy.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.

', ], ], 'S3ModelUri' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3Uri' => '

Specifies the S3 path of ML model data to deploy.

', ], ], 'S3OutputPath' => [ 'base' => NULL, 'refs' => [ 'HubS3StorageConfig$S3OutputPath' => '

The Amazon S3 bucket prefix for hosting hub content.

', ], ], 'S3StorageConfig' => [ 'base' => '

The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$S3StorageConfig' => '

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3Uri' => '

The uniform resource identifier (URI) used to identify an additional data source used in inference or training.

', 'AthenaDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where Athena query results are stored.

', 'AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'AutoMLOutputDataConfig$S3OutputPath' => '

The Amazon S3 output path. Must be 128 characters or less.

', 'AutoMLS3DataSource$S3Uri' => '

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.

', 'BatchDataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'CheckpointConfig$S3Uri' => '

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

', 'ClusterLifeCycleConfig$SourceS3Uri' => '

An Amazon S3 bucket path where your lifecycle scripts are stored.

Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.

', 'CreateLabelingJobRequest$LabelCategoryConfigS3Uri' => '

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to "labels", you must provide worker instructions in the label category configuration file using the "instructions" parameter: "instructions": {"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

"document-version": "2018-11-28",

"labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.

  • Each label category must be unique, you cannot specify duplicate label categories.

  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

', 'CreateModelPackageInput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

', 'DataQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'DataQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'DebugHookConfig$S3OutputPath' => '

Path to Amazon S3 storage location for metrics and tensors.

', 'DebugRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'DescribeEdgePackagingJobResponse$ModelArtifact' => '

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

', 'DescribeLabelingJobResponse$LabelCategoryConfigS3Uri' => '

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

', 'EdgeOutputConfig$S3OutputLocation' => '

The Amazon Simple Storage (S3) bucker URI.

', 'FileSource$S3Uri' => '

The Amazon S3 URI for the file source.

', 'FlowDefinitionOutputConfig$S3OutputPath' => '

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

', 'InferenceRecommendationsJob$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InputConfig$S3Uri' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'LabelingJobOutput$OutputDatasetS3Uri' => '

The Amazon S3 bucket location of the manifest file for labeled data.

', 'LabelingJobOutputConfig$S3OutputPath' => '

The Amazon S3 location to write output data.

', 'LabelingJobS3DataSource$ManifestS3Uri' => '

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.

  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

', 'MetricsSource$S3Uri' => '

The S3 URI for the metrics source.

', 'ModelArtifacts$S3ModelArtifacts' => '

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

', 'ModelBiasAppSpecification$ConfigUri' => '

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

', 'ModelCardExportArtifacts$S3ExportArtifacts' => '

The Amazon S3 URI of the exported model artifacts.

', 'ModelCardExportOutputConfig$S3OutputPath' => '

The Amazon S3 output path to export your model card PDF.

', 'ModelExplainabilityAppSpecification$ConfigUri' => '

JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

', 'ModelQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringConstraintsResource$S3Uri' => '

The Amazon S3 URI for the constraints resource.

', 'MonitoringStatisticsResource$S3Uri' => '

The Amazon S3 URI for the statistics resource.

', 'OutputConfig$S3OutputLocation' => '

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'OutputDataConfig$S3OutputPath' => '

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'ProcessingS3Input$S3Uri' => '

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

', 'ProcessingS3Output$S3Uri' => '

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

', 'ProfilerConfig$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerConfigForUpdate$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'RecommendationJobCompiledOutputConfig$S3OutputUri' => '

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

', 'RecommendationJobPayloadConfig$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'RedshiftDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where the Redshift query results are stored.

', 'S3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same Amazon Web Services region as your training job.

', 'S3StorageConfig$S3Uri' => '

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

', 'S3StorageConfig$ResolvedOutputS3Uri' => '

The S3 path where offline records are written.

', 'SharingSettings$S3OutputPath' => '

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

', 'TabularJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'TensorBoardOutputConfig$S3OutputPath' => '

Path to Amazon S3 storage location for TensorBoard output.

', 'TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.

You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

Autopilot supports the following data types: numeric, categorical, text, and datetime.

These column keys must not include any column set in TimeSeriesConfig.

', 'TransformOutput$S3OutputPath' => '

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn\'t upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

', 'TransformS3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

', 'UiConfig$UiTemplateS3Uri' => '

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

', 'WorkspaceSettings$S3ArtifactPath' => '

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

', ], ], 'SageMakerImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'DeleteImageVersionRequest$Alias' => '

The alias of the image to delete.

', 'DescribeImageVersionRequest$Alias' => '

The alias of the image version.

', 'ListAliasesRequest$Alias' => '

The alias of the image version.

', 'SageMakerImageVersionAliases$member' => NULL, 'UpdateImageVersionRequest$Alias' => '

The alias of the image version.

', ], ], 'SageMakerImageVersionAliases' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Aliases' => '

A list of aliases created with the image version.

', 'ListAliasesResponse$SageMakerImageVersionAliases' => '

A list of SageMaker image version aliases.

', 'UpdateImageVersionRequest$AliasesToAdd' => '

A list of aliases to add.

', 'UpdateImageVersionRequest$AliasesToDelete' => '

A list of aliases to delete.

', ], ], 'SagemakerServicecatalogStatus' => [ 'base' => NULL, 'refs' => [ 'GetSagemakerServicecatalogPortfolioStatusOutput$Status' => '

Whether Service Catalog is enabled or disabled in SageMaker.

', ], ], 'SampleWeightAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', 'TabularJobConfig$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', ], ], 'SamplingPercentage' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$InitialSamplingPercentage' => '

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

', 'DataCaptureConfigSummary$CurrentSamplingPercentage' => '

The percentage of requests being captured by your Endpoint.

', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'DynamicScalingConfiguration$ScalingPolicies' => '

An object of the scaling policies for each metric.

', ], ], 'ScalingPolicy' => [ 'base' => '

An object containing a recommended scaling policy.

', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingPolicyMetric' => [ 'base' => '

The metric for a scaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$Metric' => '

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

', ], ], 'ScalingPolicyObjective' => [ 'base' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'refs' => [ 'GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective' => '

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

', ], ], 'ScheduleConfig' => [ 'base' => '

Configuration details about the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleConfig$ScheduleConfig' => '

Configures the monitoring schedule.

', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduleConfig$ScheduleExpression' => '

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

    NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)

  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

  • Every two hours starting at midnight: cron(0 0/2 ? * * *)

  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

', ], ], 'ScheduleStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringScheduleStatus' => '

The status of an monitoring job.

', 'ListMonitoringSchedulesRequest$StatusEquals' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

', 'MonitoringScheduleSummary$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', ], ], 'SearchExpression' => [ 'base' => '

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

', 'refs' => [ 'SearchExpressionList$member' => NULL, 'SearchRequest$SearchExpression' => '

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

', ], ], 'SearchExpressionList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$SubExpressions' => '

A list of search expression objects.

', ], ], 'SearchRecord' => [ 'base' => '

A single resource returned as part of the Search API response.

', 'refs' => [ 'SearchResultsList$member' => NULL, ], ], 'SearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResultsList' => [ 'base' => NULL, 'refs' => [ 'SearchResponse$Results' => '

A list of SearchRecord objects.

', ], ], 'SearchSortOrder' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$SortOrder' => '

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

', ], ], 'SecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

', 'SecondaryStatusTransition$Status' => '

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', 'TrainingJob$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', ], ], 'SecondaryStatusTransition' => [ 'base' => '

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job\'s secondary status.

', 'refs' => [ 'SecondaryStatusTransitions$member' => NULL, ], ], 'SecondaryStatusTransitions' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', 'TrainingJob$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'GitConfig$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'GitConfigForUpdate$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'IdentityProviderOAuthSetting$SecretArn' => '

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SecurityGroupIdForDomainBoundary' => '

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

', 'DomainSecurityGroupIds$member' => NULL, 'SecurityGroupIds$member' => NULL, 'VpcSecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'DefaultSpaceSettings$SecurityGroups' => '

The security group IDs for the Amazon VPC that the space uses for communication.

', 'DescribeNotebookInstanceOutput$SecurityGroups' => '

The IDs of the VPC security groups.

', 'UserSettings$SecurityGroups' => '

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

', ], ], 'Seed' => [ 'base' => NULL, 'refs' => [ 'ShuffleConfig$Seed' => '

Determines the shuffling order in ShuffleConfig value.

', ], ], 'SelectedStep' => [ 'base' => '

A step selected to run in selective execution mode.

', 'refs' => [ 'SelectedStepList$member' => NULL, ], ], 'SelectedStepList' => [ 'base' => NULL, 'refs' => [ 'SelectiveExecutionConfig$SelectedSteps' => '

A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

', ], ], 'SelectiveExecutionConfig' => [ 'base' => '

The selective execution configuration applied to the pipeline run.

', 'refs' => [ 'DescribePipelineExecutionResponse$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'PipelineExecution$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'StartPipelineExecutionRequest$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', ], ], 'SelectiveExecutionResult' => [ 'base' => '

The ARN from an execution of the current pipeline.

', 'refs' => [ 'PipelineExecutionStep$SelectiveExecutionResult' => '

The ARN from an execution of the current pipeline from which results are reused for this step.

', ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepFailureResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerlessMaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MaxConcurrency' => '

The maximum number of concurrent invocations your serverless endpoint can process.

', 'ProductionVariantServerlessUpdateConfig$MaxConcurrency' => '

The updated maximum number of concurrent invocations your serverless endpoint can process.

', ], ], 'ServerlessMemorySizeInMB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MemorySizeInMB' => '

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

', ], ], 'ServerlessProvisionedConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$ProvisionedConcurrency' => '

The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.

', 'ProductionVariantServerlessUpdateConfig$ProvisionedConcurrency' => '

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

', ], ], 'ServiceCatalogEntityId' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductId' => '

The ID of the provisioned product.

', 'ServiceCatalogProvisioningDetails$ProductId' => '

The ID of the product to provision.

', 'ServiceCatalogProvisioningDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', 'ServiceCatalogProvisioningDetails$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', ], ], 'ServiceCatalogProvisionedProductDetails' => [ 'base' => '

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'DescribeProjectOutput$ServiceCatalogProvisionedProductDetails' => '

Information about a provisioned service catalog product.

', 'Project$ServiceCatalogProvisionedProductDetails' => NULL, ], ], 'ServiceCatalogProvisioningDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'CreateProjectInput$ServiceCatalogProvisioningDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', 'DescribeProjectOutput$ServiceCatalogProvisioningDetails' => '

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'Project$ServiceCatalogProvisioningDetails' => NULL, ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', ], ], 'SessionChainingConfig' => [ 'base' => '

Contains information about attribute-based access control (ABAC) for a training job.

', 'refs' => [ 'CreateTrainingJobRequest$SessionChainingConfig' => '

Contains information about attribute-based access control (ABAC) for the training job.

', ], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds' => '

The session expiration duration in seconds. This value defaults to 43200.

', 'CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds' => '

The duration of the session, in seconds. The default is 12 hours.

', ], ], 'ShadowModeConfig' => [ 'base' => '

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

', 'refs' => [ 'CreateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', 'DescribeInferenceExperimentResponse$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

', 'UpdateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', ], ], 'ShadowModelVariantConfig' => [ 'base' => '

The name and sampling percentage of a shadow variant.

', 'refs' => [ 'ShadowModelVariantConfigList$member' => NULL, ], ], 'ShadowModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'ShadowModeConfig$ShadowModelVariants' => '

List of shadow variant configurations.

', ], ], 'SharingSettings' => [ 'base' => '

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn\'t allowed.

', 'refs' => [ 'UserSettings$SharingSettings' => '

Specifies options for sharing Amazon SageMaker Studio notebooks.

', ], ], 'SharingType' => [ 'base' => NULL, 'refs' => [ 'SpaceSharingSettings$SharingType' => '

Specifies the sharing type of the space.

', 'SpaceSharingSettingsSummary$SharingType' => '

Specifies the sharing type of the space.

', ], ], 'ShuffleConfig' => [ 'base' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', 'refs' => [ 'Channel$ShuffleConfig' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', ], ], 'SingleSignOnApplicationArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SingleSignOnApplicationArn' => '

The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

', ], ], 'SingleSignOnUserIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileRequest$SingleSignOnUserIdentifier' => '

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain\'s AuthMode is IAM Identity Center, this field is required. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'DescribeUserProfileResponse$SingleSignOnUserIdentifier' => '

The IAM Identity Center user identifier.

', ], ], 'SkipModelValidation' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'DescribeModelPackageOutput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'ModelPackage$SkipModelValidation' => '

Indicates if you want to skip model validation.

', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$SuccessTopic' => '

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

', 'AsyncInferenceNotificationConfig$ErrorTopic' => '

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

', 'LabelingJobOutputConfig$SnsTopicArn' => '

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

', 'LabelingJobSnsDataSource$SnsTopicArn' => '

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

', ], ], 'SortActionsBy' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortArtifactsBy' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortAssociationsBy' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortBy' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListProcessingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTrainingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTransformJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'SortContextsBy' => [ 'base' => NULL, 'refs' => [ 'ListContextsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortInferenceExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsRequest$SortBy' => '

The column by which to sort the listed inference experiments.

', ], ], 'SortLineageGroupsBy' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAlgorithmsInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListAppImageConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAppsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListArtifactsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAssociationsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListClusterNodesRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListClustersRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListCompilationJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListContextsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListDataQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListDeviceFleetsRequest$SortOrder' => '

What direction to sort in.

', 'ListEdgeDeploymentPlansRequest$SortOrder' => '

The direction of the sorting (ascending or descending).

', 'ListEdgePackagingJobsRequest$SortOrder' => '

What direction to sort by.

', 'ListExperimentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListFlowDefinitionsRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHubContentVersionsRequest$SortOrder' => '

Sort hub content versions by ascending or descending order.

', 'ListHubContentsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHubsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHumanTaskUisRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHyperParameterTuningJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListInferenceExperimentsRequest$SortOrder' => '

The direction of sorting (ascending or descending).

', 'ListInferenceRecommendationsJobsRequest$SortOrder' => '

The sort order for the results.

', 'ListLabelingJobsForWorkteamRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLabelingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLineageGroupsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelBiasJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelExplainabilityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelPackageGroupsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListModelPackagesInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringAlertHistoryRequest$SortOrder' => '

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

', 'ListMonitoringExecutionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringSchedulesRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListPipelineExecutionStepsRequest$SortOrder' => '

The field by which to sort results. The default is CreatedTime.

', 'ListPipelineExecutionsRequest$SortOrder' => '

The sort order for results.

', 'ListPipelinesRequest$SortOrder' => '

The sort order for results.

', 'ListProcessingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListSpacesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListStudioLifecycleConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTrainingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTransformJobsRequest$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListTrialComponentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrialsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListUserProfilesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListWorkforcesRequest$SortOrder' => '

Sort workforces in ascending or descending order.

', 'ListWorkteamsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'SortPipelineExecutionsBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortPipelinesBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortTrialComponentsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortTrialsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SourceAlgorithm' => [ 'base' => '

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', 'refs' => [ 'SourceAlgorithmList$member' => NULL, ], ], 'SourceAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'SourceAlgorithmSpecification$SourceAlgorithms' => '

A list of the algorithms that were used to create a model package.

', ], ], 'SourceAlgorithmSpecification' => [ 'base' => '

A list of algorithms that were used to create a model package.

', 'refs' => [ 'CreateModelPackageInput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'DescribeModelPackageOutput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'ModelPackage$SourceAlgorithmSpecification' => '

A list of algorithms that were used to create a model package.

', ], ], 'SourceIpConfig' => [ 'base' => '

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn\'t restricted to specific IP addresses.

', 'refs' => [ 'CreateWorkforceRequest$SourceIpConfig' => NULL, 'UpdateWorkforceRequest$SourceIpConfig' => '

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

', 'Workforce$SourceIpConfig' => '

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn\'t restricted to specific IP addresses.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceType' => '

The source type.

', 'TrialComponentSource$SourceType' => '

The source job type.

', 'TrialSource$SourceType' => '

The source job type.

', ], ], 'SourceUri' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceUri' => '

The URI of the source.

', 'ArtifactSource$SourceUri' => '

The URI of the source.

', 'ContextSource$SourceUri' => '

The URI of the source.

', 'ListActionsRequest$SourceUri' => '

A filter that returns only actions with the specified source URI.

', 'ListArtifactsRequest$SourceUri' => '

A filter that returns only artifacts with the specified source URI.

', 'ListContextsRequest$SourceUri' => '

A filter that returns only contexts with the specified source URI.

', ], ], 'SpaceArn' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'DescribeSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'UpdateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', ], ], 'SpaceCodeEditorAppSettings' => [ 'base' => '

The application settings for a Code Editor space.

', 'refs' => [ 'SpaceSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'SpaceDetails' => [ 'base' => '

The space\'s details.

', 'refs' => [ 'SpaceList$member' => NULL, ], ], 'SpaceEbsVolumeSizeInGb' => [ 'base' => NULL, 'refs' => [ 'DefaultEbsStorageSettings$DefaultEbsVolumeSizeInGb' => '

The default size of the EBS storage volume for a space.

', 'DefaultEbsStorageSettings$MaximumEbsVolumeSizeInGb' => '

The maximum size of the EBS storage volume for a space.

', 'EbsStorageSettings$EbsVolumeSizeInGb' => '

The size of an EBS storage volume for a space.

', ], ], 'SpaceJupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application within a space.

', 'refs' => [ 'SpaceSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'SpaceList' => [ 'base' => NULL, 'refs' => [ 'ListSpacesResponse$Spaces' => '

The list of spaces.

', ], ], 'SpaceName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$SpaceName' => '

The name of the space.

', 'CreateAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'CreatePresignedDomainUrlRequest$SpaceName' => '

The name of the space.

', 'CreateSpaceRequest$SpaceName' => '

The name of the space.

', 'DeleteAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DeleteSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeAppRequest$SpaceName' => '

The name of the space.

', 'DescribeAppResponse$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DescribeSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeSpaceResponse$SpaceName' => '

The name of the space.

', 'ListAppsRequest$SpaceNameEquals' => '

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

', 'ListSpacesRequest$SpaceNameContains' => '

A parameter by which to filter the results.

', 'SpaceDetails$SpaceName' => '

The name of the space.

', 'UpdateSpaceRequest$SpaceName' => '

The name of the space.

', ], ], 'SpaceSettings' => [ 'base' => '

A collection of space settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', 'DescribeSpaceResponse$SpaceSettings' => '

A collection of space settings.

', 'UpdateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', ], ], 'SpaceSettingsSummary' => [ 'base' => '

Specifies summary information about the space settings.

', 'refs' => [ 'SpaceDetails$SpaceSettingsSummary' => '

Specifies summary information about the space settings.

', ], ], 'SpaceSharingSettings' => [ 'base' => '

A collection of space sharing settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSharingSettings' => '

A collection of space sharing settings.

', 'DescribeSpaceResponse$SpaceSharingSettings' => '

The collection of space sharing settings for a space.

', ], ], 'SpaceSharingSettingsSummary' => [ 'base' => '

Specifies summary information about the space sharing settings.

', 'refs' => [ 'SpaceDetails$SpaceSharingSettingsSummary' => '

Specifies summary information about the space sharing settings.

', ], ], 'SpaceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListSpacesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SpaceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$Status' => '

The status.

', 'SpaceDetails$Status' => '

The status.

', ], ], 'SpaceStorageSettings' => [ 'base' => '

The storage settings for a space.

', 'refs' => [ 'SpaceSettings$SpaceStorageSettings' => '

The storage settings for a space.

', 'SpaceSettingsSummary$SpaceStorageSettings' => '

The storage settings for a space.

', ], ], 'SpawnRate' => [ 'base' => NULL, 'refs' => [ 'Phase$SpawnRate' => '

Specified how many new users to spawn in a minute.

', ], ], 'SplitType' => [ 'base' => NULL, 'refs' => [ 'TransformInput$SplitType' => '

The method to use to split the transform job\'s data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO

  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

', ], ], 'StageStatus' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentStatus$StageStatus' => '

The general status of the current stage.

', ], ], 'Stairs' => [ 'base' => '

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

', 'refs' => [ 'TrafficPattern$Stairs' => '

Defines the stairs traffic pattern.

', ], ], 'StartEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => '

The statistic of the customized metric.

', ], ], 'StatusDetails' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', 'ProfilerRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'SecondaryStatusTransition$StatusMessage' => '

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

  • Starting the training job.

  • Launching requested ML instances.

  • Insufficient capacity error from EC2 while launching instances, retrying!

  • Launched instance was unhealthy, replacing it!

  • Preparing the instances for training.

Training

  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don\'t use status messages in if statements.

To have an overview of your training job\'s progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress

  • SecondaryStatus - Training

  • StatusMessage - Downloading the training image

', ], ], 'StepDescription' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDescription' => '

The description of the step.

', ], ], 'StepDisplayName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDisplayName' => '

The display name of the step.

', ], ], 'StepName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepName' => '

The name of the step that is executed.

', ], ], 'StepStatus' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepStatus' => '

The status of the step execution.

', ], ], 'StopAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StoppingCondition' => [ 'base' => '

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

', 'refs' => [ 'CreateCompilationJobRequest$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'CreateTrainingJobRequest$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'DescribeCompilationJobResponse$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'DescribeTrainingJobResponse$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'HyperParameterTrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

', 'TrainingJob$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'TrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

', ], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'OnlineStoreConfig$StorageType' => '

Option for different tiers of low latency storage for real-time data retrieval.

  • Standard: A managed low latency data store for feature groups.

  • InMemory: A managed data store for feature groups that supports very low latency retrieval.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'BatchDescribeModelPackageError$ErrorCode' => '

', 'BatchDescribeModelPackageError$ErrorResponse' => '

', 'BatchTransformInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'BatchTransformInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'BatchTransformInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'ClusterInstanceStatusDetails$Message' => '

The message from an instance in a SageMaker HyperPod cluster.

', 'ClusterNodeDetails$InstanceId' => '

The ID of the instance.

', 'ClusterNodeSummary$InstanceId' => '

The ID of the instance.

', 'CreateModelPackageInput$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'CreateModelPackageInput$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

Specify "OTHER" if none of the tasks listed fit your use case.

', 'CustomizedMetricSpecification$MetricName' => '

The name of the customized metric.

', 'CustomizedMetricSpecification$Namespace' => '

The namespace of the customized metric.

', 'DescribeClusterResponse$FailureMessage' => '

The failure message of the SageMaker HyperPod cluster.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage' => '

Returns a message describing the job status and error messages.

', 'DescribeEdgePackagingJobResponse$ModelSignature' => '

The signature document of files in the model artifact.

', 'DescribeModelPackageOutput$Domain' => '

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

', 'DescribeModelPackageOutput$Task' => '

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'DescribeModelPackageOutput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

', 'DeviceDeploymentSummary$DeviceDeploymentStatusMessage' => '

The detailed error message for the deployoment status result.

', 'EdgeDeploymentStatus$EdgeDeploymentStatusMessage' => '

A detailed message about deployment status in current stage.

', 'EdgeOutputConfig$PresetDeploymentConfig' => '

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

', 'EdgePresetDeploymentOutput$StatusMessage' => '

Returns a message describing the status of the deployed resource.

', 'EndpointInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'EndpointInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'EndpointInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'EndpointOutputConfiguration$EndpointName' => '

The name of the endpoint made during a recommendation job.

', 'EndpointOutputConfiguration$VariantName' => '

The name of the production variant (deployed model) made during a recommendation job.

', 'EnvironmentParameter$Key' => '

The environment key suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$ValueType' => '

The value type suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$Value' => '

The value suggested by the Amazon SageMaker Inference Recommender.

', 'GetScalingConfigurationRecommendationRequest$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the EndpointName field.

', 'GetScalingConfigurationRecommendationResponse$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation.

', 'IamIdentity$Arn' => '

The Amazon Resource Name (ARN) of the IAM identity.

', 'IamIdentity$PrincipalId' => '

The ID of the principal that assumes the IAM identity.

', 'IamIdentity$SourceIdentity' => '

The person or application which assumes the IAM identity.

', 'InferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'ListProcessingJobsRequest$NameContains' => '

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

', 'ModelCard$ModelId' => '

The unique name (ID) of the model.

', 'ModelCard$RiskRating' => '

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

', 'ModelCard$ModelPackageGroupName' => '

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

', 'ModelDashboardModelCard$ModelId' => '

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

', 'ModelDashboardModelCard$RiskRating' => '

A model card\'s risk rating. Can be low, medium, or high.

', 'ModelMetadataSummary$Domain' => '

The machine learning domain of the model.

', 'ModelMetadataSummary$Framework' => '

The machine learning framework of the model.

', 'ModelMetadataSummary$Task' => '

The machine learning task of the model.

', 'ModelMetadataSummary$Model' => '

The name of the model.

', 'ModelMetadataSummary$FrameworkVersion' => '

The framework version of the model.

', 'ModelPackage$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'ModelPackage$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'ModelPackage$SamplePayloadUrl' => '

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'ModelPackageContainerDefinition$Framework' => '

The machine learning framework of the model package container image.

', 'ModelPackageContainerDefinition$NearestModelName' => '

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

', 'ModelPackageStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'PredefinedMetricSpecification$PredefinedMetricType' => '

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

', 'ProcessingInput$InputName' => '

The name for the processing job input.

', 'ProcessingOutput$OutputName' => '

The name for the processing job output.

', 'ProductListings$member' => NULL, 'RStudioServerProDomainSettings$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettings$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RealTimeInferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'RecommendationJobContainerConfig$Domain' => '

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

', 'RecommendationJobContainerConfig$Task' => '

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

', 'RecommendationJobContainerConfig$Framework' => '

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

', 'RecommendationJobContainerConfig$NearestModelName' => '

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

', 'RecommendationJobSupportedInstanceTypes$member' => NULL, 'RenderUiTemplateResponse$RenderedContent' => '

A Liquid template that renders the HTML for the worker UI.

', 'RenderingError$Code' => '

A unique identifier for a specific class of errors.

', 'RenderingError$Message' => '

A human-readable message describing the error.

', 'ScheduleConfig$DataAnalysisStartTime' => '

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'ScheduleConfig$DataAnalysisEndTime' => '

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'SubscribedWorkteam$SellerName' => '

The name of the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$ListingId' => '

Marketplace product listing ID.

', 'UserContext$UserProfileArn' => '

The Amazon Resource Name (ARN) of the user\'s profile.

', 'UserContext$UserProfileName' => '

The name of the user\'s profile.

', 'UserContext$DomainId' => '

The domain associated with the user.

', 'Workforce$SubDomain' => '

The subdomain for your OIDC Identity Provider.

', 'Workteam$SubDomain' => '

The URI of the labeling job\'s user interface. Workers open this URI to start labeling your data objects.

', ], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of baseline constraints file to be used for the drift check.

', 'ClarifyCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'ClarifyCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of the violation report if violations are detected.

', 'CreateDomainResponse$Url' => '

The URL to the created domain.

', 'DescribeDomainResponse$Url' => '

The domain\'s URL.

', 'DescribeSpaceResponse$Url' => '

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

', 'DomainDetails$Url' => '

The domain\'s URL.

', 'EMRStepMetadata$LogFilePath' => '

The path to the log file where the cluster step\'s failure root cause is recorded.

', 'OutputParameter$Value' => '

The value of the output parameter.

', 'Parameter$Value' => '

The literal value for the parameter.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics' => '

The Amazon S3 URI of the baseline statistics file used for the drift check.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of the baseline constraints file used for the drift check.

', 'QualityCheckStepMetadata$CalculatedBaselineStatistics' => '

The Amazon S3 URI of the newly calculated baseline statistics file.

', 'QualityCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'QualityCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of violation report if violations are detected.

', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRangeValues$member' => NULL, ], ], 'String200' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$Description' => '

A description of the work team.

', 'SubscribedWorkteam$MarketplaceTitle' => '

The title of the service provided by the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$MarketplaceDescription' => '

The description of the vendor from the Amazon Marketplace.

', 'UpdateWorkteamRequest$Description' => '

An updated description for the work team.

', 'Workteam$Description' => '

A description of the work team.

', ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceType' => '

The type of the source.

', 'ActionSource$SourceId' => '

The ID of the source.

', 'ArtifactSourceType$Value' => '

The ID.

', 'ArtifactSummary$ArtifactType' => '

The type of the artifact.

', 'AssociationSummary$SourceType' => '

The source type.

', 'AssociationSummary$DestinationType' => '

The destination type.

', 'CallbackStepMetadata$SqsQueueUrl' => '

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

', 'ClarifyCheckStepMetadata$CheckType' => '

The type of the Clarify Check step

', 'ClarifyCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'ClarifyCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the check processing job that was run by this step\'s execution.

', 'ContextSource$SourceType' => '

The type of the source.

', 'ContextSource$SourceId' => '

The ID of the source.

', 'ContextSummary$ContextType' => '

The type of the context.

', 'CreateActionRequest$ActionType' => '

The action type.

', 'CreateArtifactRequest$ArtifactType' => '

The artifact type.

', 'CreateContextRequest$ContextType' => '

The context type.

', 'CreateUserProfileRequest$SingleSignOnUserValue' => '

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain\'s AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'CustomImageContainerEnvironmentVariables$value' => NULL, 'DescribeActionResponse$ActionType' => '

The type of the action.

', 'DescribeArtifactResponse$ArtifactType' => '

The type of the artifact.

', 'DescribeContextResponse$ContextType' => '

The type of the context.

', 'DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId' => '

The IAM Identity Center managed application instance ID.

', 'DescribeUserProfileResponse$SingleSignOnUserValue' => '

The IAM Identity Center user value.

', 'EMRStepMetadata$ClusterId' => '

The identifier of the EMR cluster.

', 'EMRStepMetadata$StepId' => '

The identifier of the EMR cluster step.

', 'EMRStepMetadata$StepName' => '

The name of the EMR cluster step.

', 'LambdaStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

', 'ListActionsRequest$ActionType' => '

A filter that returns only actions of the specified type.

', 'ListArtifactsRequest$ArtifactType' => '

A filter that returns only artifacts of the specified type.

', 'ListAssociationsRequest$SourceType' => '

A filter that returns only associations with the specified source type.

', 'ListAssociationsRequest$DestinationType' => '

A filter that returns only associations with the specified destination type.

', 'ListContextsRequest$ContextType' => '

A filter that returns only contexts of the specified type.

', 'ListTrialComponentsRequest$SourceArn' => '

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can\'t filter by ExperimentName or TrialName.

', 'ModelMetadataFilter$Value' => '

The value to filter the model metadata.

', 'ModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the created model.

', 'OutputParameter$Name' => '

The name of the output parameter.

', 'QualityCheckStepMetadata$CheckType' => '

The type of the Quality check step.

', 'QualityCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'QualityCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

', 'QueryProperties$key' => NULL, 'QueryProperties$value' => NULL, 'RegisterModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the model package.

', 'SelectedStep$StepName' => '

The name of the pipeline step.

', 'SendPipelineExecutionStepFailureRequest$FailureReason' => '

A message describing why the step failed.

', ], ], 'String3072' => [ 'base' => NULL, 'refs' => [ 'FailStepMetadata$ErrorMessage' => '

A message that you define and then is processed and rendered by the Fail step when the error occurs.

', 'PipelineExecutionSummary$PipelineExecutionFailureReason' => '

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

', ], ], 'String40' => [ 'base' => NULL, 'refs' => [ 'QueryTypes$member' => NULL, 'Vertex$Type' => '

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

', ], ], 'String64' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionType' => '

The type of the action.

', 'CategoricalParameter$Name' => '

The Name of the environment variable.

', 'ModelLatencyThreshold$Percentile' => '

The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.

', ], ], 'String8192' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$NextToken' => '

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

', 'QueryLineageResponse$NextToken' => '

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'StringParameterValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$key' => NULL, 'LineageEntityParameters$key' => NULL, 'LineageEntityParameters$value' => NULL, 'ListLineageEntityParameterKey$member' => NULL, 'TrialComponentParameterValue$StringValue' => '

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can\'t specify the NumberValue parameter.

', ], ], 'StudioLifecycleConfigAppType' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'ListStudioLifecycleConfigsRequest$AppTypeEquals' => '

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigAppType' => '

The App type to which the Lifecycle Configuration is attached.

', ], ], 'StudioLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of your created Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of the Lifecycle Configuration to describe.

', 'LifecycleConfigArns$member' => NULL, 'ResourceSpec$LifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script.

', ], ], 'StudioLifecycleConfigDetails' => [ 'base' => '

Details of the Amazon SageMaker Studio Lifecycle Configuration.

', 'refs' => [ 'StudioLifecycleConfigsList$member' => NULL, ], ], 'StudioLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

', 'DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

', 'DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

', 'ListStudioLifecycleConfigsRequest$NameContains' => '

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'StudioLifecycleConfigsList' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs' => '

A list of Lifecycle Configurations and their properties.

', ], ], 'StudioWebPortal' => [ 'base' => NULL, 'refs' => [ 'UserSettings$StudioWebPortal' => '

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SubnetId' => '

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

', 'DescribeNotebookInstanceOutput$SubnetId' => '

The ID of the VPC subnet.

', 'Subnets$member' => NULL, ], ], 'Subnets' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'DescribeDomainResponse$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'UpdateDomainRequest$SubnetIds' => '

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

', 'VpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

', ], ], 'SubscribedWorkteam' => [ 'base' => '

Describes a work team of a vendor that does the a labelling job.

', 'refs' => [ 'DescribeSubscribedWorkteamResponse$SubscribedWorkteam' => '

A Workteam instance that contains information about the work team.

', 'SubscribedWorkteams$member' => NULL, ], ], 'SubscribedWorkteams' => [ 'base' => NULL, 'refs' => [ 'ListSubscribedWorkteamsResponse$SubscribedWorkteams' => '

An array of Workteam objects, each describing a work team.

', ], ], 'Success' => [ 'base' => NULL, 'refs' => [ 'DeleteWorkteamResponse$Success' => '

Returns true if the work team was successfully deleted; otherwise, returns false.

', ], ], 'SuggestionQuery' => [ 'base' => '

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

', 'refs' => [ 'GetSearchSuggestionsRequest$SuggestionQuery' => '

Limits the property names that are included in the response.

', ], ], 'TableFormat' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreConfig$TableFormat' => '

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$TableName' => '

The name of the Glue table.

', ], ], 'TabularJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TabularJobConfig' => '

Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).

', ], ], 'TabularResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TabularResolvedAttributes' => '

The resolved attributes for the tabular problem type.

', ], ], 'Tag' => [ 'base' => '

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique per resource.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'DeleteTagsInput$TagKeys' => '

An array or one or more tag keys to delete.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'AddTagsOutput$Tags' => '

A list of tags associated with the SageMaker resource.

', 'CreateActionRequest$Tags' => '

A list of tags to apply to the action.

', 'CreateAlgorithmInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateAppImageConfigRequest$Tags' => '

A list of tags to apply to the AppImageConfig.

', 'CreateAppRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

', 'CreateArtifactRequest$Tags' => '

A list of tags to apply to the artifact.

', 'CreateAutoMLJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateAutoMLJobV2Request$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateClusterRequest$Tags' => '

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

', 'CreateCodeRepositoryInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateCompilationJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateContextRequest$Tags' => '

A list of tags to apply to the context.

', 'CreateDataQualityJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateDeviceFleetRequest$Tags' => '

Creates tags for the specified fleet.

', 'CreateDomainRequest$Tags' => '

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

', 'CreateEdgeDeploymentPlanRequest$Tags' => '

List of tags with which to tag the edge deployment plan.

', 'CreateEdgePackagingJobRequest$Tags' => '

Creates tags for the packaging job.

', 'CreateEndpointConfigInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateEndpointInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateExperimentRequest$Tags' => '

A list of tags to associate with the experiment. You can use Search API to search on the tags.

', 'CreateFeatureGroupRequest$Tags' => '

Tags used to identify Features in each FeatureGroup.

', 'CreateFlowDefinitionRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

', 'CreateHubRequest$Tags' => '

Any tags to associate with the hub.

', 'CreateHumanTaskUiRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

', 'CreateHyperParameterTuningJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

', 'CreateImageRequest$Tags' => '

A list of tags to apply to the image.

', 'CreateInferenceComponentInput$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

', 'CreateInferenceExperimentRequest$Tags' => '

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

', 'CreateInferenceRecommendationsJobRequest$Tags' => '

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

', 'CreateLabelingJobRequest$Tags' => '

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.

', 'CreateModelBiasJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateModelCardRequest$Tags' => '

Key-value pairs used to manage metadata for model cards.

', 'CreateModelExplainabilityJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateModelInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateModelPackageGroupInput$Tags' => '

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateModelPackageInput$Tags' => '

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

', 'CreateModelQualityJobDefinitionRequest$Tags' => '

(Optional) 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.

', 'CreateMonitoringScheduleRequest$Tags' => '

(Optional) 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.

', 'CreateNotebookInstanceInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreatePipelineRequest$Tags' => '

A list of tags to apply to the created pipeline.

', 'CreateProcessingJobRequest$Tags' => '

(Optional) 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.

', 'CreateProjectInput$Tags' => '

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateSpaceRequest$Tags' => '

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

', 'CreateStudioLifecycleConfigRequest$Tags' => '

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

', 'CreateTrainingJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateTransformJobRequest$Tags' => '

(Optional) 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.

', 'CreateTrialComponentRequest$Tags' => '

A list of tags to associate with the component. You can use Search API to search on the tags.

', 'CreateTrialRequest$Tags' => '

A list of tags to associate with the trial. You can use Search API to search on the tags.

', 'CreateUserProfileRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

', 'CreateWorkforceRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

', 'CreateWorkteamRequest$Tags' => '

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'DescribeLabelingJobResponse$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'Endpoint$Tags' => '

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Experiment$Tags' => '

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

', 'FeatureGroup$Tags' => '

Tags used to define a FeatureGroup.

', 'HyperParameterTuningJobSearchEntity$Tags' => '

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

', 'ImportHubContentRequest$Tags' => '

Any tags associated with the hub content.

', 'ListTagsOutput$Tags' => '

An array of Tag objects, each with a tag key and a value.

', 'Model$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelCard$Tags' => '

Key-value pairs used to manage metadata for the model card.

', 'ModelDashboardModelCard$Tags' => '

The tags associated with a model card.

', 'ModelPackage$Tags' => '

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelPackageGroup$Tags' => '

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'MonitoringSchedule$Tags' => '

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Pipeline$Tags' => '

A list of tags that apply to the pipeline.

', 'ProcessingJob$Tags' => '

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.

', 'Project$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'RegisterDevicesRequest$Tags' => '

The tags associated with devices.

', 'TrainingJob$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'TransformJob$Tags' => '

A list of tags associated with the transform job.

', 'Trial$Tags' => '

The list of tags that are associated with the trial. You can use Search API to search on the tags.

', 'TrialComponent$Tags' => '

The list of tags that are associated with the component. You can use Search API to search on the tags.

', 'UpdateProjectInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag value.

', ], ], 'TargetAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TabularJobConfig$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TimeSeriesConfig$TargetAttributeName' => '

The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

', ], ], 'TargetDevice' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetDevice' => '

The type of device that the model will run on after the compilation job has completed.

', 'OutputConfig$TargetDevice' => '

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.

', ], ], 'TargetLabelColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$TargetLabelColumn' => '

The name of the column used to provide the class labels. It should not be same as the content column.

', ], ], 'TargetObjectiveMetricValue' => [ 'base' => NULL, 'refs' => [ 'TuningJobCompletionCriteria$TargetObjectiveMetricValue' => '

The value of the objective metric.

', ], ], 'TargetPlatform' => [ 'base' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

', 'refs' => [ 'OutputConfig$TargetPlatform' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"},

    "CompilerOptions": {\'mattr\': [\'+neon\']}

  • Jetson TX2

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'gpu-code\': \'sm_62\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.0\'}

  • EC2 m5.2xlarge instance OS

    "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'mcpu\': \'skylake-avx512\'}

  • RK3399

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}

  • ARMv7 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 25, \'mattr\': [\'+neon\']}

  • ARMv8 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 29}

', ], ], 'TargetPlatformAccelerator' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformAccelerator' => '

The type of accelerator that the model will run on after the compilation job has completed.

', 'TargetPlatform$Accelerator' => '

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options

  • MALI: ARM Mali graphics processor

  • INTEL_GRAPHICS: Integrated Intel graphics

', ], ], 'TargetPlatformArch' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformArch' => '

The type of architecture that the model will run on after the compilation job has completed.

', 'TargetPlatform$Arch' => '

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.

  • X86: 32-bit version of the x86 instruction set.

  • ARM64: ARMv8 64-bit CPU.

  • ARM_EABIHF: ARMv7 32-bit, Hard Float.

  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

', ], ], 'TargetPlatformOs' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformOs' => '

The type of OS that the model will run on after the compilation job has completed.

', 'TargetPlatform$Os' => '

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.

  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {\'ANDROID_PLATFORM\': 28}

', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'base' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

', 'refs' => [ 'ScalingPolicy$TargetTracking' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

', ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).

  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskCount' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredInstanceCount' => '

The variant\'s capacity.

', 'PendingProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'PendingProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'ProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

', 'RealTimeInferenceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType.

', ], ], 'TaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskDescription' => '

A description of the task for your human workers.

', ], ], 'TaskInput' => [ 'base' => NULL, 'refs' => [ 'RenderableTask$Input' => '

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

', ], ], 'TaskKeyword' => [ 'base' => NULL, 'refs' => [ 'TaskKeywords$member' => NULL, ], ], 'TaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskKeywords' => '

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

', ], ], 'TaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).

  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTitle' => '

A title for the task for your human workers.

', ], ], 'TemplateContent' => [ 'base' => NULL, 'refs' => [ 'UiTemplate$Content' => '

The content of the Liquid template for the worker user interface.

', ], ], 'TemplateContentSha256' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$ContentSha256' => '

The SHA-256 digest of the contents of the template.

', ], ], 'TemplateUrl' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$Url' => '

The URL for the user interface template.

', ], ], 'TensorBoardAppSettings' => [ 'base' => '

The TensorBoard app settings.

', 'refs' => [ 'UserSettings$TensorBoardAppSettings' => '

The TensorBoard app settings.

', ], ], 'TensorBoardOutputConfig' => [ 'base' => '

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

', 'refs' => [ 'CreateTrainingJobRequest$TensorBoardOutputConfig' => NULL, 'DescribeTrainingJobResponse$TensorBoardOutputConfig' => NULL, 'TrainingJob$TensorBoardOutputConfig' => NULL, ], ], 'TenthFractionsOfACent' => [ 'base' => NULL, 'refs' => [ 'USD$TenthFractionsOfACent' => '

Fractions of a cent, in tenths.

', ], ], 'TerminationWaitInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$TerminationWaitInSeconds' => '

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

', ], ], 'TextClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the text classification problem type.

', ], ], 'TextGenerationHyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$key' => NULL, ], ], 'TextGenerationHyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$value' => NULL, ], ], 'TextGenerationHyperParameters' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$TextGenerationHyperParameters' => '

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

  • "epochCount": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of "1" to "10".

  • "batchSize": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of "1" to "64".

  • "learningRate": The step size at which a model\'s parameters are updated during training. Its value should be a string containing a floating-point value within the range of "0" to "1".

  • "learningRateWarmupSteps": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of "0" to "250".

Here is an example where all four hyperparameters are configured.

{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", "learningRateWarmupSteps": "10" }

', ], ], 'TextGenerationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextGenerationJobConfig' => '

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', ], ], 'TextGenerationResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the text generation problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TextGenerationResolvedAttributes' => '

The resolved attributes for the text generation problem type.

', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

', 'Device$IotThingName' => '

Amazon Web Services Internet of Things (IoT) object name.

', 'DeviceSummary$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

', ], ], 'ThroughputConfig' => [ 'base' => '

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

', 'refs' => [ 'CreateFeatureGroupRequest$ThroughputConfig' => NULL, ], ], 'ThroughputConfigDescription' => [ 'base' => '

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

', 'refs' => [ 'DescribeFeatureGroupResponse$ThroughputConfig' => NULL, ], ], 'ThroughputConfigUpdate' => [ 'base' => '

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

', 'refs' => [ 'UpdateFeatureGroupRequest$ThroughputConfig' => NULL, ], ], 'ThroughputMode' => [ 'base' => NULL, 'refs' => [ 'ThroughputConfig$ThroughputMode' => '

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

', 'ThroughputConfigDescription$ThroughputMode' => '

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

', 'ThroughputConfigUpdate$ThroughputMode' => '

Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group\'s throughput while another update is in progress.

', ], ], 'TimeSeriesConfig' => [ 'base' => '

The collection of components that defines the time-series.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$TimeSeriesConfig' => '

The collection of components that defines the time-series.

', ], ], 'TimeSeriesForecastingJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TimeSeriesForecastingJobConfig' => '

Settings used to configure an AutoML job V2 for the time-series forecasting problem type.

', ], ], 'TimeSeriesForecastingSettings' => [ 'base' => '

Time series forecast settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$TimeSeriesForecastingSettings' => '

Time series forecast settings for the SageMaker Canvas application.

', ], ], 'TimeSeriesTransformations' => [ 'base' => '

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$Transformations' => '

The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$CreationTime' => '

When the action was created.

', 'ActionSummary$LastModifiedTime' => '

When the action was last modified.

', 'AppImageConfigDetails$CreationTime' => '

When the AppImageConfig was created.

', 'AppImageConfigDetails$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'ArtifactSummary$CreationTime' => '

When the artifact was created.

', 'ArtifactSummary$LastModifiedTime' => '

When the artifact was last modified.

', 'AssociationSummary$CreationTime' => '

When the association was created.

', 'AutoMLCandidate$CreationTime' => '

The creation time.

', 'AutoMLCandidate$EndTime' => '

The end time.

', 'AutoMLCandidate$LastModifiedTime' => '

The last modified time.

', 'AutoMLJobSummary$CreationTime' => '

When the AutoML job was created.

', 'AutoMLJobSummary$EndTime' => '

The end time of an AutoML job.

', 'AutoMLJobSummary$LastModifiedTime' => '

When the AutoML job was last modified.

', 'ClusterNodeDetails$LaunchTime' => '

The time when the instance is launched.

', 'ClusterNodeSummary$LaunchTime' => '

The time when the instance is launched.

', 'ClusterSummary$CreationTime' => '

The time when the SageMaker HyperPod cluster is created.

', 'CompilationJobSummary$CompilationStartTime' => '

The time when the model compilation job started.

', 'CompilationJobSummary$CompilationEndTime' => '

The time when the model compilation job completed.

', 'ContextSummary$CreationTime' => '

When the context was created.

', 'ContextSummary$LastModifiedTime' => '

When the context was last modified.

', 'CreateTrialComponentRequest$StartTime' => '

When the component started.

', 'CreateTrialComponentRequest$EndTime' => '

When the component ended.

', 'DebugRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'DeployedImage$ResolutionTime' => '

The date and time when the image path for the model resolved to the ResolvedImage

', 'DescribeActionResponse$CreationTime' => '

When the action was created.

', 'DescribeActionResponse$LastModifiedTime' => '

When the action was last modified.

', 'DescribeAppImageConfigResponse$CreationTime' => '

When the AppImageConfig was created.

', 'DescribeAppImageConfigResponse$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'DescribeAppResponse$LastHealthCheckTimestamp' => '

The timestamp of the last health check.

', 'DescribeAppResponse$LastUserActivityTimestamp' => '

The timestamp of the last user\'s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

', 'DescribeAppResponse$CreationTime' => '

The creation time of the application.

After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

', 'DescribeArtifactResponse$CreationTime' => '

When the artifact was created.

', 'DescribeArtifactResponse$LastModifiedTime' => '

When the artifact was last modified.

', 'DescribeAutoMLJobResponse$CreationTime' => '

Returns the creation time of the AutoML job.

', 'DescribeAutoMLJobResponse$EndTime' => '

Returns the end time of the AutoML job.

', 'DescribeAutoMLJobResponse$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeAutoMLJobV2Response$CreationTime' => '

Returns the creation time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$EndTime' => '

Returns the end time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeClusterResponse$CreationTime' => '

The time when the SageMaker Cluster is created.

', 'DescribeCompilationJobResponse$CompilationStartTime' => '

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That\'s because it takes time to download the compilation job, which depends on the size of the compilation job container.

', 'DescribeCompilationJobResponse$CompilationEndTime' => '

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job\'s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

', 'DescribeContextResponse$CreationTime' => '

When the context was created.

', 'DescribeContextResponse$LastModifiedTime' => '

When the context was last modified.

', 'DescribeDataQualityJobDefinitionResponse$CreationTime' => '

The time that the data quality monitoring job definition was created.

', 'DescribeDeviceFleetResponse$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DescribeDeviceFleetResponse$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DescribeDeviceResponse$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DescribeDeviceResponse$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'DescribeEdgeDeploymentPlanResponse$CreationTime' => '

The time when the edge deployment plan was created.

', 'DescribeEdgeDeploymentPlanResponse$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'DescribeEdgePackagingJobResponse$CreationTime' => '

The timestamp of when the packaging job was created.

', 'DescribeEdgePackagingJobResponse$LastModifiedTime' => '

The timestamp of when the job was last updated.

', 'DescribeEndpointConfigOutput$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'DescribeEndpointOutput$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'DescribeEndpointOutput$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'DescribeExperimentResponse$CreationTime' => '

When the experiment was created.

', 'DescribeExperimentResponse$LastModifiedTime' => '

When the experiment was last modified.

', 'DescribeFlowDefinitionResponse$CreationTime' => '

The timestamp when the flow definition was created.

', 'DescribeHubContentResponse$CreationTime' => '

The date and time that hub content was created.

', 'DescribeHubResponse$CreationTime' => '

The date and time that the hub was created.

', 'DescribeHubResponse$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'DescribeHumanTaskUiResponse$CreationTime' => '

The timestamp when the human task user interface was created.

', 'DescribeHyperParameterTuningJobResponse$CreationTime' => '

The date and time that the tuning job started.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'DescribeHyperParameterTuningJobResponse$LastModifiedTime' => '

The date and time that the status of the tuning job was modified.

', 'DescribeImageResponse$CreationTime' => '

When the image was created.

', 'DescribeImageResponse$LastModifiedTime' => '

When the image was last modified.

', 'DescribeImageVersionResponse$CreationTime' => '

When the version was created.

', 'DescribeImageVersionResponse$LastModifiedTime' => '

When the version was last modified.

', 'DescribeInferenceComponentOutput$CreationTime' => '

The time when the inference component was created.

', 'DescribeInferenceComponentOutput$LastModifiedTime' => '

The time when the inference component was last updated.

', 'DescribeInferenceExperimentResponse$CreationTime' => '

The timestamp at which you created the inference experiment.

', 'DescribeInferenceExperimentResponse$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'DescribeInferenceExperimentResponse$LastModifiedTime' => '

The timestamp at which you last modified the inference experiment.

', 'DescribeInferenceRecommendationsJobResponse$CompletionTime' => '

A timestamp that shows when the job completed.

', 'DescribeLabelingJobResponse$CreationTime' => '

The date and time that the labeling job was created.

', 'DescribeLabelingJobResponse$LastModifiedTime' => '

The date and time that the labeling job was last updated.

', 'DescribeLineageGroupResponse$CreationTime' => '

The creation time of lineage group.

', 'DescribeLineageGroupResponse$LastModifiedTime' => '

The last modified time of the lineage group.

', 'DescribeModelBiasJobDefinitionResponse$CreationTime' => '

The time at which the model bias job was created.

', 'DescribeModelCardExportJobResponse$CreatedAt' => '

The date and time that the model export job was created.

', 'DescribeModelCardExportJobResponse$LastModifiedAt' => '

The date and time that the model export job was last modified.

', 'DescribeModelCardResponse$CreationTime' => '

The date and time the model card was created.

', 'DescribeModelCardResponse$LastModifiedTime' => '

The date and time the model card was last modified.

', 'DescribeModelExplainabilityJobDefinitionResponse$CreationTime' => '

The time at which the model explainability job was created.

', 'DescribeModelOutput$CreationTime' => '

A timestamp that shows when the model was created.

', 'DescribeModelPackageOutput$LastModifiedTime' => '

The last time that the model package was modified.

', 'DescribeModelQualityJobDefinitionResponse$CreationTime' => '

The time at which the model quality job was created.

', 'DescribeMonitoringScheduleResponse$CreationTime' => '

The time at which the monitoring job was created.

', 'DescribeMonitoringScheduleResponse$LastModifiedTime' => '

The time at which the monitoring job was last modified.

', 'DescribePipelineDefinitionForExecutionResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineExecutionResponse$CreationTime' => '

The time when the pipeline execution was created.

', 'DescribePipelineExecutionResponse$LastModifiedTime' => '

The time when the pipeline execution was modified last.

', 'DescribePipelineResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineResponse$LastModifiedTime' => '

The time when the pipeline was last modified.

', 'DescribePipelineResponse$LastRunTime' => '

The time when the pipeline was last run.

', 'DescribeProcessingJobResponse$ProcessingEndTime' => '

The time at which the processing job completed.

', 'DescribeProcessingJobResponse$ProcessingStartTime' => '

The time at which the processing job started.

', 'DescribeProcessingJobResponse$LastModifiedTime' => '

The time at which the processing job was last modified.

', 'DescribeProcessingJobResponse$CreationTime' => '

The time at which the processing job was created.

', 'DescribeProjectOutput$CreationTime' => '

The time when the project was created.

', 'DescribeProjectOutput$LastModifiedTime' => '

The timestamp when project was last modified.

', 'DescribeStudioLifecycleConfigResponse$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'DescribeTrainingJobResponse$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'DescribeTrainingJobResponse$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'DescribeTrainingJobResponse$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'DescribeTrainingJobResponse$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'DescribeTransformJobResponse$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'DescribeTransformJobResponse$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'DescribeTransformJobResponse$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'DescribeTrialComponentResponse$StartTime' => '

When the component started.

', 'DescribeTrialComponentResponse$EndTime' => '

When the component ended.

', 'DescribeTrialComponentResponse$CreationTime' => '

When the component was created.

', 'DescribeTrialComponentResponse$LastModifiedTime' => '

When the component was last modified.

', 'DescribeTrialResponse$CreationTime' => '

When the trial was created.

', 'DescribeTrialResponse$LastModifiedTime' => '

When the trial was last modified.

', 'DeviceDeploymentSummary$DeploymentStartTime' => '

The time when the deployment on the device started.

', 'DeviceFleetSummary$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DeviceFleetSummary$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DeviceSummary$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DeviceSummary$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'EdgeDeploymentPlanSummary$CreationTime' => '

The time when the edge deployment plan was created.

', 'EdgeDeploymentPlanSummary$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'EdgeDeploymentStatus$EdgeDeploymentStageStartTime' => '

The time when the deployment API started.

', 'EdgeModel$LatestSampleTime' => '

The timestamp of the last data sample taken.

', 'EdgeModel$LatestInference' => '

The timestamp of the last inference that was made.

', 'EdgePackagingJobSummary$CreationTime' => '

The timestamp of when the job was created.

', 'EdgePackagingJobSummary$LastModifiedTime' => '

The timestamp of when the edge packaging job was last updated.

', 'Endpoint$CreationTime' => '

The time that the endpoint was created.

', 'Endpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'EndpointConfigSummary$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'EndpointSummary$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'EndpointSummary$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'Experiment$CreationTime' => '

When the experiment was created.

', 'Experiment$LastModifiedTime' => '

When the experiment was last modified.

', 'ExperimentSummary$CreationTime' => '

When the experiment was created.

', 'ExperimentSummary$LastModifiedTime' => '

When the experiment was last modified.

', 'FeatureGroupSummary$CreationTime' => '

A timestamp indicating the time of creation time of the FeatureGroup.

', 'FlowDefinitionSummary$CreationTime' => '

The timestamp when SageMaker created the flow definition.

', 'GetDeviceFleetReportResponse$ReportGenerated' => '

Timestamp of when the report was generated.

', 'HubContentInfo$CreationTime' => '

The date and time that the hub content was created.

', 'HubInfo$CreationTime' => '

The date and time that the hub was created.

', 'HubInfo$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'HumanTaskUiSummary$CreationTime' => '

A timestamp when SageMaker created the human task user interface.

', 'HyperParameterTrainingJobSummary$CreationTime' => '

The date and time that the training job was created.

', 'HyperParameterTrainingJobSummary$TrainingStartTime' => '

The date and time that the training job started.

', 'HyperParameterTrainingJobSummary$TrainingEndTime' => '

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'HyperParameterTuningJobCompletionDetails$ConvergenceDetectedTime' => '

The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.

', 'HyperParameterTuningJobSearchEntity$CreationTime' => '

The time that a hyperparameter tuning job was created.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime' => '

The time that a hyperparameter tuning job ended.

', 'HyperParameterTuningJobSearchEntity$LastModifiedTime' => '

The time that a hyperparameter tuning job was last modified.

', 'HyperParameterTuningJobSummary$CreationTime' => '

The date and time that the tuning job was created.

', 'HyperParameterTuningJobSummary$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'HyperParameterTuningJobSummary$LastModifiedTime' => '

The date and time that the tuning job was modified.

', 'Image$CreationTime' => '

When the image was created.

', 'Image$LastModifiedTime' => '

When the image was last modified.

', 'ImageVersion$CreationTime' => '

When the version was created.

', 'ImageVersion$LastModifiedTime' => '

When the version was last modified.

', 'InferenceComponentSummary$CreationTime' => '

The time when the inference component was created.

', 'InferenceComponentSummary$LastModifiedTime' => '

The time when the inference component was last updated.

', 'InferenceExperimentSchedule$StartTime' => '

The timestamp at which the inference experiment started or will start.

', 'InferenceExperimentSchedule$EndTime' => '

The timestamp at which the inference experiment ended or will end.

', 'InferenceExperimentSummary$CreationTime' => '

The timestamp at which the inference experiment was created.

', 'InferenceExperimentSummary$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'InferenceExperimentSummary$LastModifiedTime' => '

The timestamp when you last modified the inference experiment.

', 'InferenceRecommendationsJob$CompletionTime' => '

A timestamp that shows when the job completed.

', 'LabelingJobForWorkteamSummary$CreationTime' => '

The date and time that the labeling job was created.

', 'LabelingJobSummary$CreationTime' => '

The date and time that the job was created (timestamp).

', 'LabelingJobSummary$LastModifiedTime' => '

The date and time that the job was last modified (timestamp).

', 'LineageGroupSummary$CreationTime' => '

The creation time of the lineage group summary.

', 'LineageGroupSummary$LastModifiedTime' => '

The last modified time of the lineage group summary.

', 'ListActionsRequest$CreatedAfter' => '

A filter that returns only actions created on or after the specified time.

', 'ListActionsRequest$CreatedBefore' => '

A filter that returns only actions created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeBefore' => '

A filter that returns only AppImageConfigs created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeAfter' => '

A filter that returns only AppImageConfigs created on or after the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only AppImageConfigs modified on or before the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only AppImageConfigs modified on or after the specified time.

', 'ListArtifactsRequest$CreatedAfter' => '

A filter that returns only artifacts created on or after the specified time.

', 'ListArtifactsRequest$CreatedBefore' => '

A filter that returns only artifacts created on or before the specified time.

', 'ListAssociationsRequest$CreatedAfter' => '

A filter that returns only associations created on or after the specified time.

', 'ListAssociationsRequest$CreatedBefore' => '

A filter that returns only associations created on or before the specified time.

', 'ListAutoMLJobsRequest$CreationTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$CreationTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListClusterNodesRequest$CreationTimeAfter' => '

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClusterNodesRequest$CreationTimeBefore' => '

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeAfter' => '

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeBefore' => '

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListCodeRepositoriesInput$LastModifiedTimeAfter' => '

A filter that returns only Git repositories that were last modified after the specified time.

', 'ListCodeRepositoriesInput$LastModifiedTimeBefore' => '

A filter that returns only Git repositories that were last modified before the specified time.

', 'ListContextsRequest$CreatedAfter' => '

A filter that returns only contexts created on or after the specified time.

', 'ListContextsRequest$CreatedBefore' => '

A filter that returns only contexts created on or before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only data quality monitoring job definitions created before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only data quality monitoring job definitions created after the specified time.

', 'ListDeviceFleetsRequest$CreationTimeAfter' => '

Filter fleets where packaging job was created after specified time.

', 'ListDeviceFleetsRequest$CreationTimeBefore' => '

Filter fleets where the edge packaging job was created before specified time.

', 'ListDeviceFleetsRequest$LastModifiedTimeAfter' => '

Select fleets where the job was updated after X

', 'ListDeviceFleetsRequest$LastModifiedTimeBefore' => '

Select fleets where the job was updated before X

', 'ListDevicesRequest$LatestHeartbeatAfter' => '

Select fleets where the job was updated after X

', 'ListEdgeDeploymentPlansRequest$CreationTimeAfter' => '

Selects edge deployment plans created after this time.

', 'ListEdgeDeploymentPlansRequest$CreationTimeBefore' => '

Selects edge deployment plans created before this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter' => '

Selects edge deployment plans that were last updated after this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore' => '

Selects edge deployment plans that were last updated before this time.

', 'ListEdgePackagingJobsRequest$CreationTimeAfter' => '

Select jobs where the job was created after specified time.

', 'ListEdgePackagingJobsRequest$CreationTimeBefore' => '

Select jobs where the job was created before specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeAfter' => '

Select jobs where the job was updated after specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeBefore' => '

Select jobs where the job was updated before specified time.

', 'ListEndpointConfigsInput$CreationTimeBefore' => '

A filter that returns only endpoint configurations created before the specified time (timestamp).

', 'ListEndpointConfigsInput$CreationTimeAfter' => '

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeBefore' => '

A filter that returns only endpoints that were created before the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeAfter' => '

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$LastModifiedTimeBefore' => '

A filter that returns only endpoints that were modified before the specified timestamp.

', 'ListEndpointsInput$LastModifiedTimeAfter' => '

A filter that returns only endpoints that were modified after the specified timestamp.

', 'ListExperimentsRequest$CreatedAfter' => '

A filter that returns only experiments created after the specified time.

', 'ListExperimentsRequest$CreatedBefore' => '

A filter that returns only experiments created before the specified time.

', 'ListFlowDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

', 'ListFlowDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only flow definitions that were created before the specified timestamp.

', 'ListHubContentVersionsRequest$CreationTimeBefore' => '

Only list hub content versions that were created before the time specified.

', 'ListHubContentVersionsRequest$CreationTimeAfter' => '

Only list hub content versions that were created after the time specified.

', 'ListHubContentsRequest$CreationTimeBefore' => '

Only list hub content that was created before the time specified.

', 'ListHubContentsRequest$CreationTimeAfter' => '

Only list hub content that was created after the time specified.

', 'ListHubsRequest$CreationTimeBefore' => '

Only list hubs that were created before the time specified.

', 'ListHubsRequest$CreationTimeAfter' => '

Only list hubs that were created after the time specified.

', 'ListHubsRequest$LastModifiedTimeBefore' => '

Only list hubs that were last modified before the time specified.

', 'ListHubsRequest$LastModifiedTimeAfter' => '

Only list hubs that were last modified after the time specified.

', 'ListHumanTaskUisRequest$CreationTimeAfter' => '

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

', 'ListHumanTaskUisRequest$CreationTimeBefore' => '

A filter that returns only human task user interfaces that were created before the specified timestamp.

', 'ListHyperParameterTuningJobsRequest$CreationTimeAfter' => '

A filter that returns only tuning jobs that were created after the specified time.

', 'ListHyperParameterTuningJobsRequest$CreationTimeBefore' => '

A filter that returns only tuning jobs that were created before the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only tuning jobs that were modified after the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only tuning jobs that were modified before the specified time.

', 'ListImageVersionsRequest$CreationTimeAfter' => '

A filter that returns only versions created on or after the specified time.

', 'ListImageVersionsRequest$CreationTimeBefore' => '

A filter that returns only versions created on or before the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeAfter' => '

A filter that returns only versions modified on or after the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeBefore' => '

A filter that returns only versions modified on or before the specified time.

', 'ListImagesRequest$CreationTimeAfter' => '

A filter that returns only images created on or after the specified time.

', 'ListImagesRequest$CreationTimeBefore' => '

A filter that returns only images created on or before the specified time.

', 'ListImagesRequest$LastModifiedTimeAfter' => '

A filter that returns only images modified on or after the specified time.

', 'ListImagesRequest$LastModifiedTimeBefore' => '

A filter that returns only images modified on or before the specified time.

', 'ListInferenceComponentsInput$CreationTimeBefore' => '

Filters the results to only those inference components that were created before the specified time.

', 'ListInferenceComponentsInput$CreationTimeAfter' => '

Filters the results to only those inference components that were created after the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeBefore' => '

Filters the results to only those inference components that were updated before the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeAfter' => '

Filters the results to only those inference components that were updated after the specified time.

', 'ListInferenceExperimentsRequest$CreationTimeAfter' => '

Selects inference experiments which were created after this timestamp.

', 'ListInferenceExperimentsRequest$CreationTimeBefore' => '

Selects inference experiments which were created before this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeAfter' => '

Selects inference experiments which were last modified after this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeBefore' => '

Selects inference experiments which were last modified before this timestamp.

', 'ListLabelingJobsForWorkteamRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsForWorkteamRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only labeling jobs modified after the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only labeling jobs modified before the specified time (timestamp).

', 'ListLineageGroupsRequest$CreatedAfter' => '

A timestamp to filter against lineage groups created after a certain point in time.

', 'ListLineageGroupsRequest$CreatedBefore' => '

A timestamp to filter against lineage groups created before a certain point in time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model bias jobs created before a specified time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model bias jobs created after a specified time.

', 'ListModelCardExportJobsRequest$CreationTimeAfter' => '

Only list model card export jobs that were created after the time specified.

', 'ListModelCardExportJobsRequest$CreationTimeBefore' => '

Only list model card export jobs that were created before the time specified.

', 'ListModelCardVersionsRequest$CreationTimeAfter' => '

Only list model card versions that were created after the time specified.

', 'ListModelCardVersionsRequest$CreationTimeBefore' => '

Only list model card versions that were created before the time specified.

', 'ListModelCardsRequest$CreationTimeAfter' => '

Only list model cards that were created after the time specified.

', 'ListModelCardsRequest$CreationTimeBefore' => '

Only list model cards that were created before the time specified.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model explainability jobs created before a specified time.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model explainability jobs created after a specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model quality monitoring job definitions created before the specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model quality monitoring job definitions created after the specified time.

', 'ListModelsInput$CreationTimeBefore' => '

A filter that returns only models created before the specified time (timestamp).

', 'ListModelsInput$CreationTimeAfter' => '

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

', 'ListMonitoringAlertHistoryRequest$CreationTimeBefore' => '

A filter that returns only alerts created on or before the specified time.

', 'ListMonitoringAlertHistoryRequest$CreationTimeAfter' => '

A filter that returns only alerts created on or after the specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeBefore' => '

Filter for jobs scheduled before a specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeAfter' => '

Filter for jobs scheduled after a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs modified after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs modified before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeBefore' => '

A filter that returns only monitoring schedules created before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeAfter' => '

A filter that returns only monitoring schedules created after a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeBefore' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeAfter' => '

A filter that returns only monitoring schedules modified after a specified time.

', 'ListPipelineExecutionsRequest$CreatedAfter' => '

A filter that returns the pipeline executions that were created after a specified time.

', 'ListPipelineExecutionsRequest$CreatedBefore' => '

A filter that returns the pipeline executions that were created before a specified time.

', 'ListPipelinesRequest$CreatedAfter' => '

A filter that returns the pipelines that were created after a specified time.

', 'ListPipelinesRequest$CreatedBefore' => '

A filter that returns the pipelines that were created before a specified time.

', 'ListProcessingJobsRequest$CreationTimeAfter' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$CreationTimeBefore' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only processing jobs modified after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only processing jobs modified before the specified time.

', 'ListProjectsInput$CreationTimeAfter' => '

A filter that returns the projects that were created after a specified time.

', 'ListProjectsInput$CreationTimeBefore' => '

A filter that returns the projects that were created before a specified time.

', 'ListResourceCatalogsRequest$CreationTimeAfter' => '

Use this parameter to search for ResourceCatalogs created after a specific date and time.

', 'ListResourceCatalogsRequest$CreationTimeBefore' => '

Use this parameter to search for ResourceCatalogs created before a specific date and time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeBefore' => '

A filter that returns only Lifecycle Configurations created on or before the specified time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeAfter' => '

A filter that returns only Lifecycle Configurations created on or after the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only Lifecycle Configurations modified before the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only Lifecycle Configurations modified after the specified time.

', 'ListTrainingJobsRequest$CreationTimeAfter' => '

A filter that returns only training jobs created after the specified time (timestamp).

', 'ListTrainingJobsRequest$CreationTimeBefore' => '

A filter that returns only training jobs created before the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only training jobs modified after the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only training jobs modified before the specified time (timestamp).

', 'ListTransformJobsRequest$CreationTimeAfter' => '

A filter that returns only transform jobs created after the specified time.

', 'ListTransformJobsRequest$CreationTimeBefore' => '

A filter that returns only transform jobs created before the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only transform jobs modified after the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only transform jobs modified before the specified time.

', 'ListTrialComponentsRequest$CreatedAfter' => '

A filter that returns only components created after the specified time.

', 'ListTrialComponentsRequest$CreatedBefore' => '

A filter that returns only components created before the specified time.

', 'ListTrialsRequest$CreatedAfter' => '

A filter that returns only trials created after the specified time.

', 'ListTrialsRequest$CreatedBefore' => '

A filter that returns only trials created before the specified time.

', 'MetricData$Timestamp' => '

The date and time that the algorithm emitted the metric.

', 'Model$CreationTime' => '

A timestamp that indicates when the model was created.

', 'ModelCard$CreationTime' => '

The date and time that the model card was created.

', 'ModelCard$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardExportJobSummary$CreatedAt' => '

The date and time that the model card export job was created.

', 'ModelCardExportJobSummary$LastModifiedAt' => '

The date and time that the model card export job was last modified..

', 'ModelCardSummary$CreationTime' => '

The date and time that the model card was created.

', 'ModelCardSummary$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardVersionSummary$CreationTime' => '

The date and time that the model card version was created.

', 'ModelCardVersionSummary$LastModifiedTime' => '

The time date and time that the model card version was last modified.

', 'ModelDashboardEndpoint$CreationTime' => '

A timestamp that indicates when the endpoint was created.

', 'ModelDashboardEndpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'ModelDashboardModelCard$CreationTime' => '

A timestamp that indicates when the model card was created.

', 'ModelDashboardModelCard$LastModifiedTime' => '

A timestamp that indicates when the model card was last updated.

', 'ModelDashboardMonitoringSchedule$CreationTime' => '

A timestamp that indicates when the monitoring schedule was created.

', 'ModelDashboardMonitoringSchedule$LastModifiedTime' => '

A timestamp that indicates when the monitoring schedule was last updated.

', 'ModelPackage$LastModifiedTime' => '

The last time the model package was modified.

', 'ModelSummary$CreationTime' => '

A timestamp that indicates when the model was created.

', 'MonitoringAlertHistorySummary$CreationTime' => '

A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

', 'MonitoringAlertSummary$CreationTime' => '

A timestamp that indicates when a monitor alert was created.

', 'MonitoringAlertSummary$LastModifiedTime' => '

A timestamp that indicates when a monitor alert was last updated.

', 'MonitoringExecutionSummary$ScheduledTime' => '

The time the monitoring job was scheduled.

', 'MonitoringExecutionSummary$CreationTime' => '

The time at which the monitoring job was created.

', 'MonitoringExecutionSummary$LastModifiedTime' => '

A timestamp that indicates the last time the monitoring job was modified.

', 'MonitoringJobDefinitionSummary$CreationTime' => '

The time that the monitoring job was created.

', 'MonitoringSchedule$CreationTime' => '

The time that the monitoring schedule was created.

', 'MonitoringSchedule$LastModifiedTime' => '

The last time the monitoring schedule was changed.

', 'MonitoringScheduleSummary$CreationTime' => '

The creation time of the monitoring schedule.

', 'MonitoringScheduleSummary$LastModifiedTime' => '

The last time the monitoring schedule was modified.

', 'PendingDeploymentSummary$StartTime' => '

The start time of the deployment.

', 'Pipeline$CreationTime' => '

The creation time of the pipeline.

', 'Pipeline$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'Pipeline$LastRunTime' => '

The time when the pipeline was last run.

', 'PipelineExecution$CreationTime' => '

The creation time of the pipeline execution.

', 'PipelineExecution$LastModifiedTime' => '

The time that the pipeline execution was last modified.

', 'PipelineExecutionStep$StartTime' => '

The time that the step started executing.

', 'PipelineExecutionStep$EndTime' => '

The time that the step stopped executing.

', 'PipelineExecutionSummary$StartTime' => '

The start time of the pipeline execution.

', 'PipelineSummary$CreationTime' => '

The creation time of the pipeline.

', 'PipelineSummary$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'PipelineSummary$LastExecutionTime' => '

The last time that a pipeline execution began.

', 'ProcessingJob$ProcessingEndTime' => '

The time that the processing job ended.

', 'ProcessingJob$ProcessingStartTime' => '

The time that the processing job started.

', 'ProcessingJob$LastModifiedTime' => '

The time the processing job was last modified.

', 'ProcessingJob$CreationTime' => '

The time the processing job was created.

', 'ProcessingJobSummary$CreationTime' => '

The time at which the processing job was created.

', 'ProcessingJobSummary$ProcessingEndTime' => '

The time at which the processing job completed.

', 'ProcessingJobSummary$LastModifiedTime' => '

A timestamp that indicates the last time the processing job was modified.

', 'ProductionVariantStatus$StartTime' => '

The start time of the current status change.

', 'ProfilerRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'Project$CreationTime' => '

A timestamp specifying when the project was created.

', 'Project$LastModifiedTime' => '

A timestamp container for when the project was last modified.

', 'ProjectSummary$CreationTime' => '

The time that the project was created.

', 'QueryFilters$CreatedBefore' => '

Filter the lineage entities connected to the StartArn(s) by created date.

', 'QueryFilters$CreatedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the create date.

', 'QueryFilters$ModifiedBefore' => '

Filter the lineage entities connected to the StartArn(s) before the last modified date.

', 'QueryFilters$ModifiedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the last modified date.

', 'ResourceCatalog$CreationTime' => '

The time the ResourceCatalog was created.

', 'SecondaryStatusTransition$StartTime' => '

A timestamp that shows when the training job transitioned to the current secondary status state.

', 'SecondaryStatusTransition$EndTime' => '

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

', 'StudioLifecycleConfigDetails$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'StudioLifecycleConfigDetails$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'TrainingJob$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'TrainingJob$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'TrainingJob$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'TrainingJob$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'TrainingJobSummary$CreationTime' => '

A timestamp that shows when the training job was created.

', 'TrainingJobSummary$TrainingEndTime' => '

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

', 'TrainingJobSummary$LastModifiedTime' => '

Timestamp when the training job was last modified.

', 'TransformJob$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJob$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'TransformJob$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'TransformJobSummary$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJobSummary$TransformEndTime' => '

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

', 'TransformJobSummary$LastModifiedTime' => '

Indicates when the transform job was last modified.

', 'Trial$CreationTime' => '

When the trial was created.

', 'Trial$LastModifiedTime' => '

Who last modified the trial.

', 'TrialComponent$StartTime' => '

When the component started.

', 'TrialComponent$EndTime' => '

When the component ended.

', 'TrialComponent$CreationTime' => '

When the component was created.

', 'TrialComponent$LastModifiedTime' => '

When the component was last modified.

', 'TrialComponentMetricSummary$TimeStamp' => '

When the metric was last updated.

', 'TrialComponentSimpleSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$StartTime' => '

When the component started.

', 'TrialComponentSummary$EndTime' => '

When the component ended.

', 'TrialComponentSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$LastModifiedTime' => '

When the component was last modified.

', 'TrialSummary$CreationTime' => '

When the trial was created.

', 'TrialSummary$LastModifiedTime' => '

When the trial was last modified.

', 'UpdateTrialComponentRequest$StartTime' => '

When the component started.

', 'UpdateTrialComponentRequest$EndTime' => '

When the component ended.

', 'Workforce$LastUpdatedDate' => '

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce\'s allow list.

', 'Workforce$CreateDate' => '

The date that the workforce is created.

', 'Workteam$CreateDate' => '

The date and time that the work team was created (timestamp).

', 'Workteam$LastUpdatedDate' => '

The date and time that the work team was last updated (timestamp).

', ], ], 'TimestampAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$TimestampAttributeName' => '

The name of the column indicating a point in time at which the target value of a given item is recorded.

', ], ], 'TrafficDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Phase$DurationInSeconds' => '

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.

', 'Stairs$DurationInSeconds' => '

Defines how long each traffic step should be.

', ], ], 'TrafficPattern' => [ 'base' => '

Defines the traffic pattern of the load test.

', 'refs' => [ 'RecommendationJobInputConfig$TrafficPattern' => '

Specifies the traffic pattern of the job.

', ], ], 'TrafficRoutingConfig' => [ 'base' => '

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

', 'refs' => [ 'BlueGreenUpdatePolicy$TrafficRoutingConfiguration' => '

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

', ], ], 'TrafficRoutingConfigType' => [ 'base' => NULL, 'refs' => [ 'TrafficRoutingConfig$Type' => '

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

', ], ], 'TrafficType' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$TrafficType' => '

Defines the traffic patterns. Choose either PHASES or STAIRS.

', ], ], 'TrainingContainerArgument' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerArguments$member' => NULL, ], ], 'TrainingContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerArguments' => '

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

', ], ], 'TrainingContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerEntrypoint' => '

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

', ], ], 'TrainingContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerEntrypoint$member' => NULL, ], ], 'TrainingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$key' => NULL, ], ], 'TrainingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$Environment' => '

The environment variables to set in the Docker container.

', 'DescribeTrainingJobResponse$Environment' => '

The environment variables to set in the Docker container.

', 'TrainingJob$Environment' => '

The environment variables to set in the Docker container.

', ], ], 'TrainingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$value' => NULL, ], ], 'TrainingImageConfig' => [ 'base' => '

The configuration to use an image from a private Docker registry for a training job.

', 'refs' => [ 'AlgorithmSpecification$TrainingImageConfig' => '

The configuration to use an image from a private Docker registry for a training job.

', ], ], 'TrainingInputMode' => [ 'base' => '

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won\'t be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren\'t supported. The startup time is lower when there are fewer files in the S3 bucket provided.

', 'refs' => [ 'AlgorithmSpecification$TrainingInputMode' => NULL, 'Channel$InputMode' => '

(Optional) The input mode to use for the data channel in a training job. If you don\'t set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job\'s general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

', 'HyperParameterAlgorithmSpecification$TrainingInputMode' => NULL, 'InputModes$member' => NULL, 'TrainingJobDefinition$TrainingInputMode' => NULL, ], ], 'TrainingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.

', 'HyperParameterTuningResourceConfig$InstanceCount' => '

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

', 'InstanceGroup$InstanceCount' => '

Specifies the number of instances of the instance group.

', 'ResourceConfig$InstanceCount' => '

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

', ], ], 'TrainingInstanceType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceType' => '

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

', 'HyperParameterTuningResourceConfig$InstanceType' => '

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

', 'InstanceGroup$InstanceType' => '

Specifies the instance type of the instance group.

', 'ResourceConfig$InstanceType' => '

The ML compute instance type.

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.

Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to reduce model training time. The ml.p4de.24xlarge instances are available in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.

', 'TrainingInstanceTypes$member' => NULL, ], ], 'TrainingInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTrainingInstanceTypes' => '

A list of the instance types that this algorithm can use for training.

', ], ], 'TrainingJob' => [ 'base' => '

Contains information about a training job.

', 'refs' => [ 'SearchRecord$TrainingJob' => '

The properties of a training job.

', 'TrialComponentSourceDetail$TrainingJob' => '

Information about a training job that\'s the source of a trial component.

', ], ], 'TrainingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'DescribeProcessingJobResponse$TrainingJobArn' => '

The ARN of a training job associated with this processing job.

', 'DescribeTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'HyperParameterTrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'ProcessingJob$TrainingJobArn' => '

The ARN of the training job associated with this processing job.

', 'TrainingJob$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'TrainingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', 'TrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'UpdateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', ], ], 'TrainingJobDefinition' => [ 'base' => '

Defines the input needed to run a training job using the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TrainingJobDefinition' => '

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

', ], ], 'TrainingJobEarlyStoppingType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType' => '

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

', ], ], 'TrainingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$TrainingJobName' => '

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTrainingJobRequest$TrainingJobName' => '

The name of the training job.

', 'DescribeTrainingJobResponse$TrainingJobName' => '

Name of the model training job.

', 'HyperParameterTrainingJobSummary$TrainingJobName' => '

The name of the training job.

', 'StopTrainingJobRequest$TrainingJobName' => '

The name of the training job to stop.

', 'TrainingJob$TrainingJobName' => '

The name of the training job.

', 'TrainingJobSummary$TrainingJobName' => '

The name of the training job that you want a summary for.

', 'UpdateTrainingJobRequest$TrainingJobName' => '

The name of a training job to update the Debugger profiling configuration.

', 'WarmPoolStatus$ReusedByJob' => '

The name of the matching training job that reused the warm pool.

', ], ], 'TrainingJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobRequest$SortBy' => '

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

', ], ], 'TrainingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingJobStatus' => '

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'HyperParameterTrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals' => '

A filter that returns only training jobs with the specified status.

', 'ListTrainingJobsRequest$StatusEquals' => '

A filter that retrieves only training jobs with a specific status.

', 'TrainingJob$TrainingJobStatus' => '

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'TrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', ], ], 'TrainingJobStatusCounter' => [ 'base' => NULL, 'refs' => [ 'TrainingJobStatusCounters$Completed' => '

The number of completed training jobs launched by the hyperparameter tuning job.

', 'TrainingJobStatusCounters$InProgress' => '

The number of in-progress training jobs launched by a hyperparameter tuning job.

', 'TrainingJobStatusCounters$RetryableError' => '

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

', 'TrainingJobStatusCounters$NonRetryableError' => '

The number of training jobs that failed and can\'t be retried. A failed training job can\'t be retried if it failed because a client error occurred.

', 'TrainingJobStatusCounters$Stopped' => '

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

', ], ], 'TrainingJobStatusCounters' => [ 'base' => '

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters' => NULL, 'HyperParameterTuningJobSummary$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

', ], ], 'TrainingJobStepMetadata' => [ 'base' => '

Metadata for a training job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TrainingJob' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', ], ], 'TrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsResponse$TrainingJobSummaries' => '

An array of TrainingJobSummary objects, each listing a training job.

', ], ], 'TrainingJobSummary' => [ 'base' => '

Provides summary information about a training job.

', 'refs' => [ 'TrainingJobSummaries$member' => NULL, ], ], 'TrainingRepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAccessMode' => '

The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.

', ], ], 'TrainingRepositoryAuthConfig' => [ 'base' => '

An object containing authentication information for a private Docker registry.

', 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAuthConfig' => '

An object containing authentication information for a private Docker registry containing your training images.

', ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.

', ], ], 'TrainingSpecification' => [ 'base' => '

Defines how the algorithm is used for a training job.

', 'refs' => [ 'CreateAlgorithmInput$TrainingSpecification' => '

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

', 'DescribeAlgorithmOutput$TrainingSpecification' => '

Details about training jobs run by this algorithm.

', ], ], 'TrainingTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingTimeInSeconds' => '

The training time in seconds.

', 'TrainingJob$TrainingTimeInSeconds' => '

The training time in seconds.

', ], ], 'TransformDataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'TransformInput$DataSource' => '

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

', ], ], 'TransformEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$key' => NULL, ], ], 'TransformEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'DescribeTransformJobResponse$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJob$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJobDefinition$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', ], ], 'TransformEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$value' => NULL, ], ], 'TransformInput' => [ 'base' => '

Describes the input source of a transform job and the way the transform job consumes it.

', 'refs' => [ 'CreateTransformJobRequest$TransformInput' => '

Describes the input source and the way the transform job consumes it.

', 'DescribeTransformJobResponse$TransformInput' => '

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

', 'TransformJob$TransformInput' => NULL, 'TransformJobDefinition$TransformInput' => '

A description of the input source and the way the transform job consumes it.

', ], ], 'TransformInstanceCount' => [ 'base' => NULL, 'refs' => [ 'TransformResources$InstanceCount' => '

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

', ], ], 'TransformInstanceType' => [ 'base' => NULL, 'refs' => [ 'TransformInstanceTypes$member' => NULL, 'TransformResources$InstanceType' => '

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

', ], ], 'TransformInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

', 'InferenceSpecification$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'TransformJob' => [ 'base' => '

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

', 'refs' => [ 'ModelDashboardModel$LastBatchTransformJob' => NULL, 'TrialComponentSourceDetail$TransformJob' => '

Information about a transform job that\'s the source of a trial component.

', ], ], 'TransformJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'DescribeTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJob$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', 'TransformJobSummary$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', ], ], 'TransformJobDefinition' => [ 'base' => '

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

', 'ModelPackageValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

', ], ], 'TransformJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$TransformJobName' => '

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTransformJobRequest$TransformJobName' => '

The name of the transform job that you want to view details of.

', 'DescribeTransformJobResponse$TransformJobName' => '

The name of the transform job.

', 'StopTransformJobRequest$TransformJobName' => '

The name of the batch transform job to stop.

', 'TransformJob$TransformJobName' => '

The name of the transform job.

', 'TransformJobSummary$TransformJobName' => '

The name of the transform job.

', ], ], 'TransformJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTransformJobResponse$TransformJobStatus' => '

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

', 'ListTransformJobsRequest$StatusEquals' => '

A filter that retrieves only transform jobs with a specific status.

', 'TransformJob$TransformJobStatus' => '

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.

  • Completed - The job has completed.

  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

  • Stopping - The transform job is stopping.

  • Stopped - The transform job has stopped.

', 'TransformJobSummary$TransformJobStatus' => '

The status of the transform job.

', ], ], 'TransformJobStepMetadata' => [ 'base' => '

Metadata for a transform job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TransformJob' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', ], ], 'TransformJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTransformJobsResponse$TransformJobSummaries' => '

An array of TransformJobSummary objects.

', ], ], 'TransformJobSummary' => [ 'base' => '

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

', 'refs' => [ 'TransformJobSummaries$member' => NULL, ], ], 'TransformOutput' => [ 'base' => '

Describes the results of a transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformOutput' => '

Describes the results of the transform job.

', 'DescribeTransformJobResponse$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', 'TransformJob$TransformOutput' => NULL, 'TransformJobDefinition$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', ], ], 'TransformResources' => [ 'base' => '

Describes the resources, including ML instance types and ML instance count, to use for transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'DescribeTransformJobResponse$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'TransformJob$TransformResources' => NULL, 'TransformJobDefinition$TransformResources' => '

Identifies the ML compute instances for the transform job.

', ], ], 'TransformS3DataSource' => [ 'base' => '

Describes the S3 data source.

', 'refs' => [ 'TransformDataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'TransformationAttributeName' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$key' => NULL, 'FillingTransformations$key' => NULL, ], ], 'Trial' => [ 'base' => '

The properties of a trial as returned by the Search API.

', 'refs' => [ 'SearchRecord$Trial' => '

The properties of a trial.

', ], ], 'TrialArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'CreateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DeleteTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial that is being deleted.

', 'DescribeTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DisassociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'Trial$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'TrialSummary$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'UpdateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', ], ], 'TrialComponent' => [ 'base' => '

The properties of a trial component as returned by the Search API.

', 'refs' => [ 'SearchRecord$TrialComponent' => '

The properties of a trial component.

', ], ], 'TrialComponentArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'CreateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DeleteTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the component is being deleted.

', 'DescribeTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DisassociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponent$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSimpleSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'UpdateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', ], ], 'TrialComponentArtifact' => [ 'base' => '

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'refs' => [ 'TrialComponentArtifacts$value' => NULL, ], ], 'TrialComponentArtifactValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$Value' => '

The location of the artifact.

', ], ], 'TrialComponentArtifacts' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$InputArtifacts' => '

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

', 'CreateTrialComponentRequest$OutputArtifacts' => '

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'DescribeTrialComponentResponse$InputArtifacts' => '

The input artifacts of the component.

', 'DescribeTrialComponentResponse$OutputArtifacts' => '

The output artifacts of the component.

', 'TrialComponent$InputArtifacts' => '

The input artifacts of the component.

', 'TrialComponent$OutputArtifacts' => '

The output artifacts of the component.

', 'UpdateTrialComponentRequest$InputArtifacts' => '

Replaces all of the component\'s input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

', 'UpdateTrialComponentRequest$OutputArtifacts' => '

Replaces all of the component\'s output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

', ], ], 'TrialComponentKey128' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifacts$key' => NULL, ], ], 'TrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentKey256$member' => NULL, ], ], 'TrialComponentKey320' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameters$key' => NULL, ], ], 'TrialComponentMetricSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Metrics' => '

The metrics for the component.

', 'TrialComponent$Metrics' => '

The metrics for the component.

', ], ], 'TrialComponentMetricSummary' => [ 'base' => '

A summary of the metrics of a trial component.

', 'refs' => [ 'TrialComponentMetricSummaries$member' => NULL, ], ], 'TrialComponentParameterValue' => [ 'base' => '

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

', 'refs' => [ 'TrialComponentParameters$value' => NULL, ], ], 'TrialComponentParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$Parameters' => '

The hyperparameters for the component.

', 'DescribeTrialComponentResponse$Parameters' => '

The hyperparameters of the component.

', 'TrialComponent$Parameters' => '

The hyperparameters of the component.

', 'UpdateTrialComponentRequest$Parameters' => '

Replaces all of the component\'s hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

', ], ], 'TrialComponentPrimaryStatus' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$PrimaryStatus' => '

The status of the trial component.

', ], ], 'TrialComponentSimpleSummaries' => [ 'base' => NULL, 'refs' => [ 'Trial$TrialComponentSummaries' => '

A list of the components associated with the trial. For each component, a summary of the component\'s properties is included.

', ], ], 'TrialComponentSimpleSummary' => [ 'base' => '

A short summary of a trial component.

', 'refs' => [ 'TrialComponentSimpleSummaries$member' => NULL, ], ], 'TrialComponentSource' => [ 'base' => '

The Amazon Resource Name (ARN) and job type of the source of a trial component.

', 'refs' => [ 'DescribeTrialComponentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'TrialComponent$Source' => '

The Amazon Resource Name (ARN) and job type of the source of the component.

', 'TrialComponentSimpleSummary$TrialComponentSource' => NULL, 'TrialComponentSources$member' => NULL, 'TrialComponentSummary$TrialComponentSource' => NULL, ], ], 'TrialComponentSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', 'TrialComponentSource$SourceArn' => '

The source Amazon Resource Name (ARN).

', 'TrialComponentSourceDetail$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialComponentSourceDetail' => [ 'base' => '

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

', 'refs' => [ 'TrialComponent$SourceDetail' => '

Details of the source of the component.

', ], ], 'TrialComponentSources' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Sources' => '

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

', ], ], 'TrialComponentStatus' => [ 'base' => '

The status of the trial component.

', 'refs' => [ 'CreateTrialComponentRequest$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'DescribeTrialComponentResponse$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'TrialComponent$Status' => NULL, 'TrialComponentSummary$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'UpdateTrialComponentRequest$Status' => '

The new status of the component.

', ], ], 'TrialComponentStatusMessage' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$Message' => '

If the component failed, a message describing why.

', ], ], 'TrialComponentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsResponse$TrialComponentSummaries' => '

A list of the summaries of your trial components.

', ], ], 'TrialComponentSummary' => [ 'base' => '

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

', 'refs' => [ 'TrialComponentSummaries$member' => NULL, ], ], 'TrialSource' => [ 'base' => '

The source of the trial.

', 'refs' => [ 'DescribeTrialResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'Trial$Source' => NULL, 'TrialSummary$TrialSource' => NULL, ], ], 'TrialSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialsResponse$TrialSummaries' => '

A list of the summaries of your trials.

', ], ], 'TrialSummary' => [ 'base' => '

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

', 'refs' => [ 'TrialSummaries$member' => NULL, ], ], 'TtlDuration' => [ 'base' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'refs' => [ 'OnlineStoreConfig$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'OnlineStoreConfigUpdate$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', ], ], 'TtlDurationUnit' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Unit' => '

TtlDuration time unit.

', ], ], 'TtlDurationValue' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Value' => '

TtlDuration time value.

', ], ], 'TuningJobCompletionCriteria' => [ 'base' => '

The job completion criteria.

', 'refs' => [ 'HyperParameterTuningJobConfig$TuningJobCompletionCriteria' => '

The tuning job\'s completion criteria.

', ], ], 'TuningJobStepMetaData' => [ 'base' => '

Metadata for a tuning step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TuningJob' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'USD' => [ 'base' => '

Represents an amount of money in United States dollars.

', 'refs' => [ 'PublicWorkforceTaskPrice$AmountInUsd' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

', ], ], 'UiConfig' => [ 'base' => '

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

', 'refs' => [ 'HumanTaskConfig$UiConfig' => '

Information about the user interface that workers use to complete the labeling task.

', ], ], 'UiTemplate' => [ 'base' => '

The Liquid template for the worker user interface.

', 'refs' => [ 'CreateHumanTaskUiRequest$UiTemplate' => NULL, 'RenderUiTemplateRequest$UiTemplate' => '

A Template object containing the worker UI template to render.

', ], ], 'UiTemplateInfo' => [ 'base' => '

Container for user interface template information.

', 'refs' => [ 'DescribeHumanTaskUiResponse$UiTemplate' => NULL, ], ], 'Uid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Uid' => '

The POSIX user ID.

', ], ], 'UpdateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSoftwareRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSoftwareResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$ModelDataUrl' => '

The location of the model artifacts. For more information, see ContainerDefinition.

', 'ClarifyShapBaselineConfig$ShapBaselineUri' => '

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

', 'ContainerDefinition$ModelDataUrl' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

', 'InferenceComponentContainerSpecification$ArtifactUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InferenceComponentContainerSpecificationSummary$ArtifactUrl' => '

The Amazon S3 path where the model artifacts are stored.

', 'ModelPackageContainerDefinition$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

', 'SourceAlgorithm$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.

', ], ], 'UserContext' => [ 'base' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

', 'refs' => [ 'AssociationSummary$CreatedBy' => NULL, 'DescribeActionResponse$CreatedBy' => NULL, 'DescribeActionResponse$LastModifiedBy' => NULL, 'DescribeArtifactResponse$CreatedBy' => NULL, 'DescribeArtifactResponse$LastModifiedBy' => NULL, 'DescribeContextResponse$CreatedBy' => NULL, 'DescribeContextResponse$LastModifiedBy' => NULL, 'DescribeExperimentResponse$CreatedBy' => '

Who created the experiment.

', 'DescribeExperimentResponse$LastModifiedBy' => '

Who last modified the experiment.

', 'DescribeLineageGroupResponse$CreatedBy' => NULL, 'DescribeLineageGroupResponse$LastModifiedBy' => NULL, 'DescribeModelCardResponse$CreatedBy' => NULL, 'DescribeModelCardResponse$LastModifiedBy' => NULL, 'DescribeModelPackageGroupOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$LastModifiedBy' => NULL, 'DescribePipelineExecutionResponse$CreatedBy' => NULL, 'DescribePipelineExecutionResponse$LastModifiedBy' => NULL, 'DescribePipelineResponse$CreatedBy' => NULL, 'DescribePipelineResponse$LastModifiedBy' => NULL, 'DescribeProjectOutput$CreatedBy' => NULL, 'DescribeProjectOutput$LastModifiedBy' => NULL, 'DescribeTrialComponentResponse$CreatedBy' => '

Who created the trial component.

', 'DescribeTrialComponentResponse$LastModifiedBy' => '

Who last modified the component.

', 'DescribeTrialResponse$CreatedBy' => '

Who created the trial.

', 'DescribeTrialResponse$LastModifiedBy' => '

Who last modified the trial.

', 'Experiment$CreatedBy' => '

Who created the experiment.

', 'Experiment$LastModifiedBy' => NULL, 'ModelCard$CreatedBy' => NULL, 'ModelCard$LastModifiedBy' => NULL, 'ModelDashboardModelCard$CreatedBy' => NULL, 'ModelDashboardModelCard$LastModifiedBy' => NULL, 'ModelPackage$CreatedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackage$LastModifiedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackageGroup$CreatedBy' => NULL, 'Pipeline$CreatedBy' => NULL, 'Pipeline$LastModifiedBy' => NULL, 'PipelineExecution$CreatedBy' => NULL, 'PipelineExecution$LastModifiedBy' => NULL, 'Project$CreatedBy' => '

Who created the project.

', 'Project$LastModifiedBy' => NULL, 'Trial$CreatedBy' => '

Who created the trial.

', 'Trial$LastModifiedBy' => NULL, 'TrialComponent$CreatedBy' => '

Who created the trial component.

', 'TrialComponent$LastModifiedBy' => NULL, 'TrialComponentSimpleSummary$CreatedBy' => NULL, 'TrialComponentSummary$CreatedBy' => '

Who created the trial component.

', 'TrialComponentSummary$LastModifiedBy' => '

Who last modified the component.

', ], ], 'UserProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'DescribeUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'UpdateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', ], ], 'UserProfileDetails' => [ 'base' => '

The user profile details.

', 'refs' => [ 'UserProfileList$member' => NULL, ], ], 'UserProfileList' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesResponse$UserProfiles' => '

The list of user profiles.

', ], ], 'UserProfileName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$UserProfileName' => '

The user profile name.

', 'CreateAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'CreatePresignedDomainUrlRequest$UserProfileName' => '

The name of the UserProfile to sign-in as.

', 'CreateUserProfileRequest$UserProfileName' => '

A name for the UserProfile. This value is not case sensitive.

', 'DeleteAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DeleteUserProfileRequest$UserProfileName' => '

The user profile name.

', 'DescribeAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DescribeAppResponse$UserProfileName' => '

The user profile name.

', 'DescribeUserProfileRequest$UserProfileName' => '

The user profile name. This value is not case sensitive.

', 'DescribeUserProfileResponse$UserProfileName' => '

The user profile name.

', 'ListAppsRequest$UserProfileNameEquals' => '

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

', 'ListUserProfilesRequest$UserProfileNameContains' => '

A parameter by which to filter the results.

', 'OwnershipSettings$OwnerUserProfileName' => '

The user profile who is the owner of the space.

', 'OwnershipSettingsSummary$OwnerUserProfileName' => '

The user profile who is the owner of the space.

', 'UpdateUserProfileRequest$UserProfileName' => '

The user profile name.

', 'UserProfileDetails$UserProfileName' => '

The user profile name.

', ], ], 'UserProfileSortKey' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'UserProfileStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeUserProfileResponse$Status' => '

The status.

', 'UserProfileDetails$Status' => '

The status.

', ], ], 'UserSettings' => [ 'base' => '

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'refs' => [ 'CreateDomainRequest$DefaultUserSettings' => '

The default settings to use to create a user profile when UserSettings isn\'t specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'CreateUserProfileRequest$UserSettings' => '

A collection of settings.

', 'DescribeDomainResponse$DefaultUserSettings' => '

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

', 'DescribeUserProfileResponse$UserSettings' => '

A collection of settings.

', 'UpdateDomainRequest$DefaultUserSettings' => '

A collection of settings.

', 'UpdateUserProfileRequest$UserSettings' => '

A collection of settings.

', ], ], 'UsersPerStep' => [ 'base' => NULL, 'refs' => [ 'Stairs$UsersPerStep' => '

Specifies how many new users to spawn in each step.

', ], ], 'UtilizationMetric' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$CpuUtilization' => '

The expected CPU utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', 'RecommendationMetrics$MemoryUtilization' => '

The expected memory utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', ], ], 'UtilizationPercentagePerCore' => [ 'base' => NULL, 'refs' => [ 'GetScalingConfigurationRecommendationRequest$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

', 'GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

', ], ], 'ValidationFraction' => [ 'base' => NULL, 'refs' => [ 'AutoMLDataSplitConfig$ValidationFraction' => '

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

', ], ], 'VariantName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$VariantName' => '

The name of an existing production variant where you host the inference component.

', 'DescribeInferenceComponentOutput$VariantName' => '

The name of the production variant that hosts the inference component.

', 'DesiredWeightAndCapacity$VariantName' => '

The name of the variant to update.

', 'InferenceComponentSummary$VariantName' => '

The name of the production variant that hosts the inference component.

', 'ListInferenceComponentsInput$VariantNameEquals' => '

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

', 'PendingProductionVariantSummary$VariantName' => '

The name of the variant.

', 'ProductionVariant$VariantName' => '

The name of the production variant.

', 'ProductionVariantSummary$VariantName' => '

The name of the variant.

', ], ], 'VariantProperty' => [ 'base' => '

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

', 'refs' => [ 'VariantPropertyList$member' => NULL, ], ], 'VariantPropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointInput$ExcludeRetainedVariantProperties' => '

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don\'t specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

', ], ], 'VariantPropertyType' => [ 'base' => NULL, 'refs' => [ 'VariantProperty$VariantPropertyType' => '

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

', ], ], 'VariantStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$Status' => '

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.

  • Deleting: Terminating inference resources for the production variant.

  • Updating: Updating capacity for the production variant.

  • ActivatingTraffic: Turning on traffic for the production variant.

  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

', ], ], 'VariantStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$StatusMessage' => '

A message that describes the status of the production variant.

', ], ], 'VariantWeight' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredWeight' => '

The variant\'s weight.

', 'PendingProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'PendingProductionVariantSummary$DesiredWeight' => '

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariant$InitialVariantWeight' => '

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

', 'ProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'ProductionVariantSummary$DesiredWeight' => '

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

', ], ], 'VectorConfig' => [ 'base' => '

Configuration for your vector collection type.

', 'refs' => [ 'CollectionConfig$VectorConfig' => '

Configuration for your vector collection type.

  • Dimension: The number of elements in your vector.

', ], ], 'VendorGuidance' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$VendorGuidance' => '

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'DescribeImageVersionResponse$VendorGuidance' => '

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'UpdateImageVersionRequest$VendorGuidance' => '

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$VersionId' => '

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

', ], ], 'VersionedArnOrName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

', 'DeleteModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'DescribeModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', ], ], 'Vertex' => [ 'base' => '

A lineage entity connected to the starting entity(ies).

', 'refs' => [ 'Vertices$member' => NULL, ], ], 'Vertices' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Vertices' => '

A list of vertices connected to the start entity(ies) in the lineage graph.

', ], ], 'VisibilityConditions' => [ 'base' => '

The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn\'t match, the result is excluded from the search response. Any resources that don\'t have a key from the list that you\'ve provided will also be included in the search response.

', 'refs' => [ 'VisibilityConditionsList$member' => NULL, ], ], 'VisibilityConditionsKey' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Key' => '

The key that specifies the tag that you\'re using to filter the search results. It must be in the following format: Tags.<key>.

', ], ], 'VisibilityConditionsList' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$VisibilityConditions' => '

Limits the results of your search request to the resources that you can access.

', ], ], 'VisibilityConditionsValue' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Value' => '

The value for the tag that you\'re using to filter the search results.

', ], ], 'VolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$VolumeSizeInGB' => '

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

', 'ResourceConfig$VolumeSizeInGB' => '

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn\'t provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance\'s storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

', ], ], 'VpcConfig' => [ 'base' => '

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

', 'refs' => [ 'AutoMLSecurityConfig$VpcConfig' => '

The VPC configuration.

', 'CreateClusterRequest$VpcConfig' => NULL, 'CreateEndpointConfigInput$VpcConfig' => NULL, 'CreateModelInput$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

', 'CreateTrainingJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeClusterResponse$VpcConfig' => NULL, 'DescribeEndpointConfigOutput$VpcConfig' => NULL, 'DescribeModelOutput$VpcConfig' => '

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

', 'DescribeTrainingJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'HyperParameterTrainingJobDefinition$VpcConfig' => '

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'LabelingJobResourceConfig$VpcConfig' => NULL, 'Model$VpcConfig' => NULL, 'MonitoringNetworkConfig$VpcConfig' => NULL, 'NetworkConfig$VpcConfig' => NULL, 'TrainingJob$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', 'DescribeDomainResponse$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', ], ], 'VpcOnlyTrustedAccounts' => [ 'base' => NULL, 'refs' => [ 'DockerSettings$VpcOnlyTrustedAccounts' => '

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

', ], ], 'VpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'WaitIntervalInSeconds' => [ 'base' => NULL, 'refs' => [ 'RollingUpdatePolicy$WaitIntervalInSeconds' => '

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

', 'TrafficRoutingConfig$WaitIntervalInSeconds' => '

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

', ], ], 'WarmPoolResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsRequest$WarmPoolStatusEquals' => '

A filter that retrieves only training jobs with a specific warm pool status.

', 'WarmPoolStatus$Status' => '

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

', ], ], 'WarmPoolStatus' => [ 'base' => '

Status and billing information about the warm pool.

', 'refs' => [ 'DescribeTrainingJobResponse$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', 'TrainingJobSummary$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', ], ], 'Workforce' => [ 'base' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'refs' => [ 'DescribeWorkforceResponse$Workforce' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'UpdateWorkforceResponse$Workforce' => '

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'Workforces$member' => NULL, ], ], 'WorkforceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceResponse$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', 'Workforce$WorkforceArn' => '

The Amazon Resource Name (ARN) of the private workforce.

', 'Workteam$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', ], ], 'WorkforceFailureReason' => [ 'base' => NULL, 'refs' => [ 'Workforce$FailureReason' => '

The reason your workforce failed.

', ], ], 'WorkforceName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceRequest$WorkforceName' => '

The name of the private workforce.

', 'CreateWorkteamRequest$WorkforceName' => '

The name of the workforce.

', 'DeleteWorkforceRequest$WorkforceName' => '

The name of the workforce.

', 'DescribeWorkforceRequest$WorkforceName' => '

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

', 'ListWorkforcesRequest$NameContains' => '

A filter you can use to search for workforces using part of the workforce name.

', 'UpdateWorkforceRequest$WorkforceName' => '

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

', 'Workforce$WorkforceName' => '

The name of the private workforce.

', ], ], 'WorkforceSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSecurityGroupIds$member' => NULL, ], ], 'WorkforceSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'WorkforceVpcConfigResponse$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', ], ], 'WorkforceStatus' => [ 'base' => NULL, 'refs' => [ 'Workforce$Status' => '

The status of your workforce.

', ], ], 'WorkforceSubnetId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSubnets$member' => NULL, ], ], 'WorkforceSubnets' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', 'WorkforceVpcConfigResponse$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', ], ], 'WorkforceVpcConfigRequest' => [ 'base' => '

The VPC object you use to create or update a workforce.

', 'refs' => [ 'CreateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to configure a workforce using VPC.

', 'UpdateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to update your VPC configuration for a workforce.

', ], ], 'WorkforceVpcConfigResponse' => [ 'base' => '

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

', 'refs' => [ 'Workforce$WorkforceVpcConfig' => '

The configuration of a VPC workforce.

', ], ], 'WorkforceVpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigResponse$VpcEndpointId' => '

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

', ], ], 'WorkforceVpcId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', 'WorkforceVpcConfigResponse$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', ], ], 'Workforces' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesResponse$Workforces' => '

A list containing information about your workforce.

', ], ], 'WorkspaceSettings' => [ 'base' => '

The workspace settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$WorkspaceSettings' => '

The workspace settings for the SageMaker Canvas application.

', ], ], 'Workteam' => [ 'base' => '

Provides details about a labeling work team.

', 'refs' => [ 'DescribeWorkteamResponse$Workteam' => '

A Workteam instance that contains information about the work team.

', 'UpdateWorkteamResponse$Workteam' => '

A Workteam object that describes the updated work team.

', 'Workteams$member' => NULL, ], ], 'WorkteamArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamResponse$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

', 'DescribeSubscribedWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the subscribed work team to describe.

', 'HumanLoopConfig$WorkteamArn' => '

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

', 'HumanTaskConfig$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

', 'LabelingJobSummary$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to the job.

', 'ListLabelingJobsForWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

', 'SubscribedWorkteam$WorkteamArn' => '

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

', 'Workteam$WorkteamArn' => '

The Amazon Resource Name (ARN) that identifies the work team.

', ], ], 'WorkteamName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$WorkteamName' => '

The name of the work team. Use this name to identify the work team.

', 'DeleteWorkteamRequest$WorkteamName' => '

The name of the work team to delete.

', 'DescribeWorkteamRequest$WorkteamName' => '

The name of the work team to return a description of.

', 'ListSubscribedWorkteamsRequest$NameContains' => '

A string in the work team name. This filter returns only work teams whose name contains the specified string.

', 'ListWorkteamsRequest$NameContains' => '

A string in the work team\'s name. This filter returns only work teams whose name contains the specified string.

', 'UpdateWorkteamRequest$WorkteamName' => '

The name of the work team to update.

', 'Workteam$WorkteamName' => '

The name of the work team.

', ], ], 'Workteams' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsResponse$Workteams' => '

An array of Workteam objects, each describing a work team.

', ], ], ],]; diff --git a/src/data/signer/2017-08-25/api-2.json b/src/data/signer/2017-08-25/api-2.json index baab1f8954..5b6b6e3b10 100644 --- a/src/data/signer/2017-08-25/api-2.json +++ b/src/data/signer/2017-08-25/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"signer", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"signer", "serviceFullName":"AWS Signer", "serviceId":"signer", diff --git a/src/data/signer/2017-08-25/api-2.json.php b/src/data/signer/2017-08-25/api-2.json.php index 4e52e57182..e0ba3368da 100644 --- a/src/data/signer/2017-08-25/api-2.json.php +++ b/src/data/signer/2017-08-25/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-08-25', 'endpointPrefix' => 'signer', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceAbbreviation' => 'signer', 'serviceFullName' => 'AWS Signer', 'serviceId' => 'signer', 'signatureVersion' => 'v4', 'signingName' => 'signer', 'uid' => 'signer-2017-08-25', ], 'operations' => [ 'AddProfilePermission' => [ 'name' => 'AddProfilePermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/signing-profiles/{profileName}/permissions', ], 'input' => [ 'shape' => 'AddProfilePermissionRequest', ], 'output' => [ 'shape' => 'AddProfilePermissionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceLimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'CancelSigningProfile' => [ 'name' => 'CancelSigningProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/signing-profiles/{profileName}', ], 'input' => [ 'shape' => 'CancelSigningProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'DescribeSigningJob' => [ 'name' => 'DescribeSigningJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-jobs/{jobId}', ], 'input' => [ 'shape' => 'DescribeSigningJobRequest', ], 'output' => [ 'shape' => 'DescribeSigningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'GetRevocationStatus' => [ 'name' => 'GetRevocationStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/revocations', ], 'input' => [ 'shape' => 'GetRevocationStatusRequest', ], 'output' => [ 'shape' => 'GetRevocationStatusResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], 'endpoint' => [ 'hostPrefix' => 'verification.', ], ], 'GetSigningPlatform' => [ 'name' => 'GetSigningPlatform', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-platforms/{platformId}', ], 'input' => [ 'shape' => 'GetSigningPlatformRequest', ], 'output' => [ 'shape' => 'GetSigningPlatformResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'GetSigningProfile' => [ 'name' => 'GetSigningProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-profiles/{profileName}', ], 'input' => [ 'shape' => 'GetSigningProfileRequest', ], 'output' => [ 'shape' => 'GetSigningProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListProfilePermissions' => [ 'name' => 'ListProfilePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-profiles/{profileName}/permissions', ], 'input' => [ 'shape' => 'ListProfilePermissionsRequest', ], 'output' => [ 'shape' => 'ListProfilePermissionsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListSigningJobs' => [ 'name' => 'ListSigningJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-jobs', ], 'input' => [ 'shape' => 'ListSigningJobsRequest', ], 'output' => [ 'shape' => 'ListSigningJobsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListSigningPlatforms' => [ 'name' => 'ListSigningPlatforms', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-platforms', ], 'input' => [ 'shape' => 'ListSigningPlatformsRequest', ], 'output' => [ 'shape' => 'ListSigningPlatformsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListSigningProfiles' => [ 'name' => 'ListSigningProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-profiles', ], 'input' => [ 'shape' => 'ListSigningProfilesRequest', ], 'output' => [ 'shape' => 'ListSigningProfilesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'PutSigningProfile' => [ 'name' => 'PutSigningProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/signing-profiles/{profileName}', ], 'input' => [ 'shape' => 'PutSigningProfileRequest', ], 'output' => [ 'shape' => 'PutSigningProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'RemoveProfilePermission' => [ 'name' => 'RemoveProfilePermission', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/signing-profiles/{profileName}/permissions/{statementId}', ], 'input' => [ 'shape' => 'RemoveProfilePermissionRequest', ], 'output' => [ 'shape' => 'RemoveProfilePermissionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'RevokeSignature' => [ 'name' => 'RevokeSignature', 'http' => [ 'method' => 'PUT', 'requestUri' => '/signing-jobs/{jobId}/revoke', ], 'input' => [ 'shape' => 'RevokeSignatureRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'RevokeSigningProfile' => [ 'name' => 'RevokeSigningProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/signing-profiles/{profileName}/revoke', ], 'input' => [ 'shape' => 'RevokeSigningProfileRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'SignPayload' => [ 'name' => 'SignPayload', 'http' => [ 'method' => 'POST', 'requestUri' => '/signing-jobs/with-payload', ], 'input' => [ 'shape' => 'SignPayloadRequest', ], 'output' => [ 'shape' => 'SignPayloadResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'StartSigningJob' => [ 'name' => 'StartSigningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/signing-jobs', ], 'input' => [ 'shape' => 'StartSigningJobRequest', ], 'output' => [ 'shape' => 'StartSigningJobResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^[0-9]{12}$', ], 'AddProfilePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'action', 'principal', 'statementId', 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'action' => [ 'shape' => 'String', ], 'principal' => [ 'shape' => 'String', ], 'revisionId' => [ 'shape' => 'String', ], 'statementId' => [ 'shape' => 'String', ], ], ], 'AddProfilePermissionResponse' => [ 'type' => 'structure', 'members' => [ 'revisionId' => [ 'shape' => 'String', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Blob' => [ 'type' => 'blob', ], 'BucketName' => [ 'type' => 'string', ], 'CancelSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], ], ], 'Category' => [ 'type' => 'string', 'enum' => [ 'AWSIoT', ], ], 'CertificateArn' => [ 'type' => 'string', ], 'CertificateHashes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ClientRequestToken' => [ 'type' => 'string', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DescribeSigningJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'JobId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'DescribeSigningJobResponse' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'source' => [ 'shape' => 'Source', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'overrides' => [ 'shape' => 'SigningPlatformOverrides', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'completedAt' => [ 'shape' => 'Timestamp', ], 'signatureExpiresAt' => [ 'shape' => 'Timestamp', ], 'requestedBy' => [ 'shape' => 'RequestedBy', ], 'status' => [ 'shape' => 'SigningStatus', ], 'statusReason' => [ 'shape' => 'StatusReason', ], 'revocationRecord' => [ 'shape' => 'SigningJobRevocationRecord', ], 'signedObject' => [ 'shape' => 'SignedObject', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'jobInvoker' => [ 'shape' => 'AccountId', ], ], ], 'Destination' => [ 'type' => 'structure', 'members' => [ 's3' => [ 'shape' => 'S3Destination', ], ], ], 'DisplayName' => [ 'type' => 'string', ], 'EncryptionAlgorithm' => [ 'type' => 'string', 'enum' => [ 'RSA', 'ECDSA', ], ], 'EncryptionAlgorithmOptions' => [ 'type' => 'structure', 'required' => [ 'allowedValues', 'defaultValue', ], 'members' => [ 'allowedValues' => [ 'shape' => 'EncryptionAlgorithms', ], 'defaultValue' => [ 'shape' => 'EncryptionAlgorithm', ], ], ], 'EncryptionAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'EncryptionAlgorithm', ], ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorMessage' => [ 'type' => 'string', ], 'GetRevocationStatusRequest' => [ 'type' => 'structure', 'required' => [ 'signatureTimestamp', 'platformId', 'profileVersionArn', 'jobArn', 'certificateHashes', ], 'members' => [ 'signatureTimestamp' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'signatureTimestamp', ], 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'querystring', 'locationName' => 'platformId', ], 'profileVersionArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'profileVersionArn', ], 'jobArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'jobArn', ], 'certificateHashes' => [ 'shape' => 'CertificateHashes', 'location' => 'querystring', 'locationName' => 'certificateHashes', ], ], ], 'GetRevocationStatusResponse' => [ 'type' => 'structure', 'members' => [ 'revokedEntities' => [ 'shape' => 'RevokedEntities', ], ], ], 'GetSigningPlatformRequest' => [ 'type' => 'structure', 'required' => [ 'platformId', ], 'members' => [ 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'uri', 'locationName' => 'platformId', ], ], ], 'GetSigningPlatformResponse' => [ 'type' => 'structure', 'members' => [ 'platformId' => [ 'shape' => 'PlatformId', ], 'displayName' => [ 'shape' => 'DisplayName', ], 'partner' => [ 'shape' => 'String', ], 'target' => [ 'shape' => 'String', ], 'category' => [ 'shape' => 'Category', ], 'signingConfiguration' => [ 'shape' => 'SigningConfiguration', ], 'signingImageFormat' => [ 'shape' => 'SigningImageFormat', ], 'maxSizeInMB' => [ 'shape' => 'MaxSizeInMB', ], 'revocationSupported' => [ 'shape' => 'bool', ], ], ], 'GetSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'profileOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'profileOwner', ], ], ], 'GetSigningProfileResponse' => [ 'type' => 'structure', 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'profileVersionArn' => [ 'shape' => 'Arn', ], 'revocationRecord' => [ 'shape' => 'SigningProfileRevocationRecord', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'signatureValidityPeriod' => [ 'shape' => 'SignatureValidityPeriod', ], 'overrides' => [ 'shape' => 'SigningPlatformOverrides', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'status' => [ 'shape' => 'SigningProfileStatus', ], 'statusReason' => [ 'shape' => 'String', ], 'arn' => [ 'shape' => 'string', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'HashAlgorithm' => [ 'type' => 'string', 'enum' => [ 'SHA1', 'SHA256', ], ], 'HashAlgorithmOptions' => [ 'type' => 'structure', 'required' => [ 'allowedValues', 'defaultValue', ], 'members' => [ 'allowedValues' => [ 'shape' => 'HashAlgorithms', ], 'defaultValue' => [ 'shape' => 'HashAlgorithm', ], ], ], 'HashAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'HashAlgorithm', ], ], 'ImageFormat' => [ 'type' => 'string', 'enum' => [ 'JSON', 'JSONEmbedded', 'JSONDetached', ], ], 'ImageFormats' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageFormat', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServiceErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'JobId' => [ 'type' => 'string', ], 'Key' => [ 'type' => 'string', ], 'ListProfilePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListProfilePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'revisionId' => [ 'shape' => 'String', ], 'policySizeBytes' => [ 'shape' => 'PolicySizeBytes', ], 'permissions' => [ 'shape' => 'Permissions', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListSigningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'SigningStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'querystring', 'locationName' => 'platformId', ], 'requestedBy' => [ 'shape' => 'RequestedBy', 'location' => 'querystring', 'locationName' => 'requestedBy', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'isRevoked' => [ 'shape' => 'bool', 'location' => 'querystring', 'locationName' => 'isRevoked', ], 'signatureExpiresBefore' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'signatureExpiresBefore', ], 'signatureExpiresAfter' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'signatureExpiresAfter', ], 'jobInvoker' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'jobInvoker', ], ], ], 'ListSigningJobsResponse' => [ 'type' => 'structure', 'members' => [ 'jobs' => [ 'shape' => 'SigningJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSigningPlatformsRequest' => [ 'type' => 'structure', 'members' => [ 'category' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'category', ], 'partner' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'partner', ], 'target' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'target', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListSigningPlatformsResponse' => [ 'type' => 'structure', 'members' => [ 'platforms' => [ 'shape' => 'SigningPlatforms', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListSigningProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'includeCanceled' => [ 'shape' => 'bool', 'location' => 'querystring', 'locationName' => 'includeCanceled', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'querystring', 'locationName' => 'platformId', ], 'statuses' => [ 'shape' => 'Statuses', 'location' => 'querystring', 'locationName' => 'statuses', ], ], ], 'ListSigningProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'profiles' => [ 'shape' => 'SigningProfiles', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 25, 'min' => 1, ], 'MaxSizeInMB' => [ 'type' => 'integer', ], 'Metadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'NextToken' => [ 'type' => 'string', ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'Payload' => [ 'type' => 'blob', 'max' => 4096, 'min' => 1, ], 'Permission' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'String', ], 'principal' => [ 'shape' => 'String', ], 'statementId' => [ 'shape' => 'String', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], ], ], 'Permissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], ], 'PlatformId' => [ 'type' => 'string', ], 'PolicySizeBytes' => [ 'type' => 'integer', ], 'Prefix' => [ 'type' => 'string', ], 'ProfileName' => [ 'type' => 'string', 'max' => 64, 'min' => 2, 'pattern' => '^[a-zA-Z0-9_]{2,}', ], 'ProfileVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]{10}$', ], 'PutSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', 'platformId', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'signatureValidityPeriod' => [ 'shape' => 'SignatureValidityPeriod', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'overrides' => [ 'shape' => 'SigningPlatformOverrides', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'PutSigningProfileResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'string', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'profileVersionArn' => [ 'shape' => 'Arn', ], ], ], 'RemoveProfilePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'revisionId', 'profileName', 'statementId', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'revisionId' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'revisionId', ], 'statementId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'statementId', ], ], ], 'RemoveProfilePermissionResponse' => [ 'type' => 'structure', 'members' => [ 'revisionId' => [ 'shape' => 'String', ], ], ], 'RequestedBy' => [ 'type' => 'string', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RevocationReasonString' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'RevokeSignatureRequest' => [ 'type' => 'structure', 'required' => [ 'reason', 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'JobId', 'location' => 'uri', 'locationName' => 'jobId', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'reason' => [ 'shape' => 'RevocationReasonString', ], ], ], 'RevokeSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileVersion', 'reason', 'effectiveTime', 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'reason' => [ 'shape' => 'RevocationReasonString', ], 'effectiveTime' => [ 'shape' => 'Timestamp', ], ], ], 'RevokedEntities' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'S3Destination' => [ 'type' => 'structure', 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'prefix' => [ 'shape' => 'Prefix', ], ], ], 'S3SignedObject' => [ 'type' => 'structure', 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'key' => [ 'shape' => 'Key', ], ], ], 'S3Source' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'key', 'version', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'key' => [ 'shape' => 'Key', ], 'version' => [ 'shape' => 'Version', ], ], ], 'ServiceLimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'SignPayloadRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', 'payload', 'payloadFormat', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', ], 'profileOwner' => [ 'shape' => 'AccountId', ], 'payload' => [ 'shape' => 'Payload', ], 'payloadFormat' => [ 'shape' => 'String', ], ], ], 'SignPayloadResponse' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'metadata' => [ 'shape' => 'Metadata', ], 'signature' => [ 'shape' => 'Blob', ], ], ], 'SignatureValidityPeriod' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'Integer', ], 'type' => [ 'shape' => 'ValidityType', ], ], ], 'SignedObject' => [ 'type' => 'structure', 'members' => [ 's3' => [ 'shape' => 'S3SignedObject', ], ], ], 'SigningConfiguration' => [ 'type' => 'structure', 'required' => [ 'encryptionAlgorithmOptions', 'hashAlgorithmOptions', ], 'members' => [ 'encryptionAlgorithmOptions' => [ 'shape' => 'EncryptionAlgorithmOptions', ], 'hashAlgorithmOptions' => [ 'shape' => 'HashAlgorithmOptions', ], ], ], 'SigningConfigurationOverrides' => [ 'type' => 'structure', 'members' => [ 'encryptionAlgorithm' => [ 'shape' => 'EncryptionAlgorithm', ], 'hashAlgorithm' => [ 'shape' => 'HashAlgorithm', ], ], ], 'SigningImageFormat' => [ 'type' => 'structure', 'required' => [ 'supportedFormats', 'defaultFormat', ], 'members' => [ 'supportedFormats' => [ 'shape' => 'ImageFormats', ], 'defaultFormat' => [ 'shape' => 'ImageFormat', ], ], ], 'SigningJob' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'source' => [ 'shape' => 'Source', ], 'signedObject' => [ 'shape' => 'SignedObject', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'SigningStatus', ], 'isRevoked' => [ 'shape' => 'bool', ], 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'signatureExpiresAt' => [ 'shape' => 'Timestamp', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'jobInvoker' => [ 'shape' => 'AccountId', ], ], ], 'SigningJobRevocationRecord' => [ 'type' => 'structure', 'members' => [ 'reason' => [ 'shape' => 'String', ], 'revokedAt' => [ 'shape' => 'Timestamp', ], 'revokedBy' => [ 'shape' => 'String', ], ], ], 'SigningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningJob', ], ], 'SigningMaterial' => [ 'type' => 'structure', 'required' => [ 'certificateArn', ], 'members' => [ 'certificateArn' => [ 'shape' => 'CertificateArn', ], ], ], 'SigningParameterKey' => [ 'type' => 'string', ], 'SigningParameterValue' => [ 'type' => 'string', ], 'SigningParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'SigningParameterKey', ], 'value' => [ 'shape' => 'SigningParameterValue', ], ], 'SigningPlatform' => [ 'type' => 'structure', 'members' => [ 'platformId' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'partner' => [ 'shape' => 'String', ], 'target' => [ 'shape' => 'String', ], 'category' => [ 'shape' => 'Category', ], 'signingConfiguration' => [ 'shape' => 'SigningConfiguration', ], 'signingImageFormat' => [ 'shape' => 'SigningImageFormat', ], 'maxSizeInMB' => [ 'shape' => 'MaxSizeInMB', ], 'revocationSupported' => [ 'shape' => 'bool', ], ], ], 'SigningPlatformOverrides' => [ 'type' => 'structure', 'members' => [ 'signingConfiguration' => [ 'shape' => 'SigningConfigurationOverrides', ], 'signingImageFormat' => [ 'shape' => 'ImageFormat', ], ], ], 'SigningPlatforms' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningPlatform', ], ], 'SigningProfile' => [ 'type' => 'structure', 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'profileVersionArn' => [ 'shape' => 'Arn', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'signatureValidityPeriod' => [ 'shape' => 'SignatureValidityPeriod', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'status' => [ 'shape' => 'SigningProfileStatus', ], 'arn' => [ 'shape' => 'string', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'SigningProfileRevocationRecord' => [ 'type' => 'structure', 'members' => [ 'revocationEffectiveFrom' => [ 'shape' => 'Timestamp', ], 'revokedAt' => [ 'shape' => 'Timestamp', ], 'revokedBy' => [ 'shape' => 'String', ], ], ], 'SigningProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Canceled', 'Revoked', ], ], 'SigningProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningProfile', ], ], 'SigningStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Failed', 'Succeeded', ], ], 'Source' => [ 'type' => 'structure', 'members' => [ 's3' => [ 'shape' => 'S3Source', ], ], ], 'StartSigningJobRequest' => [ 'type' => 'structure', 'required' => [ 'source', 'destination', 'profileName', 'clientRequestToken', ], 'members' => [ 'source' => [ 'shape' => 'Source', ], 'destination' => [ 'shape' => 'Destination', ], 'profileName' => [ 'shape' => 'ProfileName', ], 'clientRequestToken' => [ 'shape' => 'ClientRequestToken', 'idempotencyToken' => true, ], 'profileOwner' => [ 'shape' => 'AccountId', ], ], ], 'StartSigningJobResponse' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'jobOwner' => [ 'shape' => 'AccountId', ], ], ], 'StatusReason' => [ 'type' => 'string', ], 'Statuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningProfileStatus', ], ], 'String' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[a-zA-Z+-=._:/]+$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 200, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'deprecated' => true, 'deprecatedMessage' => 'Instead of this error, TooManyRequestsException should be used.', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidityType' => [ 'type' => 'string', 'enum' => [ 'DAYS', 'MONTHS', 'YEARS', ], ], 'Version' => [ 'type' => 'string', ], 'bool' => [ 'type' => 'boolean', ], 'string' => [ 'type' => 'string', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-08-25', 'endpointPrefix' => 'signer', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceAbbreviation' => 'signer', 'serviceFullName' => 'AWS Signer', 'serviceId' => 'signer', 'signatureVersion' => 'v4', 'signingName' => 'signer', 'uid' => 'signer-2017-08-25', ], 'operations' => [ 'AddProfilePermission' => [ 'name' => 'AddProfilePermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/signing-profiles/{profileName}/permissions', ], 'input' => [ 'shape' => 'AddProfilePermissionRequest', ], 'output' => [ 'shape' => 'AddProfilePermissionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceLimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'CancelSigningProfile' => [ 'name' => 'CancelSigningProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/signing-profiles/{profileName}', ], 'input' => [ 'shape' => 'CancelSigningProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'DescribeSigningJob' => [ 'name' => 'DescribeSigningJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-jobs/{jobId}', ], 'input' => [ 'shape' => 'DescribeSigningJobRequest', ], 'output' => [ 'shape' => 'DescribeSigningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'GetRevocationStatus' => [ 'name' => 'GetRevocationStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/revocations', ], 'input' => [ 'shape' => 'GetRevocationStatusRequest', ], 'output' => [ 'shape' => 'GetRevocationStatusResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], 'endpoint' => [ 'hostPrefix' => 'verification.', ], ], 'GetSigningPlatform' => [ 'name' => 'GetSigningPlatform', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-platforms/{platformId}', ], 'input' => [ 'shape' => 'GetSigningPlatformRequest', ], 'output' => [ 'shape' => 'GetSigningPlatformResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'GetSigningProfile' => [ 'name' => 'GetSigningProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-profiles/{profileName}', ], 'input' => [ 'shape' => 'GetSigningProfileRequest', ], 'output' => [ 'shape' => 'GetSigningProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListProfilePermissions' => [ 'name' => 'ListProfilePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-profiles/{profileName}/permissions', ], 'input' => [ 'shape' => 'ListProfilePermissionsRequest', ], 'output' => [ 'shape' => 'ListProfilePermissionsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListSigningJobs' => [ 'name' => 'ListSigningJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-jobs', ], 'input' => [ 'shape' => 'ListSigningJobsRequest', ], 'output' => [ 'shape' => 'ListSigningJobsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListSigningPlatforms' => [ 'name' => 'ListSigningPlatforms', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-platforms', ], 'input' => [ 'shape' => 'ListSigningPlatformsRequest', ], 'output' => [ 'shape' => 'ListSigningPlatformsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListSigningProfiles' => [ 'name' => 'ListSigningProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/signing-profiles', ], 'input' => [ 'shape' => 'ListSigningProfilesRequest', ], 'output' => [ 'shape' => 'ListSigningProfilesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'PutSigningProfile' => [ 'name' => 'PutSigningProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/signing-profiles/{profileName}', ], 'input' => [ 'shape' => 'PutSigningProfileRequest', ], 'output' => [ 'shape' => 'PutSigningProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'RemoveProfilePermission' => [ 'name' => 'RemoveProfilePermission', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/signing-profiles/{profileName}/permissions/{statementId}', ], 'input' => [ 'shape' => 'RemoveProfilePermissionRequest', ], 'output' => [ 'shape' => 'RemoveProfilePermissionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'RevokeSignature' => [ 'name' => 'RevokeSignature', 'http' => [ 'method' => 'PUT', 'requestUri' => '/signing-jobs/{jobId}/revoke', ], 'input' => [ 'shape' => 'RevokeSignatureRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'RevokeSigningProfile' => [ 'name' => 'RevokeSigningProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/signing-profiles/{profileName}/revoke', ], 'input' => [ 'shape' => 'RevokeSigningProfileRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'SignPayload' => [ 'name' => 'SignPayload', 'http' => [ 'method' => 'POST', 'requestUri' => '/signing-jobs/with-payload', ], 'input' => [ 'shape' => 'SignPayloadRequest', ], 'output' => [ 'shape' => 'SignPayloadResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'StartSigningJob' => [ 'name' => 'StartSigningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/signing-jobs', ], 'input' => [ 'shape' => 'StartSigningJobRequest', ], 'output' => [ 'shape' => 'StartSigningJobResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'InternalServiceErrorException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceErrorException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^[0-9]{12}$', ], 'AddProfilePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'action', 'principal', 'statementId', 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'action' => [ 'shape' => 'String', ], 'principal' => [ 'shape' => 'String', ], 'revisionId' => [ 'shape' => 'String', ], 'statementId' => [ 'shape' => 'String', ], ], ], 'AddProfilePermissionResponse' => [ 'type' => 'structure', 'members' => [ 'revisionId' => [ 'shape' => 'String', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Blob' => [ 'type' => 'blob', ], 'BucketName' => [ 'type' => 'string', ], 'CancelSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], ], ], 'Category' => [ 'type' => 'string', 'enum' => [ 'AWSIoT', ], ], 'CertificateArn' => [ 'type' => 'string', ], 'CertificateHashes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ClientRequestToken' => [ 'type' => 'string', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DescribeSigningJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'JobId', 'location' => 'uri', 'locationName' => 'jobId', ], ], ], 'DescribeSigningJobResponse' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'source' => [ 'shape' => 'Source', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'overrides' => [ 'shape' => 'SigningPlatformOverrides', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'completedAt' => [ 'shape' => 'Timestamp', ], 'signatureExpiresAt' => [ 'shape' => 'Timestamp', ], 'requestedBy' => [ 'shape' => 'RequestedBy', ], 'status' => [ 'shape' => 'SigningStatus', ], 'statusReason' => [ 'shape' => 'StatusReason', ], 'revocationRecord' => [ 'shape' => 'SigningJobRevocationRecord', ], 'signedObject' => [ 'shape' => 'SignedObject', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'jobInvoker' => [ 'shape' => 'AccountId', ], ], ], 'Destination' => [ 'type' => 'structure', 'members' => [ 's3' => [ 'shape' => 'S3Destination', ], ], ], 'DisplayName' => [ 'type' => 'string', ], 'EncryptionAlgorithm' => [ 'type' => 'string', 'enum' => [ 'RSA', 'ECDSA', ], ], 'EncryptionAlgorithmOptions' => [ 'type' => 'structure', 'required' => [ 'allowedValues', 'defaultValue', ], 'members' => [ 'allowedValues' => [ 'shape' => 'EncryptionAlgorithms', ], 'defaultValue' => [ 'shape' => 'EncryptionAlgorithm', ], ], ], 'EncryptionAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'EncryptionAlgorithm', ], ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorMessage' => [ 'type' => 'string', ], 'GetRevocationStatusRequest' => [ 'type' => 'structure', 'required' => [ 'signatureTimestamp', 'platformId', 'profileVersionArn', 'jobArn', 'certificateHashes', ], 'members' => [ 'signatureTimestamp' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'signatureTimestamp', ], 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'querystring', 'locationName' => 'platformId', ], 'profileVersionArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'profileVersionArn', ], 'jobArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'jobArn', ], 'certificateHashes' => [ 'shape' => 'CertificateHashes', 'location' => 'querystring', 'locationName' => 'certificateHashes', ], ], ], 'GetRevocationStatusResponse' => [ 'type' => 'structure', 'members' => [ 'revokedEntities' => [ 'shape' => 'RevokedEntities', ], ], ], 'GetSigningPlatformRequest' => [ 'type' => 'structure', 'required' => [ 'platformId', ], 'members' => [ 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'uri', 'locationName' => 'platformId', ], ], ], 'GetSigningPlatformResponse' => [ 'type' => 'structure', 'members' => [ 'platformId' => [ 'shape' => 'PlatformId', ], 'displayName' => [ 'shape' => 'DisplayName', ], 'partner' => [ 'shape' => 'String', ], 'target' => [ 'shape' => 'String', ], 'category' => [ 'shape' => 'Category', ], 'signingConfiguration' => [ 'shape' => 'SigningConfiguration', ], 'signingImageFormat' => [ 'shape' => 'SigningImageFormat', ], 'maxSizeInMB' => [ 'shape' => 'MaxSizeInMB', ], 'revocationSupported' => [ 'shape' => 'bool', ], ], ], 'GetSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'profileOwner' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'profileOwner', ], ], ], 'GetSigningProfileResponse' => [ 'type' => 'structure', 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'profileVersionArn' => [ 'shape' => 'Arn', ], 'revocationRecord' => [ 'shape' => 'SigningProfileRevocationRecord', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'signatureValidityPeriod' => [ 'shape' => 'SignatureValidityPeriod', ], 'overrides' => [ 'shape' => 'SigningPlatformOverrides', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'status' => [ 'shape' => 'SigningProfileStatus', ], 'statusReason' => [ 'shape' => 'String', ], 'arn' => [ 'shape' => 'string', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'HashAlgorithm' => [ 'type' => 'string', 'enum' => [ 'SHA1', 'SHA256', ], ], 'HashAlgorithmOptions' => [ 'type' => 'structure', 'required' => [ 'allowedValues', 'defaultValue', ], 'members' => [ 'allowedValues' => [ 'shape' => 'HashAlgorithms', ], 'defaultValue' => [ 'shape' => 'HashAlgorithm', ], ], ], 'HashAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'HashAlgorithm', ], ], 'ImageFormat' => [ 'type' => 'string', 'enum' => [ 'JSON', 'JSONEmbedded', 'JSONDetached', ], ], 'ImageFormats' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageFormat', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServiceErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'JobId' => [ 'type' => 'string', ], 'Key' => [ 'type' => 'string', ], 'ListProfilePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListProfilePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'revisionId' => [ 'shape' => 'String', ], 'policySizeBytes' => [ 'shape' => 'PolicySizeBytes', ], 'permissions' => [ 'shape' => 'Permissions', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListSigningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'SigningStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'querystring', 'locationName' => 'platformId', ], 'requestedBy' => [ 'shape' => 'RequestedBy', 'location' => 'querystring', 'locationName' => 'requestedBy', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'isRevoked' => [ 'shape' => 'bool', 'location' => 'querystring', 'locationName' => 'isRevoked', ], 'signatureExpiresBefore' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'signatureExpiresBefore', ], 'signatureExpiresAfter' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'signatureExpiresAfter', ], 'jobInvoker' => [ 'shape' => 'AccountId', 'location' => 'querystring', 'locationName' => 'jobInvoker', ], ], ], 'ListSigningJobsResponse' => [ 'type' => 'structure', 'members' => [ 'jobs' => [ 'shape' => 'SigningJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSigningPlatformsRequest' => [ 'type' => 'structure', 'members' => [ 'category' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'category', ], 'partner' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'partner', ], 'target' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'target', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListSigningPlatformsResponse' => [ 'type' => 'structure', 'members' => [ 'platforms' => [ 'shape' => 'SigningPlatforms', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListSigningProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'includeCanceled' => [ 'shape' => 'bool', 'location' => 'querystring', 'locationName' => 'includeCanceled', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'platformId' => [ 'shape' => 'PlatformId', 'location' => 'querystring', 'locationName' => 'platformId', ], 'statuses' => [ 'shape' => 'Statuses', 'location' => 'querystring', 'locationName' => 'statuses', ], ], ], 'ListSigningProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'profiles' => [ 'shape' => 'SigningProfiles', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 25, 'min' => 1, ], 'MaxSizeInMB' => [ 'type' => 'integer', ], 'Metadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'NextToken' => [ 'type' => 'string', ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'Payload' => [ 'type' => 'blob', 'max' => 4096, 'min' => 1, ], 'Permission' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'String', ], 'principal' => [ 'shape' => 'String', ], 'statementId' => [ 'shape' => 'String', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], ], ], 'Permissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], ], 'PlatformId' => [ 'type' => 'string', ], 'PolicySizeBytes' => [ 'type' => 'integer', ], 'Prefix' => [ 'type' => 'string', ], 'ProfileName' => [ 'type' => 'string', 'max' => 64, 'min' => 2, 'pattern' => '^[a-zA-Z0-9_]{2,}', ], 'ProfileVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]{10}$', ], 'PutSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', 'platformId', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'signatureValidityPeriod' => [ 'shape' => 'SignatureValidityPeriod', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'overrides' => [ 'shape' => 'SigningPlatformOverrides', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'PutSigningProfileResponse' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'string', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'profileVersionArn' => [ 'shape' => 'Arn', ], ], ], 'RemoveProfilePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'revisionId', 'profileName', 'statementId', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'revisionId' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'revisionId', ], 'statementId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'statementId', ], ], ], 'RemoveProfilePermissionResponse' => [ 'type' => 'structure', 'members' => [ 'revisionId' => [ 'shape' => 'String', ], ], ], 'RequestedBy' => [ 'type' => 'string', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RevocationReasonString' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'RevokeSignatureRequest' => [ 'type' => 'structure', 'required' => [ 'reason', 'jobId', ], 'members' => [ 'jobId' => [ 'shape' => 'JobId', 'location' => 'uri', 'locationName' => 'jobId', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'reason' => [ 'shape' => 'RevocationReasonString', ], ], ], 'RevokeSigningProfileRequest' => [ 'type' => 'structure', 'required' => [ 'profileVersion', 'reason', 'effectiveTime', 'profileName', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', 'location' => 'uri', 'locationName' => 'profileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'reason' => [ 'shape' => 'RevocationReasonString', ], 'effectiveTime' => [ 'shape' => 'Timestamp', ], ], ], 'RevokedEntities' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'S3Destination' => [ 'type' => 'structure', 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'prefix' => [ 'shape' => 'Prefix', ], ], ], 'S3SignedObject' => [ 'type' => 'structure', 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'key' => [ 'shape' => 'Key', ], ], ], 'S3Source' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'key', 'version', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'key' => [ 'shape' => 'Key', ], 'version' => [ 'shape' => 'Version', ], ], ], 'ServiceLimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'SignPayloadRequest' => [ 'type' => 'structure', 'required' => [ 'profileName', 'payload', 'payloadFormat', ], 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', ], 'profileOwner' => [ 'shape' => 'AccountId', ], 'payload' => [ 'shape' => 'Payload', ], 'payloadFormat' => [ 'shape' => 'String', ], ], ], 'SignPayloadResponse' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'metadata' => [ 'shape' => 'Metadata', ], 'signature' => [ 'shape' => 'Blob', ], ], ], 'SignatureValidityPeriod' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'Integer', ], 'type' => [ 'shape' => 'ValidityType', ], ], ], 'SignedObject' => [ 'type' => 'structure', 'members' => [ 's3' => [ 'shape' => 'S3SignedObject', ], ], ], 'SigningConfiguration' => [ 'type' => 'structure', 'required' => [ 'encryptionAlgorithmOptions', 'hashAlgorithmOptions', ], 'members' => [ 'encryptionAlgorithmOptions' => [ 'shape' => 'EncryptionAlgorithmOptions', ], 'hashAlgorithmOptions' => [ 'shape' => 'HashAlgorithmOptions', ], ], ], 'SigningConfigurationOverrides' => [ 'type' => 'structure', 'members' => [ 'encryptionAlgorithm' => [ 'shape' => 'EncryptionAlgorithm', ], 'hashAlgorithm' => [ 'shape' => 'HashAlgorithm', ], ], ], 'SigningImageFormat' => [ 'type' => 'structure', 'required' => [ 'supportedFormats', 'defaultFormat', ], 'members' => [ 'supportedFormats' => [ 'shape' => 'ImageFormats', ], 'defaultFormat' => [ 'shape' => 'ImageFormat', ], ], ], 'SigningJob' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'source' => [ 'shape' => 'Source', ], 'signedObject' => [ 'shape' => 'SignedObject', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'SigningStatus', ], 'isRevoked' => [ 'shape' => 'bool', ], 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'signatureExpiresAt' => [ 'shape' => 'Timestamp', ], 'jobOwner' => [ 'shape' => 'AccountId', ], 'jobInvoker' => [ 'shape' => 'AccountId', ], ], ], 'SigningJobRevocationRecord' => [ 'type' => 'structure', 'members' => [ 'reason' => [ 'shape' => 'String', ], 'revokedAt' => [ 'shape' => 'Timestamp', ], 'revokedBy' => [ 'shape' => 'String', ], ], ], 'SigningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningJob', ], ], 'SigningMaterial' => [ 'type' => 'structure', 'required' => [ 'certificateArn', ], 'members' => [ 'certificateArn' => [ 'shape' => 'CertificateArn', ], ], ], 'SigningParameterKey' => [ 'type' => 'string', ], 'SigningParameterValue' => [ 'type' => 'string', ], 'SigningParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'SigningParameterKey', ], 'value' => [ 'shape' => 'SigningParameterValue', ], ], 'SigningPlatform' => [ 'type' => 'structure', 'members' => [ 'platformId' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'partner' => [ 'shape' => 'String', ], 'target' => [ 'shape' => 'String', ], 'category' => [ 'shape' => 'Category', ], 'signingConfiguration' => [ 'shape' => 'SigningConfiguration', ], 'signingImageFormat' => [ 'shape' => 'SigningImageFormat', ], 'maxSizeInMB' => [ 'shape' => 'MaxSizeInMB', ], 'revocationSupported' => [ 'shape' => 'bool', ], ], ], 'SigningPlatformOverrides' => [ 'type' => 'structure', 'members' => [ 'signingConfiguration' => [ 'shape' => 'SigningConfigurationOverrides', ], 'signingImageFormat' => [ 'shape' => 'ImageFormat', ], ], ], 'SigningPlatforms' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningPlatform', ], ], 'SigningProfile' => [ 'type' => 'structure', 'members' => [ 'profileName' => [ 'shape' => 'ProfileName', ], 'profileVersion' => [ 'shape' => 'ProfileVersion', ], 'profileVersionArn' => [ 'shape' => 'Arn', ], 'signingMaterial' => [ 'shape' => 'SigningMaterial', ], 'signatureValidityPeriod' => [ 'shape' => 'SignatureValidityPeriod', ], 'platformId' => [ 'shape' => 'PlatformId', ], 'platformDisplayName' => [ 'shape' => 'DisplayName', ], 'signingParameters' => [ 'shape' => 'SigningParameters', ], 'status' => [ 'shape' => 'SigningProfileStatus', ], 'arn' => [ 'shape' => 'string', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'SigningProfileRevocationRecord' => [ 'type' => 'structure', 'members' => [ 'revocationEffectiveFrom' => [ 'shape' => 'Timestamp', ], 'revokedAt' => [ 'shape' => 'Timestamp', ], 'revokedBy' => [ 'shape' => 'String', ], ], ], 'SigningProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Canceled', 'Revoked', ], ], 'SigningProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningProfile', ], ], 'SigningStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Failed', 'Succeeded', ], ], 'Source' => [ 'type' => 'structure', 'members' => [ 's3' => [ 'shape' => 'S3Source', ], ], ], 'StartSigningJobRequest' => [ 'type' => 'structure', 'required' => [ 'source', 'destination', 'profileName', 'clientRequestToken', ], 'members' => [ 'source' => [ 'shape' => 'Source', ], 'destination' => [ 'shape' => 'Destination', ], 'profileName' => [ 'shape' => 'ProfileName', ], 'clientRequestToken' => [ 'shape' => 'ClientRequestToken', 'idempotencyToken' => true, ], 'profileOwner' => [ 'shape' => 'AccountId', ], ], ], 'StartSigningJobResponse' => [ 'type' => 'structure', 'members' => [ 'jobId' => [ 'shape' => 'JobId', ], 'jobOwner' => [ 'shape' => 'AccountId', ], ], ], 'StatusReason' => [ 'type' => 'string', ], 'Statuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'SigningProfileStatus', ], ], 'String' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[a-zA-Z+-=._:/]+$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 200, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'deprecated' => true, 'deprecatedMessage' => 'Instead of this error, TooManyRequestsException should be used.', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'code' => [ 'shape' => 'ErrorCode', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidityType' => [ 'type' => 'string', 'enum' => [ 'DAYS', 'MONTHS', 'YEARS', ], ], 'Version' => [ 'type' => 'string', ], 'bool' => [ 'type' => 'boolean', ], 'string' => [ 'type' => 'string', ], ],]; diff --git a/src/data/signer/2017-08-25/docs-2.json b/src/data/signer/2017-08-25/docs-2.json index 2af8413fe9..951d54eb21 100644 --- a/src/data/signer/2017-08-25/docs-2.json +++ b/src/data/signer/2017-08-25/docs-2.json @@ -18,7 +18,7 @@ "RevokeSignature": "

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

", "RevokeSigningProfile": "

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

", "SignPayload": "

Signs a binary payload and returns a signature envelope.

", - "StartSigningJob": "

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

  • You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

  • Your S3 source bucket must be version enabled.

  • You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

  • You specify the name of the source and destination buckets when calling the StartSigningJob operation.

  • You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

", + "StartSigningJob": "

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

  • You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

  • Your S3 source bucket must be version enabled.

  • You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

  • You specify the name of the source and destination buckets when calling the StartSigningJob operation.

  • You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn't supported.

  • You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

", "TagResource": "

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

", "UntagResource": "

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

" }, @@ -707,7 +707,7 @@ "String": { "base": null, "refs": { - "AddProfilePermissionRequest$action": "

The AWS Signer action permitted as part of cross-account permissions.

", + "AddProfilePermissionRequest$action": "

For cross-account signing. Grant a designated account permission to perform one or more of the following actions. Each action is associated with a specific API's operations. For more information about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.

You can designate the following actions to an account.

  • signer:StartSigningJob. This action isn't supported for container image workflows. For details, see StartSigningJob.

  • signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details, see SignPayload

  • signer:GetSigningProfile. For details, see GetSigningProfile.

  • signer:RevokeSignature. For details, see RevokeSignature.

", "AddProfilePermissionRequest$principal": "

The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.

", "AddProfilePermissionRequest$revisionId": "

A unique identifier for the current profile revision.

", "AddProfilePermissionRequest$statementId": "

A unique identifier for the cross-account permission statement.

", diff --git a/src/data/signer/2017-08-25/docs-2.json.php b/src/data/signer/2017-08-25/docs-2.json.php index 5ff22e8407..d9d52564f4 100644 --- a/src/data/signer/2017-08-25/docs-2.json.php +++ b/src/data/signer/2017-08-25/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

AWS Signer is a fully managed code-signing service to help you ensure the trust and integrity of your code.

Signer supports the following applications:

With code signing for AWS Lambda, you can sign AWS Lambda deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, and AWS CloudTrail. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3.

With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code-signing certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

With Signer and the Notation CLI from the Notary
 Project, you can sign container images stored in a container registry such as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry alongside the images, where they are available for verifying image authenticity and integrity.

For more information about Signer, see the AWS Signer Developer Guide.

', 'operations' => [ 'AddProfilePermission' => '

Adds cross-account permissions to a signing profile.

', 'CancelSigningProfile' => '

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

', 'DescribeSigningJob' => '

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

', 'GetRevocationStatus' => '

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

', 'GetSigningPlatform' => '

Returns information on a specific signing platform.

', 'GetSigningProfile' => '

Returns information on a specific signing profile.

', 'ListProfilePermissions' => '

Lists the cross-account permissions associated with a signing profile.

', 'ListSigningJobs' => '

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

', 'ListSigningPlatforms' => '

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

', 'ListSigningProfiles' => '

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

', 'ListTagsForResource' => '

Returns a list of the tags associated with a signing profile resource.

', 'PutSigningProfile' => '

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

', 'RemoveProfilePermission' => '

Removes cross-account permissions from a signing profile.

', 'RevokeSignature' => '

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

', 'RevokeSigningProfile' => '

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

', 'SignPayload' => '

Signs a binary payload and returns a signature envelope.

', 'StartSigningJob' => '

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

  • You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

  • Your S3 source bucket must be version enabled.

  • You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

  • You specify the name of the source and destination buckets when calling the StartSigningJob operation.

  • You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

', 'TagResource' => '

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

', 'UntagResource' => '

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

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

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$jobOwner' => '

The AWS account ID of the job owner.

', 'DescribeSigningJobResponse$jobInvoker' => '

The IAM entity that initiated the signing job.

', 'GetSigningProfileRequest$profileOwner' => '

The AWS account ID of the profile owner.

', 'ListSigningJobsRequest$jobInvoker' => '

Filters results to return only signing jobs initiated by a specified IAM entity.

', 'RevokeSignatureRequest$jobOwner' => '

AWS account ID of the job owner.

', 'SignPayloadRequest$profileOwner' => '

The AWS account ID of the profile owner.

', 'SignPayloadResponse$jobOwner' => '

The AWS account ID of the job owner.

', 'SigningJob$jobOwner' => '

The AWS account ID of the job owner.

', 'SigningJob$jobInvoker' => '

The AWS account ID of the job invoker.

', 'StartSigningJobRequest$profileOwner' => '

The AWS account ID of the signing profile owner.

', 'StartSigningJobResponse$jobOwner' => '

The AWS account ID of the signing job owner.

', ], ], 'AddProfilePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddProfilePermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'GetRevocationStatusRequest$profileVersionArn' => '

The version of a signing profile.

', 'GetRevocationStatusRequest$jobArn' => '

The ARN of a signing job.

', 'GetSigningProfileResponse$profileVersionArn' => '

The signing profile ARN, including the profile version.

', 'PutSigningProfileResponse$profileVersionArn' => '

The signing profile ARN, including the profile version.

', 'SigningProfile$profileVersionArn' => '

The ARN of a signing profile, including the profile version.

', ], ], 'BadRequestException' => [ 'base' => '

The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

', 'refs' => [], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'SignPayloadResponse$signature' => '

A cryptographic signature.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Destination$bucketName' => '

Name of the S3 bucket.

', 'S3SignedObject$bucketName' => '

Name of the S3 bucket.

', 'S3Source$bucketName' => '

Name of the S3 bucket.

', ], ], 'CancelSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'Category' => [ 'base' => NULL, 'refs' => [ 'GetSigningPlatformResponse$category' => '

The category type of the target signing platform.

', 'SigningPlatform$category' => '

The category of a signing platform.

', ], ], 'CertificateArn' => [ 'base' => NULL, 'refs' => [ 'SigningMaterial$certificateArn' => '

The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

', ], ], 'CertificateHashes' => [ 'base' => NULL, 'refs' => [ 'GetRevocationStatusRequest$certificateHashes' => '

A list of composite signed hashes that identify certificates.

A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.

The following example shows how to calculate a hash for this parameter using OpenSSL commands:

openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs

openssl sha384 < childCert.tbs -binary > childCertTbsHash

openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs

openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex

cat certificateHash.hex | tr -d \'\\n\'

', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'StartSigningJobRequest$clientRequestToken' => '

String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

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

The resource encountered a conflicting state.

', 'refs' => [], ], 'DescribeSigningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSigningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'Destination' => [ 'base' => '

Points to an S3Destination object that contains information about your S3 bucket.

', 'refs' => [ 'StartSigningJobRequest$destination' => '

The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

', ], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$platformDisplayName' => '

A human-readable name for the signing platform associated with the signing job.

', 'GetSigningPlatformResponse$displayName' => '

The display name of the target signing platform.

', 'GetSigningProfileResponse$platformDisplayName' => '

A human-readable name for the signing platform associated with the signing profile.

', 'SigningJob$platformDisplayName' => '

The name of a signing platform.

', 'SigningProfile$platformDisplayName' => '

The name of the signing platform.

', ], ], 'EncryptionAlgorithm' => [ 'base' => NULL, 'refs' => [ 'EncryptionAlgorithmOptions$defaultValue' => '

The default encryption algorithm that is used by a code-signing job.

', 'EncryptionAlgorithms$member' => NULL, 'SigningConfigurationOverrides$encryptionAlgorithm' => '

A specified override of the default encryption algorithm that is used in a code-signing job.

', ], ], 'EncryptionAlgorithmOptions' => [ 'base' => '

The encryption algorithm options that are available to a code-signing job.

', 'refs' => [ 'SigningConfiguration$encryptionAlgorithmOptions' => '

The encryption algorithm options that are available for a code-signing job.

', ], ], 'EncryptionAlgorithms' => [ 'base' => NULL, 'refs' => [ 'EncryptionAlgorithmOptions$allowedValues' => '

The set of accepted encryption algorithms that are allowed in a code-signing job.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$code' => NULL, 'BadRequestException$code' => NULL, 'ConflictException$code' => NULL, 'InternalServiceErrorException$code' => NULL, 'NotFoundException$code' => NULL, 'ResourceNotFoundException$code' => NULL, 'ServiceLimitExceededException$code' => NULL, 'ThrottlingException$code' => NULL, 'TooManyRequestsException$code' => NULL, 'ValidationException$code' => NULL, ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'BadRequestException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServiceErrorException$message' => NULL, 'NotFoundException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceLimitExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'TooManyRequestsException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'GetRevocationStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRevocationStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningPlatformRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningPlatformResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'HashAlgorithm' => [ 'base' => NULL, 'refs' => [ 'HashAlgorithmOptions$defaultValue' => '

The default hash algorithm that is used in a code-signing job.

', 'HashAlgorithms$member' => NULL, 'SigningConfigurationOverrides$hashAlgorithm' => '

A specified override of the default hash algorithm that is used in a code-signing job.

', ], ], 'HashAlgorithmOptions' => [ 'base' => '

The hash algorithms that are available to a code-signing job.

', 'refs' => [ 'SigningConfiguration$hashAlgorithmOptions' => '

The hash algorithm options that are available for a code-signing job.

', ], ], 'HashAlgorithms' => [ 'base' => NULL, 'refs' => [ 'HashAlgorithmOptions$allowedValues' => '

The set of accepted hash algorithms allowed in a code-signing job.

', ], ], 'ImageFormat' => [ 'base' => NULL, 'refs' => [ 'ImageFormats$member' => NULL, 'SigningImageFormat$defaultFormat' => '

The default format of a signing image.

', 'SigningPlatformOverrides$signingImageFormat' => '

A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached. (A third format value, JSON, is reserved for future use.) With JSONEmbedded, the signing image has the payload embedded in it. With JSONDetached, the payload is not be embedded in the signing image.

', ], ], 'ImageFormats' => [ 'base' => NULL, 'refs' => [ 'SigningImageFormat$supportedFormats' => '

The supported formats of a signing image.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'SignatureValidityPeriod$value' => '

The numerical value of the time unit for signature validity.

', ], ], 'InternalServiceErrorException' => [ 'base' => '

An internal error occurred.

', 'refs' => [], ], 'JobId' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobRequest$jobId' => '

The ID of the signing job on input.

', 'DescribeSigningJobResponse$jobId' => '

The ID of the signing job on output.

', 'RevokeSignatureRequest$jobId' => '

ID of the signing job to be revoked.

', 'SignPayloadResponse$jobId' => '

Unique identifier of the signing job.

', 'SigningJob$jobId' => '

The ID of the signing job.

', 'StartSigningJobResponse$jobId' => '

The ID of your signing job.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'S3SignedObject$key' => '

Key name that uniquely identifies a signed code image in your bucket.

', 'S3Source$key' => '

Key name of the bucket object that contains your unsigned code.

', ], ], 'ListProfilePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningPlatformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningPlatformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListSigningJobsRequest$maxResults' => '

Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.

', 'ListSigningPlatformsRequest$maxResults' => '

The maximum number of results to be returned by this operation.

', 'ListSigningProfilesRequest$maxResults' => '

The maximum number of profiles to be returned.

', ], ], 'MaxSizeInMB' => [ 'base' => NULL, 'refs' => [ 'GetSigningPlatformResponse$maxSizeInMB' => '

The maximum size (in MB) of the payload that can be signed by the target platform.

', 'SigningPlatform$maxSizeInMB' => '

The maximum size (in MB) of code that can be signed by a signing platform.

', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'SignPayloadResponse$metadata' => '

Information including the signing profile ARN and the signing job ID.

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

String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

', 'ListSigningJobsResponse$nextToken' => '

String for specifying the next set of paginated results.

', 'ListSigningProfilesRequest$nextToken' => '

Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

', 'ListSigningProfilesResponse$nextToken' => '

Value for specifying the next set of paginated results to return.

', ], ], 'NotFoundException' => [ 'base' => '

The signing profile was not found.

', 'refs' => [], ], 'Payload' => [ 'base' => NULL, 'refs' => [ 'SignPayloadRequest$payload' => '

Specifies the object digest (hash) to sign.

', ], ], 'Permission' => [ 'base' => '

A cross-account permission for a signing profile.

', 'refs' => [ 'Permissions$member' => NULL, ], ], 'Permissions' => [ 'base' => NULL, 'refs' => [ 'ListProfilePermissionsResponse$permissions' => '

List of permissions associated with the Signing Profile.

', ], ], 'PlatformId' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$platformId' => '

The microcontroller platform to which your signed code image will be distributed.

', 'GetRevocationStatusRequest$platformId' => '

The ID of a signing platform.

', 'GetSigningPlatformRequest$platformId' => '

The ID of the target signing platform.

', 'GetSigningPlatformResponse$platformId' => '

The ID of the target signing platform.

', 'GetSigningProfileResponse$platformId' => '

The ID of the platform that is used by the target signing profile.

', 'ListSigningJobsRequest$platformId' => '

The ID of microcontroller platform that you specified for the distribution of your code image.

', 'ListSigningProfilesRequest$platformId' => '

Filters results to return only signing jobs initiated for a specified signing platform.

', 'PutSigningProfileRequest$platformId' => '

The ID of the signing platform to be created.

', 'SigningJob$platformId' => '

The unique identifier for a signing platform.

', 'SigningProfile$platformId' => '

The ID of a platform that is available for use by a signing profile.

', ], ], 'PolicySizeBytes' => [ 'base' => NULL, 'refs' => [ 'ListProfilePermissionsResponse$policySizeBytes' => '

Total size of the policy associated with the Signing Profile in bytes.

', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'S3Destination$prefix' => '

An S3 prefix that you can use to limit responses to those that begin with the specified prefix.

', ], ], 'ProfileName' => [ 'base' => NULL, 'refs' => [ 'AddProfilePermissionRequest$profileName' => '

The human-readable name of the signing profile.

', 'CancelSigningProfileRequest$profileName' => '

The name of the signing profile to be canceled.

', 'DescribeSigningJobResponse$profileName' => '

The name of the profile that initiated the signing operation.

', 'GetSigningProfileRequest$profileName' => '

The name of the target signing profile.

', 'GetSigningProfileResponse$profileName' => '

The name of the target signing profile.

', 'ListProfilePermissionsRequest$profileName' => '

Name of the signing profile containing the cross-account permissions.

', 'PutSigningProfileRequest$profileName' => '

The name of the signing profile to be created.

', 'RemoveProfilePermissionRequest$profileName' => '

A human-readable name for the signing profile with permissions to be removed.

', 'RevokeSigningProfileRequest$profileName' => '

The name of the signing profile to be revoked.

', 'SignPayloadRequest$profileName' => '

The name of the signing profile.

', 'SigningJob$profileName' => '

The name of the signing profile that created a signing job.

', 'SigningProfile$profileName' => '

The name of the signing profile.

', 'StartSigningJobRequest$profileName' => '

The name of the signing profile.

', ], ], 'ProfileVersion' => [ 'base' => NULL, 'refs' => [ 'AddProfilePermissionRequest$profileVersion' => '

The version of the signing profile.

', 'DescribeSigningJobResponse$profileVersion' => '

The version of the signing profile used to initiate the signing job.

', 'GetSigningProfileResponse$profileVersion' => '

The current version of the signing profile.

', 'Permission$profileVersion' => '

The signing profile version that a permission applies to.

', 'PutSigningProfileResponse$profileVersion' => '

The version of the signing profile being created.

', 'RevokeSigningProfileRequest$profileVersion' => '

The version of the signing profile to be revoked.

', 'SigningJob$profileVersion' => '

The version of the signing profile that created a signing job.

', 'SigningProfile$profileVersion' => '

The version of a signing profile.

', ], ], 'PutSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSigningProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'RemoveProfilePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveProfilePermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RequestedBy' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$requestedBy' => '

The IAM principal that requested the signing job.

', 'ListSigningJobsRequest$requestedBy' => '

The IAM principal that requested the signing job.

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

A specified resource could not be found.

', 'refs' => [], ], 'RevocationReasonString' => [ 'base' => NULL, 'refs' => [ 'RevokeSignatureRequest$reason' => '

The reason for revoking the signing job.

', 'RevokeSigningProfileRequest$reason' => '

The reason for revoking a signing profile.

', ], ], 'RevokeSignatureRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokedEntities' => [ 'base' => NULL, 'refs' => [ 'GetRevocationStatusResponse$revokedEntities' => '

A list of revoked entities (including zero or more of the signing profile ARN, signing job ARN, and certificate hashes) supplied as input to the API.

', ], ], 'S3Destination' => [ 'base' => '

The name and prefix of the Amazon S3 bucket where AWS Signer saves your signed objects.

', 'refs' => [ 'Destination$s3' => '

The S3Destination object.

', ], ], 'S3SignedObject' => [ 'base' => '

The Amazon S3 bucket name and key where Signer saved your signed code image.

', 'refs' => [ 'SignedObject$s3' => '

The S3SignedObject.

', ], ], 'S3Source' => [ 'base' => '

Information about the Amazon S3 bucket where you saved your unsigned code.

', 'refs' => [ 'Source$s3' => '

The S3Source object.

', ], ], 'ServiceLimitExceededException' => [ 'base' => '

The client is making a request that exceeds service limits.

', 'refs' => [], ], 'SignPayloadRequest' => [ 'base' => NULL, 'refs' => [], ], 'SignPayloadResponse' => [ 'base' => NULL, 'refs' => [], ], 'SignatureValidityPeriod' => [ 'base' => '

The validity period for a signing job.

', 'refs' => [ 'GetSigningProfileResponse$signatureValidityPeriod' => NULL, 'PutSigningProfileRequest$signatureValidityPeriod' => '

The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

', 'SigningProfile$signatureValidityPeriod' => '

The validity period for a signing job created using this signing profile.

', ], ], 'SignedObject' => [ 'base' => '

Points to an S3SignedObject object that contains information about your signed code image.

', 'refs' => [ 'DescribeSigningJobResponse$signedObject' => '

Name of the S3 bucket where the signed code image is saved by AWS Signer.

', 'SigningJob$signedObject' => '

A SignedObject structure that contains information about a signing job\'s signed code image.

', ], ], 'SigningConfiguration' => [ 'base' => '

The configuration of a signing operation.

', 'refs' => [ 'GetSigningPlatformResponse$signingConfiguration' => '

A list of configurations applied to the target platform at signing.

', 'SigningPlatform$signingConfiguration' => '

The configuration of a signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.

', ], ], 'SigningConfigurationOverrides' => [ 'base' => '

A signing configuration that overrides the default encryption or hash algorithm of a signing job.

', 'refs' => [ 'SigningPlatformOverrides$signingConfiguration' => '

A signing configuration that overrides the default encryption or hash algorithm of a signing job.

', ], ], 'SigningImageFormat' => [ 'base' => '

The image format of a AWS Signer platform or profile.

', 'refs' => [ 'GetSigningPlatformResponse$signingImageFormat' => '

The format of the target platform\'s signing image.

', 'SigningPlatform$signingImageFormat' => NULL, ], ], 'SigningJob' => [ 'base' => '

Contains information about a signing job.

', 'refs' => [ 'SigningJobs$member' => NULL, ], ], 'SigningJobRevocationRecord' => [ 'base' => '

Revocation information for a signing job.

', 'refs' => [ 'DescribeSigningJobResponse$revocationRecord' => '

A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.

', ], ], 'SigningJobs' => [ 'base' => NULL, 'refs' => [ 'ListSigningJobsResponse$jobs' => '

A list of your signing jobs.

', ], ], 'SigningMaterial' => [ 'base' => '

The ACM certificate that is used to sign your code.

', 'refs' => [ 'DescribeSigningJobResponse$signingMaterial' => '

The Amazon Resource Name (ARN) of your code signing certificate.

', 'GetSigningProfileResponse$signingMaterial' => '

The ARN of the certificate that the target profile uses for signing operations.

', 'PutSigningProfileRequest$signingMaterial' => '

The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

', 'SigningJob$signingMaterial' => '

A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.

', 'SigningProfile$signingMaterial' => '

The ACM certificate that is available for use by a signing profile.

', ], ], 'SigningParameterKey' => [ 'base' => NULL, 'refs' => [ 'SigningParameters$key' => NULL, ], ], 'SigningParameterValue' => [ 'base' => NULL, 'refs' => [ 'SigningParameters$value' => NULL, ], ], 'SigningParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$signingParameters' => '

Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.

', 'GetSigningProfileResponse$signingParameters' => '

A map of key-value pairs for signing operations that is attached to the target signing profile.

', 'PutSigningProfileRequest$signingParameters' => '

Map of key-value pairs for signing. These can include any information that you want to use during signing.

', 'SigningProfile$signingParameters' => '

The parameters that are available for use by a Signer user.

', ], ], 'SigningPlatform' => [ 'base' => '

Contains information about the signing configurations and parameters that are used to perform a code-signing job.

', 'refs' => [ 'SigningPlatforms$member' => NULL, ], ], 'SigningPlatformOverrides' => [ 'base' => '

Any overrides that are applied to the signing configuration of a signing platform.

', 'refs' => [ 'DescribeSigningJobResponse$overrides' => '

A list of any overrides that were applied to the signing operation.

', 'GetSigningProfileResponse$overrides' => '

A list of overrides applied by the target signing profile for signing operations.

', 'PutSigningProfileRequest$overrides' => '

A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

', ], ], 'SigningPlatforms' => [ 'base' => NULL, 'refs' => [ 'ListSigningPlatformsResponse$platforms' => '

A list of all platforms that match the request parameters.

', ], ], 'SigningProfile' => [ 'base' => '

Contains information about the ACM certificates and signing configuration parameters that can be used by a given code signing user.

', 'refs' => [ 'SigningProfiles$member' => NULL, ], ], 'SigningProfileRevocationRecord' => [ 'base' => '

Revocation information for a signing profile.

', 'refs' => [ 'GetSigningProfileResponse$revocationRecord' => NULL, ], ], 'SigningProfileStatus' => [ 'base' => NULL, 'refs' => [ 'GetSigningProfileResponse$status' => '

The status of the target signing profile.

', 'SigningProfile$status' => '

The status of a signing profile.

', 'Statuses$member' => NULL, ], ], 'SigningProfiles' => [ 'base' => NULL, 'refs' => [ 'ListSigningProfilesResponse$profiles' => '

A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

', ], ], 'SigningStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$status' => '

Status of the signing job.

', 'ListSigningJobsRequest$status' => '

A status value with which to filter your results.

', 'SigningJob$status' => '

The status of the signing job.

', ], ], 'Source' => [ 'base' => '

An S3Source object that contains information about the S3 bucket where you saved your unsigned code.

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

The object that contains the name of your S3 bucket or your raw code.

', 'SigningJob$source' => '

A Source that contains information about a signing job\'s code image source.

', 'StartSigningJobRequest$source' => '

The S3 bucket that contains the object to sign or a BLOB that contains your raw code.

', ], ], 'StartSigningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartSigningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$statusReason' => '

String value that contains the status reason.

', ], ], 'Statuses' => [ 'base' => NULL, 'refs' => [ 'ListSigningProfilesRequest$statuses' => '

Filters results to return only signing jobs with statuses in the specified list.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddProfilePermissionRequest$action' => '

The AWS Signer action permitted as part of cross-account permissions.

', 'AddProfilePermissionRequest$principal' => '

The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.

', 'AddProfilePermissionRequest$revisionId' => '

A unique identifier for the current profile revision.

', 'AddProfilePermissionRequest$statementId' => '

A unique identifier for the cross-account permission statement.

', 'AddProfilePermissionResponse$revisionId' => '

A unique identifier for the current profile revision.

', 'CertificateHashes$member' => NULL, 'GetSigningPlatformResponse$partner' => '

A list of partner entities that use the target signing platform.

', 'GetSigningPlatformResponse$target' => '

The validation template that is used by the target signing platform.

', 'GetSigningProfileResponse$statusReason' => '

Reason for the status of the target signing profile.

', 'ListProfilePermissionsRequest$nextToken' => '

String for specifying the next set of paginated results.

', 'ListProfilePermissionsResponse$revisionId' => '

The identifier for the current revision of profile permissions.

', 'ListProfilePermissionsResponse$nextToken' => '

String for specifying the next set of paginated results.

', 'ListSigningPlatformsRequest$category' => '

The category type of a signing platform.

', 'ListSigningPlatformsRequest$partner' => '

Any partner entities connected to a signing platform.

', 'ListSigningPlatformsRequest$target' => '

The validation template that is used by the target signing platform.

', 'ListSigningPlatformsRequest$nextToken' => '

Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

', 'ListSigningPlatformsResponse$nextToken' => '

Value for specifying the next set of paginated results to return.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) for the signing profile.

', 'Metadata$key' => NULL, 'Metadata$value' => NULL, 'Permission$action' => '

An AWS Signer action permitted as part of cross-account permissions.

', 'Permission$principal' => '

The AWS principal that has been granted a cross-account permission.

', 'Permission$statementId' => '

A unique identifier for a cross-account permission statement.

', 'RemoveProfilePermissionRequest$revisionId' => '

An identifier for the current revision of the signing profile permissions.

', 'RemoveProfilePermissionRequest$statementId' => '

A unique identifier for the cross-account permissions statement.

', 'RemoveProfilePermissionResponse$revisionId' => '

An identifier for the current revision of the profile permissions.

', 'RevokedEntities$member' => NULL, 'SignPayloadRequest$payloadFormat' => '

Payload content type. The single valid type is application/vnd.cncf.notary.payload.v1+json.

', 'SigningJobRevocationRecord$reason' => '

A caller-supplied reason for revocation.

', 'SigningJobRevocationRecord$revokedBy' => '

The identity of the revoker.

', 'SigningPlatform$platformId' => '

The ID of a signing platform.

', 'SigningPlatform$displayName' => '

The display name of a signing platform.

', 'SigningPlatform$partner' => '

Any partner entities linked to a signing platform.

', 'SigningPlatform$target' => '

The types of targets that can be signed by a signing platform.

', 'SigningProfileRevocationRecord$revokedBy' => '

The identity of the revoker.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) for the signing profile.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) for the signing profile.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

A list of tag keys to be removed from the signing profile.

', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'GetSigningProfileResponse$tags' => '

A list of tags associated with the signing profile.

', 'ListTagsForResourceResponse$tags' => '

A list of tags associated with the signing profile.

', 'PutSigningProfileRequest$tags' => '

Tags to be associated with the signing profile that is being created.

', 'SigningProfile$tags' => '

A list of tags associated with the signing profile.

', 'TagResourceRequest$tags' => '

One or more tags to be associated with the signing profile.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'ThrottlingException' => [ 'base' => '

The request was denied due to request throttling.

Instead of this error, TooManyRequestsException should be used.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$createdAt' => '

Date and time that the signing job was created.

', 'DescribeSigningJobResponse$completedAt' => '

Date and time that the signing job was completed.

', 'DescribeSigningJobResponse$signatureExpiresAt' => '

Thr expiration timestamp for the signature generated by the signing job.

', 'GetRevocationStatusRequest$signatureTimestamp' => '

The timestamp of the signature that validates the profile or job.

', 'ListSigningJobsRequest$signatureExpiresBefore' => '

Filters results to return only signing jobs with signatures expiring before a specified timestamp.

', 'ListSigningJobsRequest$signatureExpiresAfter' => '

Filters results to return only signing jobs with signatures expiring after a specified timestamp.

', 'RevokeSigningProfileRequest$effectiveTime' => '

A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.

', 'SigningJob$createdAt' => '

The date and time that the signing job was created.

', 'SigningJob$signatureExpiresAt' => '

The time when the signature of a signing job expires.

', 'SigningJobRevocationRecord$revokedAt' => '

The time of revocation.

', 'SigningProfileRevocationRecord$revocationEffectiveFrom' => '

The time when revocation becomes effective.

', 'SigningProfileRevocationRecord$revokedAt' => '

The time when the signing profile was revoked.

', ], ], 'TooManyRequestsException' => [ 'base' => '

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

You signing certificate could not be validated.

', 'refs' => [], ], 'ValidityType' => [ 'base' => NULL, 'refs' => [ 'SignatureValidityPeriod$type' => '

The time unit for signature validity.

', ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'S3Source$version' => '

Version of your source image in your version enabled S3 bucket.

', ], ], 'bool' => [ 'base' => NULL, 'refs' => [ 'GetSigningPlatformResponse$revocationSupported' => '

A flag indicating whether signatures generated for the signing platform can be revoked.

', 'ListSigningJobsRequest$isRevoked' => '

Filters results to return only signing jobs with revoked signatures.

', 'ListSigningProfilesRequest$includeCanceled' => '

Designates whether to include profiles with the status of CANCELED.

', 'SigningJob$isRevoked' => '

Indicates whether the signing job is revoked.

', 'SigningPlatform$revocationSupported' => '

Indicates whether revocation is supported for the platform.

', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'GetSigningProfileResponse$arn' => '

The Amazon Resource Name (ARN) for the signing profile.

', 'PutSigningProfileResponse$arn' => '

The Amazon Resource Name (ARN) of the signing profile created.

', 'SigningProfile$arn' => '

The Amazon Resource Name (ARN) for the signing profile.

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

AWS Signer is a fully managed code-signing service to help you ensure the trust and integrity of your code.

Signer supports the following applications:

With code signing for AWS Lambda, you can sign AWS Lambda deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, and AWS CloudTrail. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3.

With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code-signing certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

With Signer and the Notation CLI from the Notary
 Project, you can sign container images stored in a container registry such as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry alongside the images, where they are available for verifying image authenticity and integrity.

For more information about Signer, see the AWS Signer Developer Guide.

', 'operations' => [ 'AddProfilePermission' => '

Adds cross-account permissions to a signing profile.

', 'CancelSigningProfile' => '

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

', 'DescribeSigningJob' => '

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

', 'GetRevocationStatus' => '

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

', 'GetSigningPlatform' => '

Returns information on a specific signing platform.

', 'GetSigningProfile' => '

Returns information on a specific signing profile.

', 'ListProfilePermissions' => '

Lists the cross-account permissions associated with a signing profile.

', 'ListSigningJobs' => '

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

', 'ListSigningPlatforms' => '

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

', 'ListSigningProfiles' => '

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

', 'ListTagsForResource' => '

Returns a list of the tags associated with a signing profile resource.

', 'PutSigningProfile' => '

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

', 'RemoveProfilePermission' => '

Removes cross-account permissions from a signing profile.

', 'RevokeSignature' => '

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

', 'RevokeSigningProfile' => '

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

', 'SignPayload' => '

Signs a binary payload and returns a signature envelope.

', 'StartSigningJob' => '

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

  • You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

  • Your S3 source bucket must be version enabled.

  • You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

  • You specify the name of the source and destination buckets when calling the StartSigningJob operation.

  • You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn\'t supported.

  • You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

', 'TagResource' => '

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

', 'UntagResource' => '

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

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

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$jobOwner' => '

The AWS account ID of the job owner.

', 'DescribeSigningJobResponse$jobInvoker' => '

The IAM entity that initiated the signing job.

', 'GetSigningProfileRequest$profileOwner' => '

The AWS account ID of the profile owner.

', 'ListSigningJobsRequest$jobInvoker' => '

Filters results to return only signing jobs initiated by a specified IAM entity.

', 'RevokeSignatureRequest$jobOwner' => '

AWS account ID of the job owner.

', 'SignPayloadRequest$profileOwner' => '

The AWS account ID of the profile owner.

', 'SignPayloadResponse$jobOwner' => '

The AWS account ID of the job owner.

', 'SigningJob$jobOwner' => '

The AWS account ID of the job owner.

', 'SigningJob$jobInvoker' => '

The AWS account ID of the job invoker.

', 'StartSigningJobRequest$profileOwner' => '

The AWS account ID of the signing profile owner.

', 'StartSigningJobResponse$jobOwner' => '

The AWS account ID of the signing job owner.

', ], ], 'AddProfilePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddProfilePermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'GetRevocationStatusRequest$profileVersionArn' => '

The version of a signing profile.

', 'GetRevocationStatusRequest$jobArn' => '

The ARN of a signing job.

', 'GetSigningProfileResponse$profileVersionArn' => '

The signing profile ARN, including the profile version.

', 'PutSigningProfileResponse$profileVersionArn' => '

The signing profile ARN, including the profile version.

', 'SigningProfile$profileVersionArn' => '

The ARN of a signing profile, including the profile version.

', ], ], 'BadRequestException' => [ 'base' => '

The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

', 'refs' => [], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'SignPayloadResponse$signature' => '

A cryptographic signature.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Destination$bucketName' => '

Name of the S3 bucket.

', 'S3SignedObject$bucketName' => '

Name of the S3 bucket.

', 'S3Source$bucketName' => '

Name of the S3 bucket.

', ], ], 'CancelSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'Category' => [ 'base' => NULL, 'refs' => [ 'GetSigningPlatformResponse$category' => '

The category type of the target signing platform.

', 'SigningPlatform$category' => '

The category of a signing platform.

', ], ], 'CertificateArn' => [ 'base' => NULL, 'refs' => [ 'SigningMaterial$certificateArn' => '

The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

', ], ], 'CertificateHashes' => [ 'base' => NULL, 'refs' => [ 'GetRevocationStatusRequest$certificateHashes' => '

A list of composite signed hashes that identify certificates.

A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.

The following example shows how to calculate a hash for this parameter using OpenSSL commands:

openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs

openssl sha384 < childCert.tbs -binary > childCertTbsHash

openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs

openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex

cat certificateHash.hex | tr -d \'\\n\'

', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'StartSigningJobRequest$clientRequestToken' => '

String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

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

The resource encountered a conflicting state.

', 'refs' => [], ], 'DescribeSigningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSigningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'Destination' => [ 'base' => '

Points to an S3Destination object that contains information about your S3 bucket.

', 'refs' => [ 'StartSigningJobRequest$destination' => '

The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

', ], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$platformDisplayName' => '

A human-readable name for the signing platform associated with the signing job.

', 'GetSigningPlatformResponse$displayName' => '

The display name of the target signing platform.

', 'GetSigningProfileResponse$platformDisplayName' => '

A human-readable name for the signing platform associated with the signing profile.

', 'SigningJob$platformDisplayName' => '

The name of a signing platform.

', 'SigningProfile$platformDisplayName' => '

The name of the signing platform.

', ], ], 'EncryptionAlgorithm' => [ 'base' => NULL, 'refs' => [ 'EncryptionAlgorithmOptions$defaultValue' => '

The default encryption algorithm that is used by a code-signing job.

', 'EncryptionAlgorithms$member' => NULL, 'SigningConfigurationOverrides$encryptionAlgorithm' => '

A specified override of the default encryption algorithm that is used in a code-signing job.

', ], ], 'EncryptionAlgorithmOptions' => [ 'base' => '

The encryption algorithm options that are available to a code-signing job.

', 'refs' => [ 'SigningConfiguration$encryptionAlgorithmOptions' => '

The encryption algorithm options that are available for a code-signing job.

', ], ], 'EncryptionAlgorithms' => [ 'base' => NULL, 'refs' => [ 'EncryptionAlgorithmOptions$allowedValues' => '

The set of accepted encryption algorithms that are allowed in a code-signing job.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$code' => NULL, 'BadRequestException$code' => NULL, 'ConflictException$code' => NULL, 'InternalServiceErrorException$code' => NULL, 'NotFoundException$code' => NULL, 'ResourceNotFoundException$code' => NULL, 'ServiceLimitExceededException$code' => NULL, 'ThrottlingException$code' => NULL, 'TooManyRequestsException$code' => NULL, 'ValidationException$code' => NULL, ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'BadRequestException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServiceErrorException$message' => NULL, 'NotFoundException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceLimitExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'TooManyRequestsException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'GetRevocationStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRevocationStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningPlatformRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningPlatformResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSigningProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'HashAlgorithm' => [ 'base' => NULL, 'refs' => [ 'HashAlgorithmOptions$defaultValue' => '

The default hash algorithm that is used in a code-signing job.

', 'HashAlgorithms$member' => NULL, 'SigningConfigurationOverrides$hashAlgorithm' => '

A specified override of the default hash algorithm that is used in a code-signing job.

', ], ], 'HashAlgorithmOptions' => [ 'base' => '

The hash algorithms that are available to a code-signing job.

', 'refs' => [ 'SigningConfiguration$hashAlgorithmOptions' => '

The hash algorithm options that are available for a code-signing job.

', ], ], 'HashAlgorithms' => [ 'base' => NULL, 'refs' => [ 'HashAlgorithmOptions$allowedValues' => '

The set of accepted hash algorithms allowed in a code-signing job.

', ], ], 'ImageFormat' => [ 'base' => NULL, 'refs' => [ 'ImageFormats$member' => NULL, 'SigningImageFormat$defaultFormat' => '

The default format of a signing image.

', 'SigningPlatformOverrides$signingImageFormat' => '

A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached. (A third format value, JSON, is reserved for future use.) With JSONEmbedded, the signing image has the payload embedded in it. With JSONDetached, the payload is not be embedded in the signing image.

', ], ], 'ImageFormats' => [ 'base' => NULL, 'refs' => [ 'SigningImageFormat$supportedFormats' => '

The supported formats of a signing image.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'SignatureValidityPeriod$value' => '

The numerical value of the time unit for signature validity.

', ], ], 'InternalServiceErrorException' => [ 'base' => '

An internal error occurred.

', 'refs' => [], ], 'JobId' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobRequest$jobId' => '

The ID of the signing job on input.

', 'DescribeSigningJobResponse$jobId' => '

The ID of the signing job on output.

', 'RevokeSignatureRequest$jobId' => '

ID of the signing job to be revoked.

', 'SignPayloadResponse$jobId' => '

Unique identifier of the signing job.

', 'SigningJob$jobId' => '

The ID of the signing job.

', 'StartSigningJobResponse$jobId' => '

The ID of your signing job.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'S3SignedObject$key' => '

Key name that uniquely identifies a signed code image in your bucket.

', 'S3Source$key' => '

Key name of the bucket object that contains your unsigned code.

', ], ], 'ListProfilePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningPlatformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningPlatformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSigningProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListSigningJobsRequest$maxResults' => '

Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.

', 'ListSigningPlatformsRequest$maxResults' => '

The maximum number of results to be returned by this operation.

', 'ListSigningProfilesRequest$maxResults' => '

The maximum number of profiles to be returned.

', ], ], 'MaxSizeInMB' => [ 'base' => NULL, 'refs' => [ 'GetSigningPlatformResponse$maxSizeInMB' => '

The maximum size (in MB) of the payload that can be signed by the target platform.

', 'SigningPlatform$maxSizeInMB' => '

The maximum size (in MB) of code that can be signed by a signing platform.

', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'SignPayloadResponse$metadata' => '

Information including the signing profile ARN and the signing job ID.

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

String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

', 'ListSigningJobsResponse$nextToken' => '

String for specifying the next set of paginated results.

', 'ListSigningProfilesRequest$nextToken' => '

Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

', 'ListSigningProfilesResponse$nextToken' => '

Value for specifying the next set of paginated results to return.

', ], ], 'NotFoundException' => [ 'base' => '

The signing profile was not found.

', 'refs' => [], ], 'Payload' => [ 'base' => NULL, 'refs' => [ 'SignPayloadRequest$payload' => '

Specifies the object digest (hash) to sign.

', ], ], 'Permission' => [ 'base' => '

A cross-account permission for a signing profile.

', 'refs' => [ 'Permissions$member' => NULL, ], ], 'Permissions' => [ 'base' => NULL, 'refs' => [ 'ListProfilePermissionsResponse$permissions' => '

List of permissions associated with the Signing Profile.

', ], ], 'PlatformId' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$platformId' => '

The microcontroller platform to which your signed code image will be distributed.

', 'GetRevocationStatusRequest$platformId' => '

The ID of a signing platform.

', 'GetSigningPlatformRequest$platformId' => '

The ID of the target signing platform.

', 'GetSigningPlatformResponse$platformId' => '

The ID of the target signing platform.

', 'GetSigningProfileResponse$platformId' => '

The ID of the platform that is used by the target signing profile.

', 'ListSigningJobsRequest$platformId' => '

The ID of microcontroller platform that you specified for the distribution of your code image.

', 'ListSigningProfilesRequest$platformId' => '

Filters results to return only signing jobs initiated for a specified signing platform.

', 'PutSigningProfileRequest$platformId' => '

The ID of the signing platform to be created.

', 'SigningJob$platformId' => '

The unique identifier for a signing platform.

', 'SigningProfile$platformId' => '

The ID of a platform that is available for use by a signing profile.

', ], ], 'PolicySizeBytes' => [ 'base' => NULL, 'refs' => [ 'ListProfilePermissionsResponse$policySizeBytes' => '

Total size of the policy associated with the Signing Profile in bytes.

', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'S3Destination$prefix' => '

An S3 prefix that you can use to limit responses to those that begin with the specified prefix.

', ], ], 'ProfileName' => [ 'base' => NULL, 'refs' => [ 'AddProfilePermissionRequest$profileName' => '

The human-readable name of the signing profile.

', 'CancelSigningProfileRequest$profileName' => '

The name of the signing profile to be canceled.

', 'DescribeSigningJobResponse$profileName' => '

The name of the profile that initiated the signing operation.

', 'GetSigningProfileRequest$profileName' => '

The name of the target signing profile.

', 'GetSigningProfileResponse$profileName' => '

The name of the target signing profile.

', 'ListProfilePermissionsRequest$profileName' => '

Name of the signing profile containing the cross-account permissions.

', 'PutSigningProfileRequest$profileName' => '

The name of the signing profile to be created.

', 'RemoveProfilePermissionRequest$profileName' => '

A human-readable name for the signing profile with permissions to be removed.

', 'RevokeSigningProfileRequest$profileName' => '

The name of the signing profile to be revoked.

', 'SignPayloadRequest$profileName' => '

The name of the signing profile.

', 'SigningJob$profileName' => '

The name of the signing profile that created a signing job.

', 'SigningProfile$profileName' => '

The name of the signing profile.

', 'StartSigningJobRequest$profileName' => '

The name of the signing profile.

', ], ], 'ProfileVersion' => [ 'base' => NULL, 'refs' => [ 'AddProfilePermissionRequest$profileVersion' => '

The version of the signing profile.

', 'DescribeSigningJobResponse$profileVersion' => '

The version of the signing profile used to initiate the signing job.

', 'GetSigningProfileResponse$profileVersion' => '

The current version of the signing profile.

', 'Permission$profileVersion' => '

The signing profile version that a permission applies to.

', 'PutSigningProfileResponse$profileVersion' => '

The version of the signing profile being created.

', 'RevokeSigningProfileRequest$profileVersion' => '

The version of the signing profile to be revoked.

', 'SigningJob$profileVersion' => '

The version of the signing profile that created a signing job.

', 'SigningProfile$profileVersion' => '

The version of a signing profile.

', ], ], 'PutSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutSigningProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'RemoveProfilePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveProfilePermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RequestedBy' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$requestedBy' => '

The IAM principal that requested the signing job.

', 'ListSigningJobsRequest$requestedBy' => '

The IAM principal that requested the signing job.

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

A specified resource could not be found.

', 'refs' => [], ], 'RevocationReasonString' => [ 'base' => NULL, 'refs' => [ 'RevokeSignatureRequest$reason' => '

The reason for revoking the signing job.

', 'RevokeSigningProfileRequest$reason' => '

The reason for revoking a signing profile.

', ], ], 'RevokeSignatureRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeSigningProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokedEntities' => [ 'base' => NULL, 'refs' => [ 'GetRevocationStatusResponse$revokedEntities' => '

A list of revoked entities (including zero or more of the signing profile ARN, signing job ARN, and certificate hashes) supplied as input to the API.

', ], ], 'S3Destination' => [ 'base' => '

The name and prefix of the Amazon S3 bucket where AWS Signer saves your signed objects.

', 'refs' => [ 'Destination$s3' => '

The S3Destination object.

', ], ], 'S3SignedObject' => [ 'base' => '

The Amazon S3 bucket name and key where Signer saved your signed code image.

', 'refs' => [ 'SignedObject$s3' => '

The S3SignedObject.

', ], ], 'S3Source' => [ 'base' => '

Information about the Amazon S3 bucket where you saved your unsigned code.

', 'refs' => [ 'Source$s3' => '

The S3Source object.

', ], ], 'ServiceLimitExceededException' => [ 'base' => '

The client is making a request that exceeds service limits.

', 'refs' => [], ], 'SignPayloadRequest' => [ 'base' => NULL, 'refs' => [], ], 'SignPayloadResponse' => [ 'base' => NULL, 'refs' => [], ], 'SignatureValidityPeriod' => [ 'base' => '

The validity period for a signing job.

', 'refs' => [ 'GetSigningProfileResponse$signatureValidityPeriod' => NULL, 'PutSigningProfileRequest$signatureValidityPeriod' => '

The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

', 'SigningProfile$signatureValidityPeriod' => '

The validity period for a signing job created using this signing profile.

', ], ], 'SignedObject' => [ 'base' => '

Points to an S3SignedObject object that contains information about your signed code image.

', 'refs' => [ 'DescribeSigningJobResponse$signedObject' => '

Name of the S3 bucket where the signed code image is saved by AWS Signer.

', 'SigningJob$signedObject' => '

A SignedObject structure that contains information about a signing job\'s signed code image.

', ], ], 'SigningConfiguration' => [ 'base' => '

The configuration of a signing operation.

', 'refs' => [ 'GetSigningPlatformResponse$signingConfiguration' => '

A list of configurations applied to the target platform at signing.

', 'SigningPlatform$signingConfiguration' => '

The configuration of a signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.

', ], ], 'SigningConfigurationOverrides' => [ 'base' => '

A signing configuration that overrides the default encryption or hash algorithm of a signing job.

', 'refs' => [ 'SigningPlatformOverrides$signingConfiguration' => '

A signing configuration that overrides the default encryption or hash algorithm of a signing job.

', ], ], 'SigningImageFormat' => [ 'base' => '

The image format of a AWS Signer platform or profile.

', 'refs' => [ 'GetSigningPlatformResponse$signingImageFormat' => '

The format of the target platform\'s signing image.

', 'SigningPlatform$signingImageFormat' => NULL, ], ], 'SigningJob' => [ 'base' => '

Contains information about a signing job.

', 'refs' => [ 'SigningJobs$member' => NULL, ], ], 'SigningJobRevocationRecord' => [ 'base' => '

Revocation information for a signing job.

', 'refs' => [ 'DescribeSigningJobResponse$revocationRecord' => '

A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.

', ], ], 'SigningJobs' => [ 'base' => NULL, 'refs' => [ 'ListSigningJobsResponse$jobs' => '

A list of your signing jobs.

', ], ], 'SigningMaterial' => [ 'base' => '

The ACM certificate that is used to sign your code.

', 'refs' => [ 'DescribeSigningJobResponse$signingMaterial' => '

The Amazon Resource Name (ARN) of your code signing certificate.

', 'GetSigningProfileResponse$signingMaterial' => '

The ARN of the certificate that the target profile uses for signing operations.

', 'PutSigningProfileRequest$signingMaterial' => '

The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

', 'SigningJob$signingMaterial' => '

A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.

', 'SigningProfile$signingMaterial' => '

The ACM certificate that is available for use by a signing profile.

', ], ], 'SigningParameterKey' => [ 'base' => NULL, 'refs' => [ 'SigningParameters$key' => NULL, ], ], 'SigningParameterValue' => [ 'base' => NULL, 'refs' => [ 'SigningParameters$value' => NULL, ], ], 'SigningParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$signingParameters' => '

Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.

', 'GetSigningProfileResponse$signingParameters' => '

A map of key-value pairs for signing operations that is attached to the target signing profile.

', 'PutSigningProfileRequest$signingParameters' => '

Map of key-value pairs for signing. These can include any information that you want to use during signing.

', 'SigningProfile$signingParameters' => '

The parameters that are available for use by a Signer user.

', ], ], 'SigningPlatform' => [ 'base' => '

Contains information about the signing configurations and parameters that are used to perform a code-signing job.

', 'refs' => [ 'SigningPlatforms$member' => NULL, ], ], 'SigningPlatformOverrides' => [ 'base' => '

Any overrides that are applied to the signing configuration of a signing platform.

', 'refs' => [ 'DescribeSigningJobResponse$overrides' => '

A list of any overrides that were applied to the signing operation.

', 'GetSigningProfileResponse$overrides' => '

A list of overrides applied by the target signing profile for signing operations.

', 'PutSigningProfileRequest$overrides' => '

A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

', ], ], 'SigningPlatforms' => [ 'base' => NULL, 'refs' => [ 'ListSigningPlatformsResponse$platforms' => '

A list of all platforms that match the request parameters.

', ], ], 'SigningProfile' => [ 'base' => '

Contains information about the ACM certificates and signing configuration parameters that can be used by a given code signing user.

', 'refs' => [ 'SigningProfiles$member' => NULL, ], ], 'SigningProfileRevocationRecord' => [ 'base' => '

Revocation information for a signing profile.

', 'refs' => [ 'GetSigningProfileResponse$revocationRecord' => NULL, ], ], 'SigningProfileStatus' => [ 'base' => NULL, 'refs' => [ 'GetSigningProfileResponse$status' => '

The status of the target signing profile.

', 'SigningProfile$status' => '

The status of a signing profile.

', 'Statuses$member' => NULL, ], ], 'SigningProfiles' => [ 'base' => NULL, 'refs' => [ 'ListSigningProfilesResponse$profiles' => '

A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

', ], ], 'SigningStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$status' => '

Status of the signing job.

', 'ListSigningJobsRequest$status' => '

A status value with which to filter your results.

', 'SigningJob$status' => '

The status of the signing job.

', ], ], 'Source' => [ 'base' => '

An S3Source object that contains information about the S3 bucket where you saved your unsigned code.

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

The object that contains the name of your S3 bucket or your raw code.

', 'SigningJob$source' => '

A Source that contains information about a signing job\'s code image source.

', 'StartSigningJobRequest$source' => '

The S3 bucket that contains the object to sign or a BLOB that contains your raw code.

', ], ], 'StartSigningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartSigningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$statusReason' => '

String value that contains the status reason.

', ], ], 'Statuses' => [ 'base' => NULL, 'refs' => [ 'ListSigningProfilesRequest$statuses' => '

Filters results to return only signing jobs with statuses in the specified list.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddProfilePermissionRequest$action' => '

For cross-account signing. Grant a designated account permission to perform one or more of the following actions. Each action is associated with a specific API\'s operations. For more information about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.

You can designate the following actions to an account.

  • signer:StartSigningJob. This action isn\'t supported for container image workflows. For details, see StartSigningJob.

  • signer:SignPayload. This action isn\'t supported for AWS Lambda workflows. For details, see SignPayload

  • signer:GetSigningProfile. For details, see GetSigningProfile.

  • signer:RevokeSignature. For details, see RevokeSignature.

', 'AddProfilePermissionRequest$principal' => '

The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.

', 'AddProfilePermissionRequest$revisionId' => '

A unique identifier for the current profile revision.

', 'AddProfilePermissionRequest$statementId' => '

A unique identifier for the cross-account permission statement.

', 'AddProfilePermissionResponse$revisionId' => '

A unique identifier for the current profile revision.

', 'CertificateHashes$member' => NULL, 'GetSigningPlatformResponse$partner' => '

A list of partner entities that use the target signing platform.

', 'GetSigningPlatformResponse$target' => '

The validation template that is used by the target signing platform.

', 'GetSigningProfileResponse$statusReason' => '

Reason for the status of the target signing profile.

', 'ListProfilePermissionsRequest$nextToken' => '

String for specifying the next set of paginated results.

', 'ListProfilePermissionsResponse$revisionId' => '

The identifier for the current revision of profile permissions.

', 'ListProfilePermissionsResponse$nextToken' => '

String for specifying the next set of paginated results.

', 'ListSigningPlatformsRequest$category' => '

The category type of a signing platform.

', 'ListSigningPlatformsRequest$partner' => '

Any partner entities connected to a signing platform.

', 'ListSigningPlatformsRequest$target' => '

The validation template that is used by the target signing platform.

', 'ListSigningPlatformsRequest$nextToken' => '

Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

', 'ListSigningPlatformsResponse$nextToken' => '

Value for specifying the next set of paginated results to return.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) for the signing profile.

', 'Metadata$key' => NULL, 'Metadata$value' => NULL, 'Permission$action' => '

An AWS Signer action permitted as part of cross-account permissions.

', 'Permission$principal' => '

The AWS principal that has been granted a cross-account permission.

', 'Permission$statementId' => '

A unique identifier for a cross-account permission statement.

', 'RemoveProfilePermissionRequest$revisionId' => '

An identifier for the current revision of the signing profile permissions.

', 'RemoveProfilePermissionRequest$statementId' => '

A unique identifier for the cross-account permissions statement.

', 'RemoveProfilePermissionResponse$revisionId' => '

An identifier for the current revision of the profile permissions.

', 'RevokedEntities$member' => NULL, 'SignPayloadRequest$payloadFormat' => '

Payload content type. The single valid type is application/vnd.cncf.notary.payload.v1+json.

', 'SigningJobRevocationRecord$reason' => '

A caller-supplied reason for revocation.

', 'SigningJobRevocationRecord$revokedBy' => '

The identity of the revoker.

', 'SigningPlatform$platformId' => '

The ID of a signing platform.

', 'SigningPlatform$displayName' => '

The display name of a signing platform.

', 'SigningPlatform$partner' => '

Any partner entities linked to a signing platform.

', 'SigningPlatform$target' => '

The types of targets that can be signed by a signing platform.

', 'SigningProfileRevocationRecord$revokedBy' => '

The identity of the revoker.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) for the signing profile.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) for the signing profile.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

A list of tag keys to be removed from the signing profile.

', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'GetSigningProfileResponse$tags' => '

A list of tags associated with the signing profile.

', 'ListTagsForResourceResponse$tags' => '

A list of tags associated with the signing profile.

', 'PutSigningProfileRequest$tags' => '

Tags to be associated with the signing profile that is being created.

', 'SigningProfile$tags' => '

A list of tags associated with the signing profile.

', 'TagResourceRequest$tags' => '

One or more tags to be associated with the signing profile.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'ThrottlingException' => [ 'base' => '

The request was denied due to request throttling.

Instead of this error, TooManyRequestsException should be used.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DescribeSigningJobResponse$createdAt' => '

Date and time that the signing job was created.

', 'DescribeSigningJobResponse$completedAt' => '

Date and time that the signing job was completed.

', 'DescribeSigningJobResponse$signatureExpiresAt' => '

Thr expiration timestamp for the signature generated by the signing job.

', 'GetRevocationStatusRequest$signatureTimestamp' => '

The timestamp of the signature that validates the profile or job.

', 'ListSigningJobsRequest$signatureExpiresBefore' => '

Filters results to return only signing jobs with signatures expiring before a specified timestamp.

', 'ListSigningJobsRequest$signatureExpiresAfter' => '

Filters results to return only signing jobs with signatures expiring after a specified timestamp.

', 'RevokeSigningProfileRequest$effectiveTime' => '

A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.

', 'SigningJob$createdAt' => '

The date and time that the signing job was created.

', 'SigningJob$signatureExpiresAt' => '

The time when the signature of a signing job expires.

', 'SigningJobRevocationRecord$revokedAt' => '

The time of revocation.

', 'SigningProfileRevocationRecord$revocationEffectiveFrom' => '

The time when revocation becomes effective.

', 'SigningProfileRevocationRecord$revokedAt' => '

The time when the signing profile was revoked.

', ], ], 'TooManyRequestsException' => [ 'base' => '

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

You signing certificate could not be validated.

', 'refs' => [], ], 'ValidityType' => [ 'base' => NULL, 'refs' => [ 'SignatureValidityPeriod$type' => '

The time unit for signature validity.

', ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'S3Source$version' => '

Version of your source image in your version enabled S3 bucket.

', ], ], 'bool' => [ 'base' => NULL, 'refs' => [ 'GetSigningPlatformResponse$revocationSupported' => '

A flag indicating whether signatures generated for the signing platform can be revoked.

', 'ListSigningJobsRequest$isRevoked' => '

Filters results to return only signing jobs with revoked signatures.

', 'ListSigningProfilesRequest$includeCanceled' => '

Designates whether to include profiles with the status of CANCELED.

', 'SigningJob$isRevoked' => '

Indicates whether the signing job is revoked.

', 'SigningPlatform$revocationSupported' => '

Indicates whether revocation is supported for the platform.

', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'GetSigningProfileResponse$arn' => '

The Amazon Resource Name (ARN) for the signing profile.

', 'PutSigningProfileResponse$arn' => '

The Amazon Resource Name (ARN) of the signing profile created.

', 'SigningProfile$arn' => '

The Amazon Resource Name (ARN) for the signing profile.

', ], ], ],];